PHP Class eZ\Publish\Core\Repository\Values\ContentType\FieldDefinition

Inheritance: extends eZ\Publish\API\Repository\Values\ContentType\FieldDefinition
Show file Open project: ezsystems/ezpublish-kernel

Protected Properties

Property Type Description
$descriptions string[] Holds the collection of descriptions with languageCode keys.
$fieldSettings array Holds collection of settings for the field definition supported by the field type.
$names string[] Holds the collection of names with languageCode keys.
$validatorConfiguration mixed Holds validator configuration of this field definition supported by the field type.

Public Methods

Method Description
getDescription ( string $languageCode ) : string This method returns the name of the field in the given language.
getDescriptions ( ) : string[] This method returns the human readable description of the field.
getFieldSettings ( ) : array This method returns settings for the field definition supported by the field type.
getName ( string $languageCode ) : string This method returns the name of the field in the given language.
getNames ( ) : string[] This method returns the human readable name of this field in all provided languages of the content type.
getValidatorConfiguration ( ) : mixed This method returns the validator configuration of this field definition supported by the field type.

Method Details

getDescription() public method

This method returns the name of the field in the given language.
public getDescription ( string $languageCode ) : string
$languageCode string
return string the description for the given language or null if none exists.

getDescriptions() public method

The structure of this field is: array( 'eng' => '', 'de' => '' );
public getDescriptions ( ) : string[]
return string[]

getFieldSettings() public method

This method returns settings for the field definition supported by the field type.
public getFieldSettings ( ) : array
return array

getName() public method

This method returns the name of the field in the given language.
public getName ( string $languageCode ) : string
$languageCode string
return string the name for the given language or null if none exists.

getNames() public method

The structure of the return value is: array( 'eng' => '', 'de' => '' );
public getNames ( ) : string[]
return string[]

getValidatorConfiguration() public method

This method returns the validator configuration of this field definition supported by the field type.
public getValidatorConfiguration ( ) : mixed
return mixed

Property Details

$descriptions protected property

Holds the collection of descriptions with languageCode keys.
protected string[] $descriptions
return string[]

$fieldSettings protected property

Holds collection of settings for the field definition supported by the field type.
protected array $fieldSettings
return array

$names protected property

Holds the collection of names with languageCode keys.
protected string[] $names
return string[]

$validatorConfiguration protected property

Holds validator configuration of this field definition supported by the field type.
protected mixed $validatorConfiguration
return mixed