PHP Class ApiComponent, Platform-API-plugin

Author: :dayunlong ([email protected])
Inheritance: extends CComponent
Afficher le fichier Open project: nodesagency/Platform-API-plugin Class Usage Examples

Protected Properties

Свойство Type Description
$allowJsonp boolean
$controller Controller Reference to the current controller
$publicActions array List of actions that can be accessed without authentication
$request CakeRequest Reference to the current request
$response CakeResponse Reference to the current response

Méthodes publiques

Méthode Description
allowJsonp ( $value = true ) : void Allow jsonp
allowPublic ( string $action ) : void Allow public access to an action
beforeRedirect ( Controller $controller, mixed $url, integer $status = null, boolean $exit = true ) : void beforeRedirection
beforeRender ( Controller $controller ) : void beforeRender callback
denyPublic ( string $action ) : boolean Deny public access to an action
hasError ( ) : boolean Is the current controller an Error controller?
initialize ( Controller $controller ) : void initialize callback
startup ( Controller $controller ) : void startup method

Méthodes protégées

Méthode Description
configureApiAccess ( ) : void Ensures that the current request is validated for Authentication
configureRequestDetectors ( ) : void Configure detectors for API requests
setup ( Controller $controller ) : void Setup method

Method Details

allowJsonp() public méthode

Allow jsonp
public allowJsonp ( $value = true ) : void
Résultat void

allowPublic() public méthode

Allow public access to an action
public allowPublic ( string $action ) : void
$action string
Résultat void

beforeRedirect() public méthode

beforeRedirection
public beforeRedirect ( Controller $controller, mixed $url, integer $status = null, boolean $exit = true ) : void
$controller Controller
$url mixed
$status integer
$exit boolean
Résultat void

beforeRender() public méthode

beforeRender callback
public beforeRender ( Controller $controller ) : void
$controller Controller
Résultat void

configureApiAccess() protected méthode

Ensures that the current request is validated for Authentication
protected configureApiAccess ( ) : void
Résultat void

configureRequestDetectors() protected méthode

Add detectors for ->is('api') and ->is('json') on CakeRequest
protected configureRequestDetectors ( ) : void
Résultat void

denyPublic() public méthode

Deny public access to an action
public denyPublic ( string $action ) : boolean
$action string
Résultat boolean

hasError() public méthode

Is the current controller an Error controller?
public hasError ( ) : boolean
Résultat boolean

initialize() public méthode

initialize callback
public initialize ( Controller $controller ) : void
$controller Controller
Résultat void

setup() protected méthode

Setup method
protected setup ( Controller $controller ) : void
$controller Controller
Résultat void

startup() public méthode

startup method
public startup ( Controller $controller ) : void
$controller Controller
Résultat void

Property Details

$allowJsonp protected_oe property

protected bool $allowJsonp
Résultat boolean

$controller protected_oe property

Reference to the current controller
protected Controller $controller
Résultat Controller

$publicActions protected_oe property

List of actions that can be accessed without authentication
protected array $publicActions
Résultat array

$request protected_oe property

Reference to the current request
protected CakeRequest $request
Résultat CakeRequest

$response protected_oe property

Reference to the current response
protected CakeResponse $response
Résultat CakeResponse