PHP Class eZ\Publish\Core\REST\Common\FieldTypeProcessor

Show file Open project: ezsystems/ezpublish-kernel

Public Methods

Method Description
postProcessFieldSettingsHash ( mixed $outgoingSettingsHash ) : mixed Perform manipulations on a received $outgoingSettingsHash.
postProcessValidatorConfigurationHash ( mixed $outgoingValidatorConfigurationHash ) : mixed Perform manipulations on a received $outgoingValidatorConfigurationHash.
postProcessValueHash ( mixed $outgoingValueHash ) : mixed Perform manipulations on an a generated $outgoingValueHash.
preProcessFieldSettingsHash ( mixed $incomingSettingsHash ) : mixed Perform manipulations on a received $incomingSettingsHash.
preProcessValidatorConfigurationHash ( mixed $incomingValidatorConfigurationHash ) : mixed Perform manipulations on a received $incomingValidatorConfigurationHash.
preProcessValueHash ( mixed $incomingValueHash ) : mixed Perform manipulations on a received $incomingValueHash.

Method Details

postProcessFieldSettingsHash() public method

This method is called by the REST output visitors to allow a field type to post process the given $outgoingSettingsHash, which was previously generated using {@link eZ\Publish\SPI\FieldType\FieldType::fieldSettingsToHash()}, before it is sent to the client. The return value of this method replaces $outgoingSettingsHash and must obey to the same rules as the original $outgoingSettingsHash.
See also: eZ\Publish\Core\REST\Common\Output\FieldTypeSerializer
public postProcessFieldSettingsHash ( mixed $outgoingSettingsHash ) : mixed
$outgoingSettingsHash mixed
return mixed Post processed hash

postProcessValidatorConfigurationHash() public method

This method is called by the REST output visitors to allow a field type to post process the given $outgoingValidatorConfigurationHash, which was previously generated using {@link eZ\Publish\SPI\FieldType\FieldType::validatorConfigurationToHash()}, before it is sent to the client. The return value of this method replaces $outgoingValidatorConfigurationHash and must obey to the same rules as the original $outgoingValidatorConfigurationHash.
See also: eZ\Publish\Core\REST\Common\Output\FieldTypeSerializer
public postProcessValidatorConfigurationHash ( mixed $outgoingValidatorConfigurationHash ) : mixed
$outgoingValidatorConfigurationHash mixed
return mixed Post processed hash

postProcessValueHash() public method

This method is called by the REST output visitors to allow a field type to post process the given $outgoingValueHash, which was previously generated using {@link eZ\Publish\SPI\FieldType\FieldType::toHash()}, before it is sent to the client. The return value of this method replaces $outgoingValueHash and must obey to the same rules as the original $outgoingValueHash.
See also: eZ\Publish\Core\REST\Common\Output\FieldTypeSerializer
public postProcessValueHash ( mixed $outgoingValueHash ) : mixed
$outgoingValueHash mixed
return mixed Post processed hash

preProcessFieldSettingsHash() public method

This method is called by the REST input parsers to allow a field type to pre process the given $incomingSettingsHash before it is handled by {@link eZ\Publish\SPI\FieldType\FieldType::fieldSettingsFromHash()}. The $incomingSettingsHash can be expected to conform to the rules that need to apply to hashes accepted by fieldSettingsFromHash(). The return value of this method replaces the $incomingSettingsHash.
See also: eZ\Publish\Core\REST\Common\Input\FieldTypeParser
public preProcessFieldSettingsHash ( mixed $incomingSettingsHash ) : mixed
$incomingSettingsHash mixed
return mixed Pre processed hash

preProcessValidatorConfigurationHash() public method

This method is called by the REST input parsers to allow a field type to pre process the given $incomingValidatorConfigurationHash before it is handled by {@link eZ\Publish\SPI\FieldType\FieldType::validatorConfigurationFromHash()}. The $incomingValidatorConfigurationHash can be expected to conform to the rules that need to apply to hashes accepted by validatorConfigurationFromHash(). The return value of this method replaces the $incomingValidatorConfigurationHash.
See also: eZ\Publish\Core\REST\Common\Input\FieldTypeParser
public preProcessValidatorConfigurationHash ( mixed $incomingValidatorConfigurationHash ) : mixed
$incomingValidatorConfigurationHash mixed
return mixed Pre processed hash

preProcessValueHash() public method

This method is called by the REST input parsers to allow a field type to pre process the given $incomingValueHash before it is handled by {@link eZ\Publish\SPI\FieldType\FieldType::fromHash()}. The $incomingValueHash can be expected to conform to the rules that need to apply to hashes accepted by fromHash(). The return value of this method replaces the $incomingValueHash.
See also: eZ\Publish\Core\REST\Common\Input\FieldTypeParser
public preProcessValueHash ( mixed $incomingValueHash ) : mixed
$incomingValueHash mixed
return mixed Pre processed hash