PHP Класс ApiComponent, Platform-API-plugin

Автор: :dayunlong ([email protected])
Наследование: extends CComponent
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
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

Защищенные методы

Метод Описание
configureApiAccess ( ) : void Ensures that the current request is validated for Authentication
configureRequestDetectors ( ) : void Configure detectors for API requests
setup ( Controller $controller ) : void Setup method

Описание методов

allowJsonp() публичный Метод

Allow jsonp
public allowJsonp ( $value = true ) : void
Результат void

allowPublic() публичный Метод

Allow public access to an action
public allowPublic ( string $action ) : void
$action string
Результат void

beforeRedirect() публичный Метод

beforeRedirection
public beforeRedirect ( Controller $controller, mixed $url, integer $status = null, boolean $exit = true ) : void
$controller Controller
$url mixed
$status integer
$exit boolean
Результат void

beforeRender() публичный Метод

beforeRender callback
public beforeRender ( Controller $controller ) : void
$controller Controller
Результат void

configureApiAccess() защищенный Метод

Ensures that the current request is validated for Authentication
protected configureApiAccess ( ) : void
Результат void

configureRequestDetectors() защищенный Метод

Add detectors for ->is('api') and ->is('json') on CakeRequest
protected configureRequestDetectors ( ) : void
Результат void

denyPublic() публичный Метод

Deny public access to an action
public denyPublic ( string $action ) : boolean
$action string
Результат boolean

hasError() публичный Метод

Is the current controller an Error controller?
public hasError ( ) : boolean
Результат boolean

initialize() публичный Метод

initialize callback
public initialize ( Controller $controller ) : void
$controller Controller
Результат void

setup() защищенный Метод

Setup method
protected setup ( Controller $controller ) : void
$controller Controller
Результат void

startup() публичный Метод

startup method
public startup ( Controller $controller ) : void
$controller Controller
Результат void

Описание свойств

$allowJsonp защищенное свойство

protected bool $allowJsonp
Результат boolean

$controller защищенное свойство

Reference to the current controller
protected Controller $controller
Результат Controller

$publicActions защищенное свойство

List of actions that can be accessed without authentication
protected array $publicActions
Результат array

$request защищенное свойство

Reference to the current request
protected CakeRequest $request
Результат CakeRequest

$response защищенное свойство

Reference to the current response
protected CakeResponse $response
Результат CakeResponse