PHP Class eZ\Publish\Core\REST\Client\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[] Contains the human readable description of the field.
$fieldSettings array Contains settings for the field definition supported by the field type.
$names string[] Contains the human readable name of this field in all provided languages of the content type.
$validators eZ\Publish\Core\FieldType\Validator[] Contains the validators of this field definition supported by the field type#.

Public Methods

Method Description
__construct ( array $data = [] )
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 ( ) : Validator[] This method returns the validators of this field definition supported by the field type.

Method Details

__construct() public method

public __construct ( array $data = [] )
$data array

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 validators of this field definition supported by the field type.
public getValidatorConfiguration ( ) : Validator[]
return eZ\Publish\Core\FieldType\Validator[]

Property Details

$descriptions protected property

Contains the human readable description of the field.
protected string[] $descriptions
return string[]

$fieldSettings protected property

Contains settings for the field definition supported by the field type.
protected array $fieldSettings
return array

$names protected property

Contains the human readable name of this field in all provided languages of the content type.
protected string[] $names
return string[]

$validators protected property

Contains the validators of this field definition supported by the field type#.
protected Validator[],eZ\Publish\Core\FieldType $validators
return eZ\Publish\Core\FieldType\Validator[]