eZPublishCommunityProject  2013.6
eZ\Publish\Core\REST\Common\FieldTypeProcessor Class Reference

FieldTypeProcessor. More...

+ Inheritance diagram for eZ\Publish\Core\REST\Common\FieldTypeProcessor:

Public Member Functions

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

Detailed Description

Member Function Documentation

eZ\Publish\Core\REST\Common\FieldTypeProcessor::postProcessFieldSettingsHash (   $outgoingSettingsHash)

Perform manipulations on a received $outgoingSettingsHash.

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 ::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
Parameters
mixed$outgoingSettingsHash
Returns
mixed Post processed hash
eZ\Publish\Core\REST\Common\FieldTypeProcessor::postProcessValidatorConfigurationHash (   $outgoingValidatorConfigurationHash)

Perform manipulations on a received $outgoingValidatorConfigurationHash.

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 ::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
Parameters
mixed$outgoingValidatorConfigurationHash
Returns
mixed Post processed hash
eZ\Publish\Core\REST\Common\FieldTypeProcessor::postProcessValueHash (   $outgoingValueHash)

Perform manipulations on an a generated $outgoingValueHash.

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 ::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
Parameters
mixed$outgoingValueHash
Returns
mixed Post processed hash
eZ\Publish\Core\REST\Common\FieldTypeProcessor::preProcessFieldSettingsHash (   $incomingSettingsHash)

Perform manipulations on a received $incomingSettingsHash.

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 ::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
Parameters
mixed$incomingSettingsHash
Returns
mixed Pre processed hash
eZ\Publish\Core\REST\Common\FieldTypeProcessor::preProcessValidatorConfigurationHash (   $incomingValidatorConfigurationHash)

Perform manipulations on a received $incomingValidatorConfigurationHash.

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 ::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
Parameters
mixed$incomingValidatorConfigurationHash
Returns
mixed Pre processed hash
eZ\Publish\Core\REST\Common\FieldTypeProcessor::preProcessValueHash (   $incomingValueHash)

Perform manipulations on a received $incomingValueHash.

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 ::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
Parameters
mixed$incomingValueHash
Returns
mixed Pre processed hash

The documentation for this class was generated from the following file: