Class

eZ\Publish\API\Repository\Values\ContentType\FieldDefinitionCreateStruct

class FieldDefinitionCreateStruct extends ValueObject

this class is used to create a field definition.

Properties

string $fieldTypeIdentifier String identifier of the field type.
string $identifier Readable string identifier of a field definition.
array $names An array of names with languageCode keys.
array $descriptions An array of descriptions with languageCode keys.
string $fieldGroup Field group name.
int $position The position of the field definition in the content type if not set the field is added at the end.
bool $isTranslatable Indicates if the field is translatable.
bool $isRequired Indicates if the field is required.
bool $isInfoCollector Indicates if this attribute is used for information collection.
mixed $validatorConfiguration The validator configuration supported by the field type.
mixed $fieldSettings The settings supported by the field type.
mixed $defaultValue Default value of the field.
bool $isSearchable Indicates if th the content is searchable by this attribute.

Methods

__construct(array $properties = array())

Construct object optionally with a set of properties.

from ValueObject
__set(string $property, string $value)

Magic set function handling writes to non public properties.

from ValueObject
mixed __get(string $property)

Magic get function handling read to non public properties.

from ValueObject
bool __isset(string $property)

Magic isset function handling isset() to non public properties.

from ValueObject
bool __unset(string $property)

Magic unset function handling unset() to non public properties.

from ValueObject
static ValueObject __set_state(array $array)

Returns a new instance of this class with the data specified by $array.

from ValueObject
mixed attribute(string $property)

Internal function for Legacy template engine compatibility to get property value.

from ValueObject
array attributes()

Internal function for Legacy template engine compatibility to get properties.

from ValueObject
bool hasAttribute(string $property)

Internal function for Legacy template engine compatibility to check existence of property.

from ValueObject

Details

in ValueObject at line 32
public __construct(array $properties = array())

Construct object optionally with a set of properties.

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

array $properties

in ValueObject at line 75
public __set(string $property, string $value)

Magic set function handling writes to non public properties.

Parameters

string $property Name of the property
string $value

Exceptions

PropertyNotFoundException When property does not exist
PropertyReadOnlyException When property is readonly (protected)

in ValueObject at line 96
public mixed __get(string $property)

Magic get function handling read to non public properties.

Returns value for all readonly (protected) properties.

Parameters

string $property Name of the property

Return Value

mixed

Exceptions

PropertyNotFoundException exception on all reads to undefined properties so typos are not silently accepted.

in ValueObject at line 115
public bool __isset(string $property)

Magic isset function handling isset() to non public properties.

Returns true for all (public/)protected/private properties.

Parameters

string $property Name of the property

Return Value

bool

in ValueObject at line 134
public bool __unset(string $property)

Magic unset function handling unset() to non public properties.

Parameters

string $property Name of the property

Return Value

bool

Exceptions

PropertyNotFoundException exception on all writes to undefined properties so typos are not silently accepted and
PropertyReadOnlyException exception on readonly (protected) properties.

in ValueObject at line 155
static public ValueObject __set_state(array $array)

Returns a new instance of this class with the data specified by $array.

$array contains all the data members of this class in the form: array('member_name'=>value).

__setstate makes this class exportable with varexport. var_export() generates code, that calls this method when it is parsed with PHP.

Parameters

array $array

Return Value

ValueObject

in ValueObject at line 173
final public mixed attribute(string $property)

Internal function for Legacy template engine compatibility to get property value.

Parameters

string $property

Return Value

mixed

in ValueObject at line 189
final public array attributes()

Internal function for Legacy template engine compatibility to get properties.

Return Value

array

in ValueObject at line 207
final public bool hasAttribute(string $property)

Internal function for Legacy template engine compatibility to check existence of property.

Parameters

string $property

Return Value

bool