eZPublishCommunityProject  2012.12
eZ\Publish\Core\FieldType\Keyword\KeywordStorage Class Reference

Converter for Keyword field type external storage. More...

+ Inheritance diagram for eZ\Publish\Core\FieldType\Keyword\KeywordStorage:
+ Collaboration diagram for eZ\Publish\Core\FieldType\Keyword\KeywordStorage:

Public Member Functions

 deleteFieldData (VersionInfo $versionInfo, array $fieldId, array $context)
 
 getFieldData (VersionInfo $versionInfo, Field $field, array $context)
 Populates $field value property based on the external data. More...
 
 getIndexData (VersionInfo $versionInfo, Field $field, array $context)
 
 hasFieldData ()
 Checks if field type has external data to deal with. More...
 
 storeFieldData (VersionInfo $versionInfo, Field $field, array $context)
 
- Public Member Functions inherited from eZ\Publish\Core\FieldType\GatewayBasedStorage
 __construct (array $gateways)
 Construct from gateways. More...
 
 addGateway ($identifier, StorageGateway $gateway)
 Adds a storage $gateway assigned to the given $identifier. More...
 

Additional Inherited Members

- Protected Member Functions inherited from eZ\Publish\Core\FieldType\GatewayBasedStorage
 getGateway (array $context)
 Retrieve the fitting gateway, base on the identifier in $context. More...
 
- Protected Attributes inherited from eZ\Publish\Core\FieldType\GatewayBasedStorage
 $gateways
 

Detailed Description

Converter for Keyword field type external storage.

The keyword storage ships a list (array) of keywords in $field->value->externalData. $field->value->data is simply empty, because no internal data is store.

Member Function Documentation

eZ\Publish\Core\FieldType\Keyword\KeywordStorage::deleteFieldData ( VersionInfo  $versionInfo,
array  $fieldId,
array  $context 
)
Parameters
array$fieldId
array$context
Returns
boolean

Implements eZ\Publish\SPI\FieldType\FieldStorage.

eZ\Publish\Core\FieldType\Keyword\KeywordStorage::getFieldData ( VersionInfo  $versionInfo,
Field  $field,
array  $context 
)

Populates $field value property based on the external data.

$field->value is a eZ object. This value holds the data as a eZ based object, according to the field type (e.g. for TextLine, it will be a eZ object).

Parameters
\eZ\Publish\SPI\Persistence\Content\Field$field
array$context
Returns
void

Implements eZ\Publish\SPI\FieldType\FieldStorage.

eZ\Publish\Core\FieldType\Keyword\KeywordStorage::getIndexData ( VersionInfo  $versionInfo,
Field  $field,
array  $context 
)
Parameters
\eZ\Publish\SPI\Persistence\Content\Field$field
array$context

Implements eZ\Publish\SPI\FieldType\FieldStorage.

eZ\Publish\Core\FieldType\Keyword\KeywordStorage::hasFieldData ( )

Checks if field type has external data to deal with.

Returns
boolean

Implements eZ\Publish\SPI\FieldType\FieldStorage.

eZ\Publish\Core\FieldType\Keyword\KeywordStorage::storeFieldData ( VersionInfo  $versionInfo,
Field  $field,
array  $context 
)

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