PHP Класс OEModule\PASAPI\controllers\V1Controller

Наследование: extends CController
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$PARTIAL_RECORD_HEADER
$UPDATE_ONLY_HEADER

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

Свойство Тип Описание
$output_format output format defaults to xml
$resources
$supported_formats
$version

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

Метод Описание
actionDelete ( $resource_type, $id )
actionUpdate ( $resource_type, $id )
beforeAction ( CAction $action ) : boolean
createAction ( string $actionID ) : CAction | CInlineAction This overrides the default behaviour for supported resources by pushing the resource into the GET parameter and updating the actionID.
expectedParametersForAction ( $action ) Simple wrapper to encapsulate the arguments required for any of the API actions.
getPartialRecord ( ) : boolean Whether the request is a partial record which only sets the fields that are provided on the given record.
getResourceModel ( $resource_type )
getUpdateOnly ( ) : boolean Whether the request is an "updateOnly" request.
invalidActionParams ( CAction $action )

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

Метод Описание
getContentType ( ) : string
sendErrorResponse ( $status, $messages = [] )
sendResponse ( $status = 200, $body = '' )
sendSuccessResponse ( $status, $response )

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

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

public actionDelete ( $resource_type, $id )

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

public actionUpdate ( $resource_type, $id )
$resource_type
$id

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

public beforeAction ( CAction $action ) : boolean
$action CAction
Результат boolean

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

This is necessary because there's no way of pushing the appropriate pattern to the top of the URLManager config, so this captures calls where the id doesn't contain non-numerics.
public createAction ( string $actionID ) : CAction | CInlineAction
$actionID string
Результат CAction | CInlineAction

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

Simple wrapper to encapsulate the arguments required for any of the API actions.
public expectedParametersForAction ( $action )

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

protected getContentType ( ) : string
Результат string

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

Whether the request is a partial record which only sets the fields that are provided on the given record.
public getPartialRecord ( ) : boolean
Результат boolean

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

public getResourceModel ( $resource_type )

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

Whether the request is an "updateOnly" request.
public getUpdateOnly ( ) : boolean
Результат boolean

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

public invalidActionParams ( CAction $action )
$action CAction

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

protected sendErrorResponse ( $status, $messages = [] )

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

protected sendResponse ( $status = 200, $body = '' )

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

protected sendSuccessResponse ( $status, $response )

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

$PARTIAL_RECORD_HEADER публичное статическое свойство

public static $PARTIAL_RECORD_HEADER

$UPDATE_ONLY_HEADER публичное статическое свойство

public static $UPDATE_ONLY_HEADER

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

output format defaults to xml
protected $output_format

$resources защищенное статическое свойство

protected static $resources

$supported_formats защищенное статическое свойство

protected static $supported_formats

$version защищенное статическое свойство

protected static $version