CRM_Utils_API_NullOutputCoder
extends CRM_Utils_API_AbstractFieldCoder
in package
Class CRM_Utils_API_NullOutputCoder
Table of Contents
Properties
Methods
- decodeOutput() : mixed
- Decode output.
- encodeInput() : mixed
- Going to filter the submitted values across XSS vulnerability.
- fromApiInput() : array<string|int, mixed>
- Interface for interpreting api input.
- getSkipFields() : array<string|int, string>
- Get skipped fields.
- isSkippedField() : bool
- Is field skipped.
- singleton() : CRM_Utils_API_NullOutputCoder
- toApiOutput() : array<string|int, mixed>
- To api output.
- isApiControlField() : bool
Properties
$_singleton
private
static CRM_Utils_API_NullOutputCoder
$_singleton
= \NULL
Methods
decodeOutput()
Decode output.
public
decodeOutput(array<string|int, mixed> &$values[, bool $castToString = FALSE ]) : mixed
Parameters
- $values : array<string|int, mixed>
- $castToString : bool = FALSE
encodeInput()
Going to filter the submitted values across XSS vulnerability.
public
encodeInput(array<string|int, mixed>|string &$values) : mixed
Parameters
- $values : array<string|int, mixed>|string
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
singleton()
public
static singleton() : CRM_Utils_API_NullOutputCoder
Return values
CRM_Utils_API_NullOutputCodertoApiOutput()
To api output.
public
toApiOutput(array<string|int, mixed> $apiRequest, array<string|int, mixed> $result) : array<string|int, mixed>
Parameters
- $apiRequest : array<string|int, mixed>
- $result : array<string|int, mixed>
Return values
array<string|int, mixed>isApiControlField()
protected
isApiControlField(mixed $key) : bool
Parameters
- $key : mixed