class ArrayField extends BaseField

ArrayField class.

Constants

VALID_ITEM_TYPES

VALID_LINK_TYPES

Properties

protected string $id ID of the Field. from BaseField
protected string $name Name of the Field. from BaseField
protected bool $required Describes whether the Field is mandatory. from BaseField
protected bool $localized Describes whether the Field is localized. from BaseField
protected bool $disabled Describes whether the Field is disabled. from BaseField
protected bool $omitted True if the field is omitted from CDA responses. from BaseField
protected ValidationInterface[] $validations from BaseField

Methods

__construct(string $id, string $name, string $itemsType, string $itemsLinkType = null)

ArrayField constructor.

getId()

No description

from BaseField
getName()

No description

from BaseField
setName(string $name)

No description

from BaseField
isRequired()

No description

from BaseField
setRequired(bool $required)

No description

from BaseField
isLocalized()

No description

from BaseField
setLocalized(bool $localized)

No description

from BaseField
isDisabled()

No description

from BaseField
setDisabled(bool $disabled)

No description

from BaseField
isOmitted()

No description

from BaseField
setOmitted(bool $omitted)

No description

from BaseField
getValidations()

No description

from BaseField
setValidations(array $validations)

No description

from BaseField
addValidation(ValidationInterface $validation)

No description

from BaseField
jsonSerialize()

{@inheritdoc}

getType()

No description

getItemsType()

No description

setItemsType(string $itemsType)

No description

string|null
getItemsLinkType()

No description

setItemsLinkType(string $itemsLinkType = null)

No description

setItemsValidations(array $itemsValidations)

No description

addItemsValidation(ValidationInterface $validation)

No description

Details

at line 61
__construct(string $id, string $name, string $itemsType, string $itemsLinkType = null)

ArrayField constructor.

Parameters

string $id
string $name
string $itemsType
string $itemsLinkType

in BaseField at line 79
getId()

in BaseField at line 84
getName()

in BaseField at line 92
FieldInterface setName(string $name)

Parameters

string $name

Return Value

FieldInterface

in BaseField at line 99
isRequired()

in BaseField at line 107
FieldInterface setRequired(bool $required)

Parameters

bool $required

Return Value

FieldInterface

in BaseField at line 114
isLocalized()

in BaseField at line 122
FieldInterface setLocalized(bool $localized)

Parameters

bool $localized

Return Value

FieldInterface

in BaseField at line 129
isDisabled()

in BaseField at line 137
FieldInterface setDisabled(bool $disabled)

Parameters

bool $disabled

Return Value

FieldInterface

in BaseField at line 144
isOmitted()

in BaseField at line 152
FieldInterface setOmitted(bool $omitted)

Parameters

bool $omitted

Return Value

FieldInterface

in BaseField at line 162
ValidationInterface[] getValidations()

Return Value

ValidationInterface[]

in BaseField at line 172
FieldInterface setValidations(array $validations)

Parameters

array $validations

Return Value

FieldInterface

in BaseField at line 184
FieldInterface addValidation(ValidationInterface $validation)

Parameters

ValidationInterface $validation

Return Value

FieldInterface

at line 170
jsonSerialize()

{@inheritdoc}

at line 69
getType()

at line 74
getItemsType()

at line 84
ArrayField setItemsType(string $itemsType)

Parameters

string $itemsType

Return Value

ArrayField

Exceptions

InvalidArgumentException

at line 98
string|null getItemsLinkType()

Return Value

string|null

at line 108
ArrayField setItemsLinkType(string $itemsLinkType = null)

Parameters

string $itemsLinkType

Return Value

ArrayField

Exceptions

InvalidArgumentException

at line 122
ValidationInterface[] getItemsValidations()

Return Value

ValidationInterface[]

at line 132
ArrayField setItemsValidations(array $itemsValidations)

Parameters

array $itemsValidations

Return Value

ArrayField

at line 146
ArrayField addItemsValidation(ValidationInterface $validation)

Parameters

ValidationInterface $validation

Return Value

ArrayField

Exceptions

InvalidArgumentException