eZPublishCommunityProject  2013.5
eZ\Publish\Core\FieldType\XmlText\Type Class Reference

XmlText field type. More...

+ Inheritance diagram for eZ\Publish\Core\FieldType\XmlText\Type:
+ Collaboration diagram for eZ\Publish\Core\FieldType\XmlText\Type:

Public Member Functions

 fromHash ($hash)
 Converts an $hash to the Value defined by the field type. More...
 
 fromPersistenceValue (FieldValue $fieldValue)
 Creates a new Value object from persistence data. More...
 
 getEmptyValue ()
 Returns the fallback default value of field type when no such default value is provided in the field definition in content types. More...
 
 getFieldTypeIdentifier ()
 Returns the field type identifier for this field type. More...
 
 getName ($value)
 Returns the name of the given field value. More...
 
 getRelations ($fieldValue)
 Returns relation data extracted from value. More...
 
 isEmptyValue ($value)
 Returns if the given $value is considered empty by the field type. More...
 
 isSearchable ()
 Returns whether the field type is searchable. More...
 
 toHash ($value)
 Converts a $Value to a hash. More...
 
 toPersistenceValue ($value)
 
 validateFieldSettings ($fieldSettings)
 Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct. More...
 
- Public Member Functions inherited from eZ\Publish\Core\FieldType\FieldType
 acceptValue ($inputValue)
 Potentially builds and checks the type and structure of the $inputValue. More...
 
 applyDefaultSettings (&$fieldSettings)
 Applies the default values to the fieldSettings of a FieldDefinitionCreateStruct. More...
 
 fieldSettingsFromHash ($fieldSettingsHash)
 Converts the given $fieldSettingsHash to field settings of the type. More...
 
 fieldSettingsToHash ($fieldSettings)
 Converts the given $fieldSettings to a simple hash format. More...
 
 fromPersistenceValue (FieldValue $fieldValue)
 Converts a persistence $fieldValue to a Value. More...
 
 getRelations ($fieldValue)
 Returns relation data extracted from value. More...
 
 getSettingsSchema ()
 Returns a schema for the settings expected by the FieldType. More...
 
 getValidatorConfigurationSchema ()
 Returns a schema for the validator configuration expected by the FieldType. More...
 
 isEmptyValue ($value)
 Returns if the given $value is considered empty by the field type. More...
 
 isSearchable ()
 Returns whether the field type is searchable. More...
 
 toPersistenceValue ($value)
 Converts a $value to a persistence value. More...
 
 validate (FieldDefinition $fieldDefinition, $fieldValue)
 Validates a field based on the validators in the field definition. More...
 
 validateFieldSettings ($fieldSettings)
 Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct. More...
 
 validateValidatorConfiguration ($validatorConfiguration)
 Validates the validatorConfiguration of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct. More...
 
 validatorConfigurationFromHash ($validatorConfigurationHash)
 Converts the given $validatorConfigurationHash to a validator configuration of the type. More...
 
 validatorConfigurationToHash ($validatorConfiguration)
 Converts the given $validatorConfiguration to a simple hash format. More...
 

Public Attributes

const TAG_PRESET_DEFAULT = 0
 Default preset of tags available in online editor. More...
 
const TAG_PRESET_SIMPLE_FORMATTING = 1
 Preset of tags for online editor intended for simple formatting options. More...
 

Protected Member Functions

 getSortInfo ($value)
 Returns sortKey information. More...
 
 internalAcceptValue ($inputValue)
 Implements the core of {. More...
 
- Protected Member Functions inherited from eZ\Publish\Core\FieldType\FieldType
 getSortInfo ($value)
 Returns information for FieldValue->$sortKey relevant to the field type. More...
 
 internalAcceptValue ($inputValue)
 Implements the core of {. More...
 

Protected Attributes

 $settingsSchema
 
- Protected Attributes inherited from eZ\Publish\Core\FieldType\FieldType
 $settingsSchema = array()
 
 $validatorConfigurationSchema = array()
 

Detailed Description

XmlText field type.

Member Function Documentation

eZ\Publish\Core\FieldType\XmlText\Type::fromHash (   $hash)

Converts an $hash to the Value defined by the field type.

$hash accepts the following keys:

  • xml (XML string which complies internal format)
Parameters
mixed$hash
Returns
$value

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\XmlText\Type::fromPersistenceValue ( FieldValue  $fieldValue)

Creates a new Value object from persistence data.

$fieldValue->data is supposed to be a DOMDocument object.

Parameters
\eZ\Publish\SPI\Persistence\Content\FieldValue$fieldValue
Returns
Value
eZ\Publish\Core\FieldType\XmlText\Type::getEmptyValue ( )

Returns the fallback default value of field type when no such default value is provided in the field definition in content types.

Returns

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\XmlText\Type::getFieldTypeIdentifier ( )

Returns the field type identifier for this field type.

Returns
string

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\XmlText\Type::getName (   $value)

Returns the name of the given field value.

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.

Parameters
mixed$value
Returns
mixed

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\XmlText\Type::getRelations (   $fieldValue)

Returns relation data extracted from value.

Not intended for ::COMMON type relations, there is a service API for handling those.

Parameters
mixed$fieldValue
Returns
array Hash with relation type as key and array of destination content ids as value.

Example: array( ::LINK => array( "contentIds" => array( 12, 13, 14 ), "locationIds" => array( 24 ) ), ::EMBED => array( "contentIds" => array( 12 ), "locationIds" => array( 24, 45 ) ), ::ATTRIBUTE => array( 12 ) )

eZ\Publish\Core\FieldType\XmlText\Type::getSortInfo (   $value)
protected

Returns sortKey information.

See Also
Parameters
mixed$value
Returns
array|bool
eZ\Publish\Core\FieldType\XmlText\Type::internalAcceptValue (   $inputValue)
protected

Implements the core of {.

See Also
acceptValue()}.
Parameters
\eZ\Publish\Core\FieldType\XmlText\Value | \eZ\Publish\Core\FieldType\XmlText\Input | string$inputValue
Returns
The potentially converted and structurally plausible value.
eZ\Publish\Core\FieldType\XmlText\Type::isEmptyValue (   $value)

Returns if the given $value is considered empty by the field type.

Parameters
mixed$value
Returns
boolean
eZ\Publish\Core\FieldType\XmlText\Type::isSearchable ( )

Returns whether the field type is searchable.

Returns
boolean

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\XmlText\Type::toHash (   $value)

Converts a $Value to a hash.

Parameters
\eZ\Publish\Core\FieldType\XmlText\Value$value
Returns
mixed

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\XmlText\Type::toPersistenceValue (   $value)
Parameters
\eZ\Publish\Core\FieldType\XmlText\Value$value
Returns
eZ\Publish\Core\FieldType\XmlText\Type::validateFieldSettings (   $fieldSettings)

Validates the fieldSettings of a FieldDefinitionCreateStruct or FieldDefinitionUpdateStruct.

Parameters
mixed$fieldSettings
Returns
[]

Member Data Documentation

eZ\Publish\Core\FieldType\XmlText\Type::$settingsSchema
protected
Initial value:
= array(
"numRows" => array(
"type" => "int",
"default" => 10
),
"tagPreset" => array(
"type" => "choice",
"default" => self::TAG_PRESET_DEFAULT
)
)
const eZ\Publish\Core\FieldType\XmlText\Type::TAG_PRESET_DEFAULT = 0

Default preset of tags available in online editor.

const eZ\Publish\Core\FieldType\XmlText\Type::TAG_PRESET_SIMPLE_FORMATTING = 1

Preset of tags for online editor intended for simple formatting options.


The documentation for this class was generated from the following file: