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

This field type represents a simple string.
Inheritance: extends eZ\Publish\Core\FieldType\FieldType
Afficher le fichier Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Свойство Type Description
$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.

Méthodes publiques

Méthode Description
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.

Méthodes protégées

Méthode Description
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.

Method Details

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 ( array | Value $inputValue ) : Value
$inputValue array | 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 $value

getEmptyValue() public méthode

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
Résultat Value

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

Returns information for FieldValue->$sortKey relevant to the field type.
protected getSortInfo ( Value $value ) : array
$value eZ\Publish\Core\FieldType\Value
Résultat array

isSearchable() public méthode

Returns whether the field type is searchable.
public isSearchable ( ) : boolean
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

validate() public méthode

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
Résultat eZ\Publish\SPI\FieldType\ValidationError[]

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

$settingsSchema protected_oe property

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
Résultat mixed