eZPublishCommunityProject  2013.6
eZ\Publish\Core\FieldType\Page\Type Class Reference
+ Inheritance diagram for eZ\Publish\Core\FieldType\Page\Type:
+ Collaboration diagram for eZ\Publish\Core\FieldType\Page\Type:

Public Member Functions

 __construct (PageService $pageService, HashConverter $hashConverter)
 
 fromHash ($hash)
 Converts an $hash to the Value defined by the field type. More...
 
 fromPersistenceValue (FieldValue $fieldValue)
 Converts a persistence $fieldValue to a Value. More...
 
 getEmptyValue ()
 Returns the empty value for this field type. More...
 
 getFieldTypeIdentifier ()
 Returns the field type identifier for this field type. More...
 
 getName ($value)
 Returns the name of the given field value. More...
 
 toHash ($value)
 Converts a Value to a hash. More...
 
 toPersistenceValue ($value)
 Converts a $value to a persistence value. More...
 
 validateFieldSettings ($fieldSettings)
 Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct. More...
 
- Public Member Functions inherited from eZ\Publish\Core\FieldType\FieldType
 acceptValue ($inputValue)
 Potentially builds and checks the type and structure of the $inputValue. More...
 
 applyDefaultSettings (&$fieldSettings)
 Applies the default values to the fieldSettings of a FieldDefinitionCreateStruct. More...
 
 fieldSettingsFromHash ($fieldSettingsHash)
 Converts the given $fieldSettingsHash to field settings of the type. More...
 
 fieldSettingsToHash ($fieldSettings)
 Converts the given $fieldSettings to a simple hash format. More...
 
 fromPersistenceValue (FieldValue $fieldValue)
 Converts a persistence $fieldValue to a Value. More...
 
 getRelations ($fieldValue)
 Returns relation data extracted from value. More...
 
 getSettingsSchema ()
 Returns a schema for the settings expected by the FieldType. More...
 
 getValidatorConfigurationSchema ()
 Returns a schema for the validator configuration expected by the FieldType. More...
 
 isEmptyValue ($value)
 Returns if the given $value is considered empty by the field type. More...
 
 isSearchable ()
 Returns whether the field type is searchable. More...
 
 toPersistenceValue ($value)
 Converts a $value to a persistence value. More...
 
 validate (FieldDefinition $fieldDefinition, $fieldValue)
 Validates a field based on the validators in the field definition. More...
 
 validateFieldSettings ($fieldSettings)
 Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct. More...
 
 validateValidatorConfiguration ($validatorConfiguration)
 Validates the validatorConfiguration of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct. More...
 
 validatorConfigurationFromHash ($validatorConfigurationHash)
 Converts the given $validatorConfigurationHash to a validator configuration of the type. More...
 
 validatorConfigurationToHash ($validatorConfiguration)
 Converts the given $validatorConfiguration to a simple hash format. More...
 

Protected Member Functions

 getSortInfo ($value)
 Returns information for FieldValue->$sortKey relevant to the field type. More...
 
 internalAcceptValue ($inputValue)
 Implements the core of {. More...
 
- Protected Member Functions inherited from eZ\Publish\Core\FieldType\FieldType
 getSortInfo ($value)
 Returns information for FieldValue->$sortKey relevant to the field type. More...
 
 internalAcceptValue ($inputValue)
 Implements the core of {. More...
 

Protected Attributes

 $hashConverter
 
 $pageService
 
 $settingsSchema
 
- Protected Attributes inherited from eZ\Publish\Core\FieldType\FieldType
 $settingsSchema = array()
 
 $validatorConfigurationSchema = array()
 

Constructor & Destructor Documentation

eZ\Publish\Core\FieldType\Page\Type::__construct ( PageService  $pageService,
HashConverter  $hashConverter 
)
Parameters
\eZ\Publish\Core\FieldType\Page\PageService$pageService
\eZ\Publish\Core\FieldType\Page\HashConverter$hashConverter

Member Function Documentation

eZ\Publish\Core\FieldType\Page\Type::fromHash (   $hash)

Converts an $hash to the Value defined by the field type.

Parameters
mixed$hash
Returns
mixed

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\Page\Type::fromPersistenceValue ( FieldValue  $fieldValue)

Converts a persistence $fieldValue to a Value.

Parameters
\eZ\Publish\SPI\Persistence\Content\FieldValue$fieldValue
Returns
mixed
eZ\Publish\Core\FieldType\Page\Type::getEmptyValue ( )

Returns the empty value for this field type.

This value will be used, if no value was provided for a field of this type and no default value was specified in the field definition.

Returns
mixed

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\Page\Type::getFieldTypeIdentifier ( )

Returns the field type identifier for this field type.

Returns
string

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\Page\Type::getName (   $value)

Returns the name of the given field value.

It will be used to generate content name and url alias if current field is designated to be used in the content name/urlAlias pattern.

Parameters
mixed$value
Returns
mixed

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\Page\Type::getSortInfo (   $value)
protected

Returns information for FieldValue->$sortKey relevant to the field type.

Return value is mixed. It should be something which is sensible for sorting.

It is up to the persistence implementation to handle those values. Common string and integer values are safe.

For the legacy storage it is up to the field converters to set this value in either sort_key_string or sort_key_int.

Parameters
mixed$value
Returns
mixed
eZ\Publish\Core\FieldType\Page\Type::internalAcceptValue (   $inputValue)
protected

Implements the core of {.

See Also
acceptValue()}.
Parameters
mixed$inputValue
Returns
The potentially converted and structurally plausible value.
eZ\Publish\Core\FieldType\Page\Type::toHash (   $value)

Converts a Value to a hash.

Parameters
mixed$value
Returns
mixed

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\Page\Type::toPersistenceValue (   $value)

Converts a $value to a persistence value.

Parameters
mixed$value
Returns
eZ\Publish\Core\FieldType\Page\Type::validateFieldSettings (   $fieldSettings)

Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.

Parameters
mixed$fieldSettings
Returns
[]

Member Data Documentation

eZ\Publish\Core\FieldType\Page\Type::$hashConverter
protected
eZ\Publish\Core\FieldType\Page\Type::$pageService
protected
eZ\Publish\Core\FieldType\Page\Type::$settingsSchema
protected
Initial value:
= array(
'defaultLayout' => array(
'type' => 'string',
'default' => '',
)
)

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