eZPublishCommunityProject  2013.9
eZ\Publish\Core\FieldType\BinaryFile\Type Class Reference

The TextLine field type. More...

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

Public Member Functions

 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...
 
 toHash (SPIValue $value)
 Converts a $Value to a hash. More...
 
- Public Member Functions inherited from eZ\Publish\Core\FieldType\BinaryBase\Type
 fromHash ($hash)
 Converts an $hash to the Value defined by the field type. More...
 
 fromPersistenceValue (PersistenceValue $fieldValue)
 Converts a persistence $fieldValue to a Value. More...
 
 getName (SPIValue $value)
 Returns the name of the given field value. More...
 
 isSearchable ()
 Returns whether the field type is searchable. More...
 
 toHash (SPIValue $value)
 Converts a $Value to a hash. More...
 
 toPersistenceValue (SPIValue $value)
 Converts a $value to a persistence value. More...
 
 validate (FieldDefinition $fieldDefinition, SPIValue $fieldValue)
 Validates a field based on the validators in the field definition. More...
 
 validateValidatorConfiguration ($validatorConfiguration)
 Validates the validatorConfiguration 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...
 
 applyDefaultValidatorConfiguration (&$validatorConfiguration)
 Applies the default values to the given $validatorConfiguration 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 (PersistenceValue $fieldValue)
 Converts a persistence $fieldValue to a Value. More...
 
 getRelations (SPIValue $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 (SPIValue $value)
 Returns if the given $value is considered empty by the field type. More...
 
 isSearchable ()
 Returns whether the field type is searchable. More...
 
 isSingular ()
 Indicates if the field definition of this type can appear only once in the same ContentType. More...
 
 onlyEmptyInstance ()
 Indicates if the field definition of this type can be added to a ContentType with Content instances. More...
 
 setTransformationProcessor (TransformationProcessor $transformationProcessor)
 
 toPersistenceValue (SPIValue $value)
 Converts a $value to a persistence value. More...
 
 validate (FieldDefinition $fieldDefinition, SPIValue $value)
 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 Member Functions inherited from eZ\Publish\API\Repository\FieldType
 getName ($value)
 Returns a human readable string representation from the given $value. More...
 
 isEmptyValue ($value)
 Returns if the given $value is considered empty by the field type. More...
 
 toHash ($value)
 Converts the given $value into a plain hash format. More...
 

Protected Member Functions

 completeValue ($value)
 Attempts to complete the data in $value. More...
 
 createValue (array $inputValue)
 Creates a specific value of the derived class from $inputValue. More...
 
- Protected Member Functions inherited from eZ\Publish\Core\FieldType\BinaryBase\Type
 checkValueStructure (BaseValue $value)
 Throws an exception if value structure is not of expected format. More...
 
 completeValue ($value)
 Attempts to complete the data in $value. More...
 
 createValue (array $inputValue)
 Creates a specific value of the derived class from $inputValue. More...
 
 createValueFromInput ($inputValue)
 Inspects given $inputValue and potentially converts it into a dedicated value object. More...
 
 getSortInfo (BaseValue $value)
 BinaryBase does not support sorting. More...
 
- Protected Member Functions inherited from eZ\Publish\Core\FieldType\FieldType
 checkValueStructure (Value $value)
 Throws an exception if value structure is not of expected format. More...
 
 createValueFromInput ($inputValue)
 Inspects given $inputValue and potentially converts it into a dedicated value object. More...
 
 getSortInfo (Value $value)
 Returns information for FieldValue->$sortKey relevant to the field type. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from eZ\Publish\Core\FieldType\FieldType
static checkValueType ($value)
 Throws an exception if the given $value is not an instance of the supported value subtype. More...
 
- Protected Attributes inherited from eZ\Publish\Core\FieldType\BinaryBase\Type
 $validatorConfigurationSchema
 
- Protected Attributes inherited from eZ\Publish\Core\FieldType\FieldType
 $settingsSchema = array()
 
 $transformationProcessor
 
 $validatorConfigurationSchema = array()
 

Detailed Description

The TextLine field type.

This field type represents a simple string.

Member Function Documentation

eZ\Publish\Core\FieldType\BinaryFile\Type::completeValue (   $value)
protected

Attempts to complete the data in $value.

Parameters
mixed$value
Returns
void
eZ\Publish\Core\FieldType\BinaryFile\Type::createValue ( array  $inputValue)
protected

Creates a specific value of the derived class from $inputValue.

Parameters
array$inputValue
Returns
Value
eZ\Publish\Core\FieldType\BinaryFile\Type::fromPersistenceValue ( FieldValue  $fieldValue)

Converts a persistence $fieldValue to a Value.

This method builds a field type value from the $data and $externalData properties.

Parameters
\eZ\Publish\SPI\Persistence\Content\FieldValue$fieldValue
Returns
eZ\Publish\Core\FieldType\BinaryFile\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.

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

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

Returns the field type identifier for this field type.

Returns
string

Implements eZ\Publish\API\Repository\FieldType.

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

Converts a $Value to a hash.

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

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