RequestTrait
Trait RequestTrait
Table of Contents
Properties
- $apiRequest : AbstractAction|array<string|int, mixed>
Methods
- getActionName() : string
- getApiRequest() : AbstractAction|array<string|int, mixed>
- getApiRequestSig() : string
- Create a brief string identifying the entity/action. Useful for pithy matching/switching.
- getEntityName() : string
- setApiRequest() : static
Properties
$apiRequest
protected
AbstractAction|array<string|int, mixed>
$apiRequest
The full description of the API request.
Tags
Methods
getActionName()
public
getActionName() : string
Return values
string —Ex: 'create', 'update'
getApiRequest()
public
getApiRequest() : AbstractAction|array<string|int, mixed>
Return values
AbstractAction|array<string|int, mixed>getApiRequestSig()
Create a brief string identifying the entity/action. Useful for pithy matching/switching.
public
getApiRequestSig() : string
Ex: if ($e->getApiRequestSig() === '3.contact.get') { ... }
Return values
string —Ex: '3.contact.get'
getEntityName()
public
getEntityName() : string
Return values
string —Ex: 'Contact', 'Activity'
setApiRequest()
protected
setApiRequest(AbstractAction|array<string|int, mixed> $apiRequest) : static
Parameters
- $apiRequest : AbstractAction|array<string|int, mixed>
-
The full description of the API request.