CRM_Utils_API_NullOutputCoder

class CRM_Utils_API_NullOutputCoder extends CRM_Utils_API_AbstractFieldCoder

Class CRM_Utils_API_NullOutputCoder

Methods

array
getSkipFields()

Get skipped fields.

from CRM_Utils_API_AbstractFieldCoder
bool
isSkippedField(string $fldName)

Is field skipped.

from CRM_Utils_API_AbstractFieldCoder
encodeInput(array|string $values)

Going to filter the submitted values across XSS vulnerability.

mixed
decodeOutput(string $values, bool $castToString = FALSE)

Decode output.

array
fromApiInput(array $apiRequest)

No description

from CRM_Utils_API_AbstractFieldCoder
array
toApiOutput(array $apiRequest, array $result)

To api output.

bool
isApiControlField($key)

No description

from CRM_Utils_API_AbstractFieldCoder
static CRM_Utils_API_NullOutputCoder
singleton()

No description

Details

in CRM_Utils_API_AbstractFieldCoder at line 49
array getSkipFields()

Get skipped fields.

Return Value

array List of field names

in CRM_Utils_API_AbstractFieldCoder 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 63
encodeInput(array|string $values)

Going to filter the submitted values across XSS vulnerability.

Parameters

array|string $values the field value from the API

at line 72
mixed decodeOutput(string $values, bool $castToString = FALSE)

Decode output.

Parameters

string $values
bool $castToString

Return Value

mixed

in CRM_Utils_API_AbstractFieldCoder at line 109
array fromApiInput(array $apiRequest)

Parameters

array $apiRequest

Return Value

array modified $apiRequest

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

To api output.

Parameters

array $apiRequest
array $result

Return Value

array modified $result

in CRM_Utils_API_AbstractFieldCoder at line 154
protected bool isApiControlField($key)

Parameters

$key

Return Value

bool

at line 51
static CRM_Utils_API_NullOutputCoder singleton()

Return Value

CRM_Utils_API_NullOutputCoder