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

Represents a larger body of text, such as text areas.
Inheritance: extends eZ\Publish\Core\FieldType\FieldType
Mostra file Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Property Type Description
$settingsSchema
$validatorConfigurationSchema

Public Methods

Method Description
fromHash ( mixed $hash ) : eZ\Publish\Core\FieldType\TextBlock\Value Converts an $hash to the Value defined by the field type.
getEmptyValue ( ) : eZ\Publish\Core\FieldType\TextBlock\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.
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.
toHash ( eZ\Publish\SPI\FieldType\Value $value ) : mixed Converts a $Value to a hash.
validateFieldSettings ( mixed $fieldSettings ) : eZ\Publish\SPI\FieldType\ValidationError[] Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.

Protected Methods

Method Description
checkValueStructure ( Value $value ) Throws an exception if value structure is not of expected format.
createValueFromInput ( string | eZ\Publish\Core\FieldType\TextBlock\Value $inputValue ) : eZ\Publish\Core\FieldType\TextBlock\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 method

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

createValueFromInput() protected method

Inspects given $inputValue and potentially converts it into a dedicated value object.
protected createValueFromInput ( string | eZ\Publish\Core\FieldType\TextBlock\Value $inputValue ) : eZ\Publish\Core\FieldType\TextBlock\Value
$inputValue string | eZ\Publish\Core\FieldType\TextBlock\Value
return eZ\Publish\Core\FieldType\TextBlock\Value The potentially converted and structurally plausible value.

fromHash() public method

Converts an $hash to the Value defined by the field type.
public fromHash ( mixed $hash ) : eZ\Publish\Core\FieldType\TextBlock\Value
$hash mixed
return eZ\Publish\Core\FieldType\TextBlock\Value $value

getEmptyValue() public method

Returns the fallback default value of field type when no such default value is provided in the field definition in content types.
public getEmptyValue ( ) : eZ\Publish\Core\FieldType\TextBlock\Value
return eZ\Publish\Core\FieldType\TextBlock\Value

getFieldTypeIdentifier() public method

Returns the field type identifier for this field type.
public getFieldTypeIdentifier ( ) : string
return string

getName() public method

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
return string

getSortInfo() protected method

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

isEmptyValue() public method

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
return boolean

isSearchable() public method

Returns whether the field type is searchable.
public isSearchable ( ) : boolean
return boolean

toHash() public method

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

validateFieldSettings() public method

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

Property Details

$settingsSchema protected_oe property

protected $settingsSchema

$validatorConfigurationSchema protected_oe property

protected $validatorConfigurationSchema