Bitrix API

HttpMethod extends Base

FinalYes

Table of Contents

Constants

ERROR_INVALID_HTTP_METHOD  = 'invalid_http_method'
METHOD_CONNECT  = 'CONNECT'
METHOD_DELETE  = 'DELETE'
METHOD_GET  = 'GET'
METHOD_OPTIONS  = 'OPTIONS'
METHOD_PATCH  = 'PATCH'
METHOD_POST  = 'POST'
METHOD_PUT  = 'PUT'
METHOD_TRACE  = 'TRACE'

Methods

__construct()  : mixed
HttpMethodFilter constructor.
bindAction()  : mixed
className()  : string
Returns the fully qualified name of this class.
containsPostMethod()  : bool
getAction()  : Action
getErrorByCode()  : Error
Getting once error with the necessary code.
getErrors()  : array<string|int, Error>
Getting array of errors.
listAllowedScopes()  : array<string|int, mixed>
List allowed values of scopes where the filter should work.
onAfterAction()  : mixed
onBeforeAction()  : mixed

Constants

ERROR_INVALID_HTTP_METHOD

public mixed ERROR_INVALID_HTTP_METHOD = 'invalid_http_method'

METHOD_CONNECT

public mixed METHOD_CONNECT = 'CONNECT'

METHOD_DELETE

public mixed METHOD_DELETE = 'DELETE'

METHOD_OPTIONS

public mixed METHOD_OPTIONS = 'OPTIONS'

METHOD_PATCH

public mixed METHOD_PATCH = 'PATCH'

METHOD_TRACE

public mixed METHOD_TRACE = 'TRACE'

Methods

__construct()

HttpMethodFilter constructor.

public __construct([array<string|int, mixed> $allowedMethods = array(self::METHOD_GET) ]) : mixed
Parameters
$allowedMethods : array<string|int, mixed> = array(self::METHOD_GET)

bindAction()

public final bindAction(Action $action) : mixed
Parameters
$action : Action

className()

Returns the fully qualified name of this class.

public final static className() : string
Return values
string

containsPostMethod()

public containsPostMethod() : bool
Return values
bool

getErrorByCode()

Getting once error with the necessary code.

public final getErrorByCode(string $code) : Error
Parameters
$code : string

Code of error.

Return values
Error

getErrors()

Getting array of errors.

public final getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

listAllowedScopes()

List allowed values of scopes where the filter should work.

public listAllowedScopes() : array<string|int, mixed>
Return values
array<string|int, mixed>

onAfterAction()

public onAfterAction(Event $event) : mixed
Parameters
$event : Event

onBeforeAction()

public onBeforeAction(Event $event) : mixed
Parameters
$event : Event

        
On this page

Search results