PHP Class eZ\Publish\Core\REST\Common\Output\Generator\Xml\FieldTypeHashGenerator

Show file Open project: ezsystems/ezpublish-kernel Class Usage Examples

Public Methods

Method Description
generateHashValue ( XMLWriter $writer, string $hashElementName, mixed $hashValue ) Generates the field type value $hashValue into the $writer creating an element with $hashElementName as its parent.

Protected Methods

Method Description
generateArrayValue ( XmlWriter $writer, array $value, string | null $key, string $elementName = 'value' ) Generates an array value from $value.
generateBooleanValue ( XmlWriter $writer, boolean $value, string | null $key = null, string $elementName = 'value' ) Generates a boolean value.
generateFloatValue ( XmlWriter $writer, float $value, string | null $key = null, string $elementName = 'value' ) Generates a float value.
generateHashArray ( XmlWriter $writer, array $value, string | null $key = null, string $elementName = 'value' ) Generates $value as a hash of value items.
generateIntegerValue ( XmlWriter $writer, integer $value, string | null $key = null, string $elementName = 'value' ) Generates a integer value.
generateKeyAttribute ( XmlWriter $writer, string | null $key = null ) Generates a key attribute with $key as the value, if $key is not null.
generateListArray ( XmlWriter $writer, array $value, string | null $key = null, string $elementName = 'value' ) Generates $value as a list of value items.
generateNullValue ( XmlWriter $writer, string | null $key = null, string $elementName = 'value' ) Generates a null value.
generateStringValue ( XmlWriter $writer, string $value, string | null $key = null, string $elementName = 'value' ) Generates a string value.
generateValue ( XmlWriter $writer, mixed $value, string | null $key = null, string $elementName = 'value' ) Generates $value into a serialized representation.
isNumericArray ( array $value ) : boolean Checks if the given $value is a purely numeric array.

Method Details

generateArrayValue() protected method

Generates an array value from $value.
protected generateArrayValue ( XmlWriter $writer, array $value, string | null $key, string $elementName = 'value' )
$writer XmlWriter
$value array
$key string | null
$elementName string

generateBooleanValue() protected method

Generates a boolean value.
protected generateBooleanValue ( XmlWriter $writer, boolean $value, string | null $key = null, string $elementName = 'value' )
$writer XmlWriter
$value boolean
$key string | null
$elementName string

generateFloatValue() protected method

Generates a float value.
protected generateFloatValue ( XmlWriter $writer, float $value, string | null $key = null, string $elementName = 'value' )
$writer XmlWriter
$value float
$key string | null
$elementName string

generateHashArray() protected method

Generates $value as a hash of value items.
protected generateHashArray ( XmlWriter $writer, array $value, string | null $key = null, string $elementName = 'value' )
$writer XmlWriter
$value array
$key string | null
$elementName string

generateHashValue() public method

Generates the field type value $hashValue into the $writer creating an element with $hashElementName as its parent.
public generateHashValue ( XMLWriter $writer, string $hashElementName, mixed $hashValue )
$writer XMLWriter
$hashElementName string
$hashValue mixed

generateIntegerValue() protected method

Generates a integer value.
protected generateIntegerValue ( XmlWriter $writer, integer $value, string | null $key = null, string $elementName = 'value' )
$writer XmlWriter
$value integer
$key string | null
$elementName string

generateKeyAttribute() protected method

Generates a key attribute with $key as the value, if $key is not null.
protected generateKeyAttribute ( XmlWriter $writer, string | null $key = null )
$writer XmlWriter
$key string | null

generateListArray() protected method

Generates $value as a list of value items.
protected generateListArray ( XmlWriter $writer, array $value, string | null $key = null, string $elementName = 'value' )
$writer XmlWriter
$value array
$key string | null
$elementName string

generateNullValue() protected method

Generates a null value.
protected generateNullValue ( XmlWriter $writer, string | null $key = null, string $elementName = 'value' )
$writer XmlWriter
$key string | null
$elementName string

generateStringValue() protected method

Generates a string value.
protected generateStringValue ( XmlWriter $writer, string $value, string | null $key = null, string $elementName = 'value' )
$writer XmlWriter
$value string
$key string | null
$elementName string

generateValue() protected method

Generates $value into a serialized representation.
protected generateValue ( XmlWriter $writer, mixed $value, string | null $key = null, string $elementName = 'value' )
$writer XmlWriter
$value mixed
$key string | null
$elementName string

isNumericArray() protected method

Checks if the given $value is a purely numeric array.
protected isNumericArray ( array $value ) : boolean
$value array
return boolean