ILIAS
trunk Revision v11.0_alpha-3011-gc6b235a2e85
◀ ilDoc Overview
ComponentEntryDescription.php
Go to the documentation of this file.
1
<?php
2
19
declare(strict_types=1);
20
21
namespace
ILIAS\UI\Implementation\Crawler\Entry
;
22
23
use JsonSerializable;
24
31
class
ComponentEntryDescription
extends
AbstractEntryPart
implements JsonSerializable
32
{
33
protected
array
$description
= array(
34
"purpose"
=>
""
,
35
"composition"
=>
""
,
36
"effect"
=>
""
,
37
"rivals"
=> array()
38
);
39
40
public
function
__construct
(array
$description
= array())
41
{
42
parent::__construct
();
43
$this->
setDescription
($description);
44
}
45
46
public
function
withDescription
(array
$description
= array()):
ComponentEntryDescription
47
{
48
$clone = clone $this;
49
$clone->
setDescription
(
$description
);
50
return
$clone;
51
}
52
53
protected
function
setDescription
(array $descriptionElements): void
54
{
55
if
(!$descriptionElements) {
56
return
;
57
}
58
$this->
assert
()->isArray($descriptionElements);
59
foreach
($descriptionElements as $category => $element) {
60
$this->
assert
()->isIndex($category, $this->description);
61
62
if
(is_array($this->description[$category])) {
63
if
($element && $element !=
""
) {
64
$this->
assert
()->isArray($element);
65
foreach
($element as $key => $part) {
66
$this->
assert
()->isString($part);
67
$this->description[$category][$key] = $part;
68
}
69
}
70
}
else
{
71
$this->
assert
()->isString($element);
72
$this->description[$category] = $element;
73
}
74
}
75
}
76
81
public
function
getProperty
($key)
82
{
83
$this->
assert
()->isIndex($key, $this->description);
84
85
return
$this->description[$key];
86
}
87
88
public
function
getDescription
(): array
89
{
90
return
$this->description
;
91
}
92
93
public
function
jsonSerialize
(): array
94
{
95
return
$this->
getDescription
();
96
}
97
}
ILIAS\UI\Implementation\Crawler\Entry\AbstractEntryPart
Abstract Entry Part to share some common entry functionality.
Definition:
AbstractEntryPart.php:31
ILIAS\UI\Implementation\Crawler\Entry\AbstractEntryPart\assert
assert()
Definition:
AbstractEntryPart.php:39
ILIAS\UI\Implementation\Crawler\Entry\ComponentEntryDescription
Container to hold description of UI Components.
Definition:
ComponentEntryDescription.php:32
ILIAS\UI\Implementation\Crawler\Entry\ComponentEntryDescription\$description
array $description
Definition:
ComponentEntryDescription.php:33
ILIAS\UI\Implementation\Crawler\Entry\ComponentEntryDescription\getDescription
getDescription()
Definition:
ComponentEntryDescription.php:88
ILIAS\UI\Implementation\Crawler\Entry\ComponentEntryDescription\withDescription
withDescription(array $description=array())
Definition:
ComponentEntryDescription.php:46
ILIAS\UI\Implementation\Crawler\Entry\ComponentEntryDescription\__construct
__construct(array $description=array())
Definition:
ComponentEntryDescription.php:40
ILIAS\UI\Implementation\Crawler\Entry\ComponentEntryDescription\jsonSerialize
jsonSerialize()
Definition:
ComponentEntryDescription.php:93
ILIAS\UI\Implementation\Crawler\Entry\ComponentEntryDescription\getProperty
getProperty($key)
Definition:
ComponentEntryDescription.php:81
ILIAS\UI\Implementation\Crawler\Entry\ComponentEntryDescription\setDescription
setDescription(array $descriptionElements)
Definition:
ComponentEntryDescription.php:53
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition:
PluginProviderHelper.php:38
ILIAS\UI\Implementation\Crawler\Entry
Definition:
AbstractEntryPart.php:21
components
ILIAS
UI
src
Implementation
Crawler
Entry
ComponentEntryDescription.php
Generated on Sat Oct 18 2025 23:04:41 for ILIAS by
1.9.4 (using
Doxyfile
)