class ConfigGroup extends DataModel

Config group holds several configItems and settings

Properties

protected array $fields from DataModel
protected boolean $isEncrypted from DataModel
protected Identity $id
protected string $comment
protected string $imagePath
protected integer $maximumSelection
protected integer $minimumSelection
protected integer $sort
protected integer $type
protected ConfigGroupI18n[] $i18ns

Methods

__construct()

Constructor

multitype:
getProperties()

Get the Model Properties

from Model
setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

from DataModel
stdClass
getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

from DataModel
toJson()

No description

from Model
mixed:string
getFields()

Fields Getter

from DataModel
validate()

Object Validation

from DataModel
mixed:string|NULL
getField(boolean $toWawi = false, string $key)

Get a Model Member Name

from DataModel
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

from DataModel
getModelType()

No description

from DataModel
boolean
isEncrypted()

Encrypted Status

from DataModel
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

No description

from DataModel
setProperty($name, $value, $type)

No description

from DataModel
validateType($value, $type)

No description

from DataModel
setId(Identity $id)

No description

getId()

No description

setComment(string $comment)

No description

string
getComment()

No description

setImagePath(string $imagePath)

No description

string
getImagePath()

No description

setMaximumSelection(integer $maximumSelection)

No description

integer
getMaximumSelection()

No description

setMinimumSelection(integer $minimumSelection)

No description

integer
getMinimumSelection()

No description

setSort(integer $sort)

No description

integer
getSort()

No description

setType(integer $type)

No description

integer
getType()

No description

addI18n(ConfigGroupI18n $i18n)

No description

setI18ns(array $i18ns)

No description

getI18ns()

No description

clearI18ns()

No description

Details

at line 91
__construct()

Constructor

in Model at line 33
multitype: getProperties()

Get the Model Properties

Return Value

multitype: string

in DataModel at line 172
Model setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

Parameters

stdClass $object
array $options

Return Value

Model

in DataModel at line 70
stdClass getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

Parameters

array $publics

Return Value

stdClass $object

in Model at line 115
toJson()

in DataModel at line 35
mixed:string getFields()

Fields Getter

Return Value

mixed:string

in DataModel at line 45
validate()

Object Validation

Exceptions

SchemaException

in DataModel at line 59
mixed:string|NULL getField(boolean $toWawi = false, string $key)

Get a Model Member Name

Parameters

boolean $toWawi
string $key

Return Value

mixed:string|NULL

in DataModel at line 81
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

Parameters

boolean $toWawi
stdClass $obj Object to map

in DataModel at line 42
DataType getModelType()

Return Value

DataType

in DataModel at line 59
boolean isEncrypted()

Encrypted Status

Return Value

boolean

in DataModel at line 123
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

Parameters

string $propertyName
string|null $endpoint
int|null $host

in DataModel at line 179
protected setProperty($name, $value, $type)

Parameters

$name
$value
$type

in DataModel at line 190
protected validateType($value, $type)

Parameters

$value
$type

at line 101
ConfigGroup setId(Identity $id)

Parameters

Identity $id Unique configGroup id

Return Value

ConfigGroup

Exceptions

InvalidArgumentException if the provided argument is not of type 'Identity'.

at line 109
Identity getId()

Return Value

Identity Unique configGroup id

at line 118
ConfigGroup setComment(string $comment)

Parameters

string $comment Optional internal comment to differantiate config groups by comment name

Return Value

ConfigGroup

at line 126
string getComment()

Return Value

string Optional internal comment to differantiate config groups by comment name

at line 135
ConfigGroup setImagePath(string $imagePath)

Parameters

string $imagePath

Return Value

ConfigGroup

at line 143
string getImagePath()

Return Value

string

at line 152
ConfigGroup setMaximumSelection(integer $maximumSelection)

Parameters

integer $maximumSelection Optional maximum number allowed selections. Default 0 for no maximum limitation.

Return Value

ConfigGroup

at line 160
integer getMaximumSelection()

Return Value

integer Optional maximum number allowed selections. Default 0 for no maximum limitation.

at line 169
ConfigGroup setMinimumSelection(integer $minimumSelection)

Parameters

integer $minimumSelection Optional minimum number required selections. Default 0 for no minimum requirement.

Return Value

ConfigGroup

at line 177
integer getMinimumSelection()

Return Value

integer Optional minimum number required selections. Default 0 for no minimum requirement.

at line 186
ConfigGroup setSort(integer $sort)

Parameters

integer $sort Optional sort order number

Return Value

ConfigGroup

at line 194
integer getSort()

Return Value

integer Optional sort order number

at line 203
ConfigGroup setType(integer $type)

Parameters

integer $type Config group item type. 0: Checkbox, 1:Radio, 2, Dropdown, 3: Multiselect

Return Value

ConfigGroup

at line 211
integer getType()

Return Value

integer Config group item type. 0: Checkbox, 1:Radio, 2, Dropdown, 3: Multiselect

at line 220
ConfigGroup addI18n(ConfigGroupI18n $i18n)

Parameters

ConfigGroupI18n $i18n

Return Value

ConfigGroup

at line 230
ConfigGroup setI18ns(array $i18ns)

Parameters

array $i18ns

Return Value

ConfigGroup

at line 239
ConfigGroupI18n[] getI18ns()

Return Value

ConfigGroupI18n[]

at line 247
ConfigGroup clearI18ns()

Return Value

ConfigGroup