PHP Class eZ\Publish\Core\FieldType\Page\Type

Inheritance: extends eZ\Publish\Core\FieldType\FieldType
Afficher le fichier Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Свойство Type Description
$hashConverter HashConverter
$pageService PageService
$settingsSchema array

Méthodes publiques

Méthode Description
__construct ( PageService $pageService, HashConverter $hashConverter )
fromHash ( mixed $hash ) : Value Converts an $hash to the Value defined by the field type.
fromPersistenceValue ( eZ\Publish\SPI\Persistence\Content\FieldValue $fieldValue ) : Value Converts a persistence $fieldValue to a Value.
getEmptyValue ( ) : mixed Returns the empty value for this field type.
getFieldTypeIdentifier ( ) : string Returns the field type identifier for this field type.
getName ( eZ\Publish\SPI\FieldType\Value $value ) : string Returns the name of the given field value.
isEmptyValue ( eZ\Publish\SPI\FieldType\Value $value ) : boolean Returns if the given $value is considered empty by the field type.
toHash ( eZ\Publish\SPI\FieldType\Value $value ) : mixed Converts a Value to a hash.
toPersistenceValue ( eZ\Publish\SPI\FieldType\Value $value ) : eZ\Publish\SPI\Persistence\Content\FieldValue Converts a $value to a persistence value.
validateFieldSettings ( mixed $fieldSettings ) : eZ\Publish\SPI\FieldType\ValidationError[] Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.

Méthodes protégées

Méthode Description
checkValueStructure ( Value $value ) Throws an exception if value structure is not of expected format.
createValueFromInput ( Value $inputValue ) : Value Inspects given $inputValue and potentially converts it into a dedicated value object.
getSortInfo ( Value $value ) : mixed Returns information for FieldValue->$sortKey relevant to the field type.

Method Details

__construct() public méthode

public __construct ( PageService $pageService, HashConverter $hashConverter )
$pageService PageService
$hashConverter HashConverter

checkValueStructure() protected méthode

Throws an exception if value structure is not of expected format.
protected checkValueStructure ( Value $value )
$value eZ\Publish\Core\FieldType\Value

createValueFromInput() protected méthode

Inspects given $inputValue and potentially converts it into a dedicated value object.
protected createValueFromInput ( Value $inputValue ) : Value
$inputValue Value
Résultat Value The potentially converted and structurally plausible value.

fromHash() public méthode

Converts an $hash to the Value defined by the field type.
public fromHash ( mixed $hash ) : Value
$hash mixed
Résultat Value

fromPersistenceValue() public méthode

Converts a persistence $fieldValue to a Value.
public fromPersistenceValue ( eZ\Publish\SPI\Persistence\Content\FieldValue $fieldValue ) : Value
$fieldValue eZ\Publish\SPI\Persistence\Content\FieldValue
Résultat Value

getEmptyValue() public méthode

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.
public getEmptyValue ( ) : mixed
Résultat mixed

getFieldTypeIdentifier() public méthode

Returns the field type identifier for this field type.
public getFieldTypeIdentifier ( ) : string
Résultat string

getName() public méthode

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.
public getName ( eZ\Publish\SPI\FieldType\Value $value ) : string
$value eZ\Publish\SPI\FieldType\Value
Résultat string

getSortInfo() protected méthode

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.
protected getSortInfo ( Value $value ) : mixed
$value eZ\Publish\Core\FieldType\Value
Résultat mixed

isEmptyValue() public méthode

Returns if the given $value is considered empty by the field type.
public isEmptyValue ( eZ\Publish\SPI\FieldType\Value $value ) : boolean
$value eZ\Publish\SPI\FieldType\Value
Résultat boolean

toHash() public méthode

Converts a Value to a hash.
public toHash ( eZ\Publish\SPI\FieldType\Value $value ) : mixed
$value eZ\Publish\SPI\FieldType\Value
Résultat mixed

toPersistenceValue() public méthode

Converts a $value to a persistence value.
public toPersistenceValue ( eZ\Publish\SPI\FieldType\Value $value ) : eZ\Publish\SPI\Persistence\Content\FieldValue
$value eZ\Publish\SPI\FieldType\Value
Résultat eZ\Publish\SPI\Persistence\Content\FieldValue

validateFieldSettings() public méthode

Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.
public validateFieldSettings ( mixed $fieldSettings ) : eZ\Publish\SPI\FieldType\ValidationError[]
$fieldSettings mixed
Résultat eZ\Publish\SPI\FieldType\ValidationError[]

Property Details

$hashConverter protected_oe property

protected HashConverter,eZ\Publish\Core\FieldType\Page $hashConverter
Résultat HashConverter

$pageService protected_oe property

protected PageService,eZ\Publish\Core\FieldType\Page $pageService
Résultat PageService

$settingsSchema protected_oe property

protected array $settingsSchema
Résultat array