Class

eZ\Publish\API\Repository\Values\ContentType\FieldDefinitionUpdateStruct

class FieldDefinitionUpdateStruct extends ValueObject

this class is used to update a field definition.

Properties

string $identifier If set the identifier of a field definition is changed to this value.
array $names If set this array of names with languageCode keys replace the complete name collection.
array $descriptions If set this array of descriptions with languageCode keys replace the complete description collection.
string $fieldGroup If set the field group is changed to this name.
int $position If set the position of the field in the content type.
bool $isTranslatable If set translatable flag is set to this value.
bool $isRequired If set the required flag is set to this value.
bool $isInfoCollector If set the information collector flag is set to this value.
mixed $validatorConfiguration If set this validator configuration supported by the field type replaces the existing one.
mixed $fieldSettings If set this settings supported by the field type replaces the existing ones.
mixed $defaultValue If set the default value for this field is changed to the given value.
bool $isSearchable If set the the searchable flag is set to this value.

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