-
Notifications
You must be signed in to change notification settings - Fork 611
/
ConfigurableComponent.php
85 lines (74 loc) · 2.39 KB
/
ConfigurableComponent.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<?php
/**
* @link https://craftcms.com/
* @copyright Copyright (c) Pixel & Tonic, Inc.
* @license https://craftcms.github.io/license/
*/
namespace craft\base;
use BackedEnum;
use craft\events\DefineValueEvent;
use craft\helpers\DateTimeHelper;
use DateTime;
use ReflectionClass;
use ReflectionProperty;
/**
* Component is the base class for classes representing Craft components that are configurable.
*
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
* @since 3.5.0
*/
abstract class ConfigurableComponent extends Component implements ConfigurableComponentInterface
{
/**
* @event DefineValueEvent The event that is triggered when defining the component’s settings attributes, as returned by [[settingsAttributes()]].
* @since 3.7.0
*/
public const EVENT_DEFINE_SETTINGS_ATTRIBUTES = 'defineSettingsAttributes';
/**
* @inheritdoc
*/
public function settingsAttributes(): array
{
// By default, include all public, non-static properties that were not defined in an abstract class
$class = new ReflectionClass($this);
$names = [];
foreach ($class->getProperties(ReflectionProperty::IS_PUBLIC) as $property) {
if (!$property->isStatic() && !$property->getDeclaringClass()->isAbstract()) {
$names[] = $property->getName();
}
}
if ($this->hasEventHandlers(self::EVENT_DEFINE_SETTINGS_ATTRIBUTES)) {
$event = new DefineValueEvent([
'value' => $names,
]);
$this->trigger(self::EVENT_DEFINE_SETTINGS_ATTRIBUTES, $event);
$names = $event->value;
}
return $names;
}
/**
* @inheritdoc
*/
public function getSettings(): array
{
$settings = [];
$datetimeAttributes = array_flip($this->datetimeAttributes());
foreach ($this->settingsAttributes() as $attribute) {
$value = $this->$attribute;
if ($value instanceof DateTime || isset($datetimeAttributes[$attribute])) {
$value = DateTimeHelper::toIso8601($value) ?: null;
} elseif ($value instanceof BackedEnum) {
$value = $value->value;
}
$settings[$attribute] = $value;
}
return $settings;
}
/**
* @inheritdoc
*/
public function getSettingsHtml(): ?string
{
return null;
}
}