API Documentation for: 1.1.1
Show:

GatewayControl Class

Namespace: Canteen\Server

Gateway access control point. These are created internally by the Gateway class and shouldn't be created directly.

Constructor

GatewayControl

(
  • uri
  • call
  • privilege
)

Parameters:

  • uri String

    The URI path

  • call Callable

    The callback method

  • privilege Int

    The name of the privilege

Item Index

Methods

Properties

Methods

getArguments

(
  • request
)
Array

Get the additional arguments from the URI

Parameters:

  • request String

    The URI being requested from the gateway

Returns:

Array:

The arguments from the request

match

(
  • request
)
Boolean

Check if the request being made belongs to this request

Parameters:

  • request String

    The URI being requested from the gateway

Returns:

Boolean:

If the request is matched

Properties

call

Callable

The callable method when gateway access this

privilege

Int

The privilege needed to call this method

required

Int

The required number of parameters for this call

total

Int

The total possible number of parameters for this call

uri

String

The local path on the gateway to access this callable