eZPublishCommunityProject  2012.12
eZ\Publish\Core\FieldType\MapLocation\Type Class Reference

MapLocation field types. More...

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

Public Member Functions

 fromHash ($hash)
 Converts an $hash to the Value defined by the field type. More...
 
 fromPersistenceValue (FieldValue $fieldValue)
 Converts a persistence $fieldValue to a Value. 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...
 
 getIndexData ($value)
 Get index data for field data for search backend. More...
 
 getName ($value)
 Returns the name of the given field 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)
 Converts a $value to a persistence value. 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...
 
 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...
 
 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...
 

Protected Member Functions

 getSortInfo ($value)
 Returns information for FieldValue->$sortKey relevant to the field type. 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...
 

Additional Inherited Members

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

Detailed Description

MapLocation field types.

Represents keywords.

Member Function Documentation

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

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

Parameters
mixed$hash
Returns
$value

Implements eZ\Publish\API\Repository\FieldType.

Referenced by eZ\Publish\Core\FieldType\MapLocation\Type\fromPersistenceValue().

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

Converts a persistence $fieldValue to a Value.

Parameters
\eZ\Publish\SPI\Persistence\Content\FieldValue$fieldValue
Returns
mixed
eZ\Publish\Core\FieldType\MapLocation\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\MapLocation\Type::getFieldTypeIdentifier ( )

Returns the field type identifier for this field type.

Returns
string

Implements eZ\Publish\API\Repository\FieldType.

eZ\Publish\Core\FieldType\MapLocation\Type::getIndexData (   $value)

Get index data for field data for search backend.

Parameters
mixed$value
Returns
[]
eZ\Publish\Core\FieldType\MapLocation\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\MapLocation\Type::getSortInfo (   $value)
protected

Returns information for FieldValue->$sortKey relevant to the field type.

Returns
string

Referenced by eZ\Publish\Core\FieldType\MapLocation\Type\toPersistenceValue().

eZ\Publish\Core\FieldType\MapLocation\Type::internalAcceptValue (   $inputValue)
protected

Implements the core of {.

See Also
acceptValue()}.
Parameters
mixed$inputValue
Returns
The potentially converted and structurally plausible value.
eZ\Publish\Core\FieldType\MapLocation\Type::isEmptyValue (   $value)

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

Parameters
mixed$value
Returns
boolean

Referenced by eZ\Publish\Core\FieldType\MapLocation\Type\toHash().

eZ\Publish\Core\FieldType\MapLocation\Type::isSearchable ( )

Returns whether the field type is searchable.

Returns
boolean

Implements eZ\Publish\API\Repository\FieldType.

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

Converts a $Value to a hash.

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

Implements eZ\Publish\API\Repository\FieldType.

Referenced by eZ\Publish\Core\FieldType\MapLocation\Type\toPersistenceValue().

eZ\Publish\Core\FieldType\MapLocation\Type::toPersistenceValue (   $value)

Converts a $value to a persistence value.

Parameters
mixed$value
Returns

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