CRM_Utils_API_AbstractFieldCoder
in package
implements
API_Wrapper
AbstractYes
Class CRM_Utils_API_AbstractFieldCoder.
Table of Contents
Interfaces
- API_Wrapper
- Interface API_Wrapper
Methods
- decodeOutput() : mixed
- Decode output.
- encodeInput() : mixed
- Going to filter the submitted values.
- fromApiInput() : array<string|int, mixed>
- Interface for interpreting api input.
- getSkipFields() : array<string|int, string>
- Get skipped fields.
- isSkippedField() : bool
- Is field skipped.
- toApiOutput() : array<string|int, mixed>
- Interface for interpreting api output.
- isApiControlField() : bool
Methods
decodeOutput()
Decode output.
public
abstract decodeOutput(string &$values) : mixed
Parameters
- $values : string
encodeInput()
Going to filter the submitted values.
public
abstract encodeInput(array<string|int, mixed>|string &$values) : mixed
Parameters
- $values : array<string|int, mixed>|string
-
the field value from the API
fromApiInput()
Interface for interpreting api input.
public
fromApiInput(mixed $apiRequest) : array<string|int, mixed>
Parameters
- $apiRequest : mixed
Tags
Return values
array<string|int, mixed> —modified $apiRequest
getSkipFields()
Get skipped fields.
public
getSkipFields() : array<string|int, string>
Return values
array<string|int, string> —List of field names
isSkippedField()
Is field skipped.
public
isSkippedField(string $fldName) : bool
Parameters
- $fldName : string
Return values
bool —TRUE if encoding should be skipped for this field
toApiOutput()
Interface for interpreting api output.
public
toApiOutput(mixed $apiRequest, mixed $result) : array<string|int, mixed>
Parameters
- $apiRequest : mixed
- $result : mixed
Tags
Return values
array<string|int, mixed> —modified $result
isApiControlField()
protected
isApiControlField(mixed $key) : bool
Parameters
- $key : mixed