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

This field type represents a simple string.
Наследование: extends eZ\Publish\Core\FieldType\FieldType
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (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.

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

Метод Описание
fromHash ( mixed $hash ) : Value Converts an $hash to the Value defined by the field type.
getEmptyValue ( ) : Value Returns the fallback default value of field type when no such default value is provided in the field definition in content types.
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.
isSearchable ( ) : boolean Returns whether the field type is searchable.
toHash ( eZ\Publish\SPI\FieldType\Value $value ) : mixed Converts a $Value to a hash.
validate ( eZ\Publish\API\Repository\Values\ContentType\FieldDefinition $fieldDefinition, eZ\Publish\SPI\FieldType\Value $fieldValue ) : eZ\Publish\SPI\FieldType\ValidationError[] Validates field value against 'isMultiple' and 'options' settings.
validateFieldSettings ( mixed $fieldSettings ) : eZ\Publish\SPI\FieldType\ValidationError[] Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.

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

Метод Описание
checkValueStructure ( Value $value ) Throws an exception if value structure is not of expected format.
createValueFromInput ( array | Value $inputValue ) : Value Inspects given $inputValue and potentially converts it into a dedicated value object.
getSortInfo ( Value $value ) : array Returns information for FieldValue->$sortKey relevant to the field type.

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

checkValueStructure() защищенный Метод

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

createValueFromInput() защищенный Метод

Inspects given $inputValue and potentially converts it into a dedicated value object.
protected createValueFromInput ( array | Value $inputValue ) : Value
$inputValue array | Value
Результат Value The potentially converted and structurally plausible value.

fromHash() публичный Метод

Converts an $hash to the Value defined by the field type.
public fromHash ( mixed $hash ) : Value
$hash mixed
Результат Value $value

getEmptyValue() публичный Метод

Returns the fallback default value of field type when no such default value is provided in the field definition in content types.
public getEmptyValue ( ) : Value
Результат Value

getFieldTypeIdentifier() публичный Метод

Returns the field type identifier for this field type.
public getFieldTypeIdentifier ( ) : string
Результат string

getName() публичный Метод

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
Результат string

getSortInfo() защищенный Метод

Returns information for FieldValue->$sortKey relevant to the field type.
protected getSortInfo ( Value $value ) : array
$value eZ\Publish\Core\FieldType\Value
Результат array

isSearchable() публичный Метод

Returns whether the field type is searchable.
public isSearchable ( ) : boolean
Результат boolean

toHash() публичный Метод

Converts a $Value to a hash.
public toHash ( eZ\Publish\SPI\FieldType\Value $value ) : mixed
$value eZ\Publish\SPI\FieldType\Value
Результат mixed

validate() публичный Метод

Does not use validators.
public validate ( eZ\Publish\API\Repository\Values\ContentType\FieldDefinition $fieldDefinition, eZ\Publish\SPI\FieldType\Value $fieldValue ) : eZ\Publish\SPI\FieldType\ValidationError[]
$fieldDefinition eZ\Publish\API\Repository\Values\ContentType\FieldDefinition The field definition of the field
$fieldValue eZ\Publish\SPI\FieldType\Value The field value for which an action is performed
Результат eZ\Publish\SPI\FieldType\ValidationError[]

validateFieldSettings() публичный Метод

Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.
public validateFieldSettings ( mixed $fieldSettings ) : eZ\Publish\SPI\FieldType\ValidationError[]
$fieldSettings mixed
Результат eZ\Publish\SPI\FieldType\ValidationError[]

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

$settingsSchema защищенное свойство

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.
protected mixed $settingsSchema
Результат mixed