eZPublishCommunityProject  2013.4
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition Class Reference
+ Inheritance diagram for eZ\Publish\API\Repository\Values\ContentType\FieldDefinition:
+ Collaboration diagram for eZ\Publish\API\Repository\Values\ContentType\FieldDefinition:

Public Member Functions

 getDescription ($languageCode)
 This method returns the name of the field in the given language. More...
 
 getDescriptions ()
 This method returns the human readable description of the field. More...
 
 getFieldSettings ()
 This method returns settings for the field definition supported by the field type. More...
 
 getName ($languageCode)
 This method returns the name of the field in the given language. More...
 
 getNames ()
 This method returns the human readable name of this field in all provided languages of the content type. More...
 
 getValidatorConfiguration ()
 This method returns the validator configuration of this field definition supported by the field type. More...
 
- Public Member Functions inherited from eZ\Publish\API\Repository\Values\ValueObject
 __construct (array $properties=array())
 Construct object optionally with a set of properties. More...
 
 __get ($property)
 Magic get function handling read to non public properties. More...
 
 __isset ($property)
 Magic isset function handling isset() to non public properties. More...
 
 __set ($property, $value)
 Magic set function handling writes to non public properties. More...
 
 __unset ($property)
 Magic unset function handling unset() to non public properties. More...
 
 attribute ($property)
 Internal function for Legacy template engine compatibility to get property value. More...
 
 attributes ()
 Internal function for Legacy template engine compatibility to get properties. More...
 
 hasAttribute ($property)
 Internal function for Legacy template engine compatibility to check existence of property. More...
 

Protected Attributes

 $defaultValue
 
 $fieldGroup
 
 $fieldTypeIdentifier
 
 $id
 
 $identifier
 
 $isInfoCollector
 
 $isRequired
 
 $isSearchable
 
 $isTranslatable
 
 $position
 

Additional Inherited Members

- Static Public Member Functions inherited from eZ\Publish\API\Repository\Values\ValueObject
static __set_state (array $array)
 Returns a new instance of this class with the data specified by $array. More...
 
- Protected Member Functions inherited from eZ\Publish\API\Repository\Values\ValueObject
 getProperties ($dynamicProperties=array())
 Function where list of properties are returned. More...
 

Member Function Documentation

eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::getDescription (   $languageCode)
abstract

This method returns the name of the field in the given language.

Parameters
string$languageCode
Returns
string the description for the given language or null if none exists.
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::getDescriptions ( )
abstract

This method returns the human readable description of the field.

The structure of this field is: array( 'eng' => '<description_eng>', 'de' => '<description_de>' );

Returns
string[]
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::getFieldSettings ( )
abstract

This method returns settings for the field definition supported by the field type.

Returns
mixed

Referenced by eZ\Publish\Core\MVC\Symfony\Templating\Twig\Extension\ContentExtension\renderFieldDefinitionSettings().

eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::getName (   $languageCode)
abstract

This method returns the name of the field in the given language.

Parameters
string$languageCode
Returns
string the name for the given language or null if none exists.
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::getNames ( )
abstract

This method returns the human readable name of this field in all provided languages of the content type.

The structure of the return value is: array( 'eng' => '<name_eng>', 'de' => '<name_de>' );

Returns
string[]
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::getValidatorConfiguration ( )
abstract

Member Data Documentation

eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::$defaultValue
protected
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::$fieldGroup
protected
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::$fieldTypeIdentifier
protected
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::$id
protected
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::$identifier
protected
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::$isInfoCollector
protected
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::$isRequired
protected
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::$isSearchable
protected
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::$isTranslatable
protected
eZ\Publish\API\Repository\Values\ContentType\FieldDefinition::$position
protected

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