• Главная
• eZ
• Publish
• Core
• FieldType
• FieldType

PHP Класс eZ\Publish\Core\FieldType\FieldType

All other field types extend FieldType providing the specific functionality desired in each case. The capabilities supported by each individual field type is decided by which interfaces the field type implements support for. These individual capabilities can also be checked via the supports*() methods. Field types are the base building blocks of Content Types, and serve as data containers for Content objects. Therefore, while field types can be used independently, they are designed to be used as a part of a Content object. Field types are primed and pre-configured with the Field Definitions found in Content Types. Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$settingsSchema	mixed	The key is the setting name, and the value is the default value for given setting, set to null if no particular default should be set.
$transformationProcessor	eZ\Publish\Core\Persistence\TransformationProcessor	String transformation processor, used to normalize sort string as needed.
$validatorConfigurationSchema	mixed	This is a base implementation, containing an empty array() that indicates that no validators are supported. Overwrite in derived types, if validation is supported.

Открытые методы

Метод	Описание
acceptValue ( mixed $inputValue ) : Value	Potentially builds and checks the type and structure of the $inputValue.
applyDefaultSettings ( mixed &$fieldSettings )	Applies the default values to the fieldSettings of a FieldDefinitionCreateStruct.
applyDefaultValidatorConfiguration ( mixed &$validatorConfiguration )	Applies the default values to the given $validatorConfiguration of a FieldDefinitionCreateStruct.
fieldSettingsFromHash ( array | hash | scalar | null $fieldSettingsHash ) : mixed	Converts the given $fieldSettingsHash to field settings of the type.
fieldSettingsToHash ( mixed $fieldSettings ) : array | hash | scalar | null	Converts the given $fieldSettings to a simple hash format.
fromPersistenceValue ( eZ\Publish\SPI\Persistence\Content\FieldValue $fieldValue ) : Value	Converts a persistence $fieldValue to a Value.
getRelations ( eZ\Publish\SPI\FieldType\Value $fieldValue ) : array	Returns relation data extracted from value.
getSettingsSchema ( ) : mixed	Returns a schema for the settings expected by the FieldType.
getValidatorConfigurationSchema ( ) : mixed	Returns a schema for the validator configuration expected by the FieldType.
isEmptyValue ( eZ\Publish\SPI\FieldType\Value $value ) : boolean	Returns if the given $value is considered empty by the field type.
isSearchable ( ) : boolean	Returns whether the field type is searchable.
isSingular ( ) : boolean	Indicates if the field definition of this type can appear only once in the same ContentType.
onlyEmptyInstance ( ) : boolean	Indicates if the field definition of this type can be added to a ContentType with Content instances.
setTransformationProcessor ( TransformationProcessor $transformationProcessor )
toPersistenceValue ( eZ\Publish\SPI\FieldType\Value $value ) : eZ\Publish\SPI\Persistence\Content\FieldValue	Converts a $value to a persistence value.
validate ( eZ\Publish\API\Repository\Values\ContentType\FieldDefinition $fieldDefinition, eZ\Publish\SPI\FieldType\Value $value ) : eZ\Publish\SPI\FieldType\ValidationError[]	Validates a field based on the validators in the field definition.
validateFieldSettings ( mixed $fieldSettings ) : eZ\Publish\SPI\FieldType\ValidationError[]	Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.
validateValidatorConfiguration ( mixed $validatorConfiguration ) : eZ\Publish\SPI\FieldType\ValidationError[]	Validates the validatorConfiguration of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.
validatorConfigurationFromHash ( array | hash | scalar | null $validatorConfigurationHash ) : mixed	Converts the given $validatorConfigurationHash to a validator configuration of the type.
validatorConfigurationToHash ( mixed $validatorConfiguration ) : array | hash | scalar | null	Converts the given $validatorConfiguration to a simple hash format.

Защищенные методы

Метод	Описание
checkValueStructure ( Value $value )	Throws an exception if value structure is not of expected format.
checkValueType ( mixed $value )	Throws an exception if the given $value is not an instance of the supported value subtype.
createValueFromInput ( mixed $inputValue ) : mixed	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.

Описание методов

Описание свойств