ContentZoneCol
extends KeyValueCollection
in package
implements
ContentGeneratorInterface, JsonSerializable, PersistableContentInterface, UpdatableContentZoneContentInterface
Uses
ContentZoneNormalizeTrait
Class ContentZoneCol
Interfaces, Classes and Traits
- ContentGeneratorInterface
- Interface ContentGeneratorInterface
- JsonSerializable
- PersistableContentInterface
- Class PersistableContentInterface
- UpdatableContentZoneContentInterface
- Class UpdatableContentZoneContentInterface
Table of Contents
- $background : BackgroundGroupOption
- $border : BorderGroupOption
- $collectionContentArray : array<string|int, mixed>
- Content Collection
- $cssClass : string
- $cssGenerator : CssGenerator|null
- $cssId : string
- $jsonObject : stdClass|null
- $responsive : ResponsiveGroupOption
- __construct() : mixed
- ContentZoneCol constructor.
- count() : int
- Get collection item count.
- createFromJsonObject() : ContentGeneratorInterface
- cssClass() : string
- getArray() : array<string|int, mixed>
- Get the collection as an array.
- getItem() : mixed
- Get specific collection item by index.
- getIterator() : Traversable
- getValue() : mixed
- Get the value that corresponds to the provided key.
- htmlContent() : string
- isEmpty() : bool
- Determine whether the collection is empty or not.
- jsonSerialize() : mixed
- Specify data which should be serialized to JSON
- keyExists() : bool
- Check if a given key exists within the collection.
- persist() : void
- previewContent() : string
- setCssClass() : void
- update() : void
- _add() : mixed
- Add a new item.
- _addToCollectionContentArray() : mixed
- Add the passed key value array to the collection content array.
- _getExceptionText() : string
- Get exception text.
- _getValidType() : string
- Get valid type.
- _itemIsValid() : bool
- Check if a new item has the valid collection type.
- setType() : stdClass
Properties
$background
protected
BackgroundGroupOption
$background
$border
protected
BorderGroupOption
$border
$collectionContentArray
Content Collection
protected
array<string|int, mixed>
$collectionContentArray
= []
$cssClass
protected
string
$cssClass
$cssGenerator
protected
CssGenerator|null
$cssGenerator
$cssId
protected
string
$cssId
$jsonObject
protected
stdClass|null
$jsonObject
$responsive
protected
ResponsiveGroupOption
$responsive
Methods
__construct()
ContentZoneCol constructor.
public
__construct(array<string|int, mixed> $keyValueArray, ResponsiveGroupOption $responsive, BackgroundGroupOption $background, BorderGroupOption $border, TextBox $cssId, TextBox $cssClass, stdClass|null $jsonObject[, CssGenerator|null $cssGenerator = null ]) : mixed
Parameters
- $keyValueArray : array<string|int, mixed>
- $responsive : ResponsiveGroupOption
- $background : BackgroundGroupOption
- $border : BorderGroupOption
- $cssId : TextBox
- $cssClass : TextBox
- $jsonObject : stdClass|null
- $cssGenerator : CssGenerator|null = null
Return values
mixed —count()
Get collection item count.
public
count() : int
Return values
int —createFromJsonObject()
public
static createFromJsonObject(stdClass $jsonObject) : ContentGeneratorInterface
Parameters
- $jsonObject : stdClass
Tags
Return values
ContentGeneratorInterface —cssClass()
public
cssClass() : string
Return values
string —getArray()
Get the collection as an array.
public
getArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —getItem()
Get specific collection item by index.
public
getItem( $p_index) : mixed
Parameters
Tags
Return values
mixed —getIterator()
public
getIterator() : Traversable
Return values
Traversable —getValue()
Get the value that corresponds to the provided key.
public
getValue(string $p_keyName) : mixed
Parameters
- $p_keyName : string
Tags
Return values
mixed —htmlContent()
public
htmlContent(Language|null $currentLanguage) : string
Parameters
- $currentLanguage : Language|null
Return values
string —html content of all widgets inside group
isEmpty()
Determine whether the collection is empty or not.
public
isEmpty() : bool
Return values
bool —jsonSerialize()
Specify data which should be serialized to JSON
public
jsonSerialize() : mixed
Tags
Return values
mixed —data which can be serialized by json_encode, which is a value of any type other than a resource.
keyExists()
Check if a given key exists within the collection.
public
keyExists(string $p_keyName) : bool
Parameters
- $p_keyName : string
Return values
bool —persist()
public
persist() : void
Return values
void —previewContent()
public
previewContent(Language|null $currentLanguage) : string
Parameters
- $currentLanguage : Language|null
Return values
string —setCssClass()
public
setCssClass(string $cssClass) : void
Parameters
- $cssClass : string
Tags
Return values
void —update()
public
update() : void
Return values
void —_add()
Add a new item.
protected
_add(mixed $item) : mixed
This method must be used by child-collection classes.
Parameters
- $item : mixed
-
Item which should add to the collection
Tags
Return values
mixed —_addToCollectionContentArray()
Add the passed key value array to the collection content array.
protected
_addToCollectionContentArray(array<string|int, mixed> $keyValueArray) : mixed
Parameters
- $keyValueArray : array<string|int, mixed>
Return values
mixed —_getExceptionText()
Get exception text.
protected
_getExceptionText() : string
Return values
string —_getValidType()
Get valid type.
protected
abstract _getValidType() : string
This method must be implemented in the child-collection classes.
Return values
string —_itemIsValid()
Check if a new item has the valid collection type.
protected
_itemIsValid(mixed $dataItem) : bool
Parameters
- $dataItem : mixed
Return values
bool —setType()
protected
static setType(stdClass $object, string $type) : stdClass
Parameters
- $object : stdClass
- $type : string