CRM_Utils_API_AbstractFieldCoder

abstract class CRM_Utils_API_AbstractFieldCoder implements API_Wrapper

Class CRM_Utils_API_AbstractFieldCoder.

Methods

array
getSkipFields()

Get skipped fields.

bool
isSkippedField(string $fldName)

Is field skipped.

encodeInput(array|string $values)

Going to filter the submitted values.

mixed
decodeOutput(string $values)

Decode output.

array
fromApiInput(array $apiRequest)

No description

array
toApiOutput(array $apiRequest, array $result)

No description

bool
isApiControlField($key)

No description

Details

at line 49
array getSkipFields()

Get skipped fields.

Return Value

array List of field names

at line 61
bool isSkippedField(string $fldName)

Is field skipped.

Parameters

string $fldName

Return Value

bool TRUE if encoding should be skipped for this field

at line 95
abstract encodeInput(array|string $values)

Going to filter the submitted values.

Parameters

array|string $values the field value from the API

at line 104
abstract mixed decodeOutput(string $values)

Decode output.

Parameters

string $values

Return Value

mixed

at line 109
array fromApiInput(array $apiRequest)

Parameters

array $apiRequest

Return Value

array modified $apiRequest

at line 134
array toApiOutput(array $apiRequest, array $result)

Parameters

array $apiRequest
array $result

Return Value

array modified $result

at line 154
protected bool isApiControlField($key)

Parameters

$key

Return Value

bool