-
Notifications
You must be signed in to change notification settings - Fork 453
/
Rule.php
140 lines (125 loc) · 3.11 KB
/
Rule.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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?php
namespace Concrete\Core\Service\Rule;
/**
* A single rule for the web server.
*/
class Rule implements RuleInterface, ConfigurableRuleInterface
{
/**
* The code of the rule.
*
* @var string|callable
*/
protected $code;
/**
* Is this rule enabled (should be present in the configuration) or disabled (should not be present in the configuration)?
*
* @var bool|callable
*/
protected $enabled;
/**
* Optional comments to be placed before the rule itself.
*
* @var string
*/
protected $commentsBefore;
/**
* Optional comments to be placed after the rule itself.
*
* @var string
*/
protected $commentsAfter;
/**
* The rule options.
*
* @var Option[]
*/
protected $options;
/**
* Intializes the instance.
*
* @param string|callable $code The code of the rule.
* @param bool|callable $enabled Is this rule enabled (should be present in the configuration) or disabled (should not be present in the configuration)?
* @param string $commentsBefore Optional comments to be placed before the rule itself.
* @param string $commentsAfter Optional comments to be placed after the rule itself.
*/
public function __construct($code, $enabled, $commentsBefore = '', $commentsAfter = '')
{
$this->code = $code;
$this->enabled = $enabled;
$this->commentsBefore = (string) $commentsBefore;
$this->commentsAfter = (string) $commentsAfter;
$this->options = array();
}
/**
* {@inheritdoc}
*
* @see RuleInterface::getCode()
*/
public function getCode()
{
$result = $this->code;
if (is_callable($result)) {
$result = $result($this);
}
return (string) $result;
}
/**
* {@inheritdoc}
*
* @see RuleInterface::isEnabled()
*/
public function isEnabled()
{
$result = $this->enabled;
if (is_callable($result)) {
$result = $result($this);
}
return (bool) $result;
}
/**
* {@inheritdoc}
*
* @see RuleInterface::getCommentsBefore()
*/
public function getCommentsBefore()
{
return $this->commentsBefore;
}
/**
* {@inheritdoc}
*
* @see RuleInterface::getCommentsAfter()
*/
public function getCommentsAfter()
{
return $this->commentsAfter;
}
/**
* {@inheritdoc}
*
* @see \Concrete\Core\Service\Rule\ConfigurableRuleInterface::addOption()
*/
public function addOption($handle, Option $option)
{
$this->options[$handle] = $option;
}
/**
* {@inheritdoc}
*
* @see \Concrete\Core\Service\Rule\RuleInterface::getOptions()
*/
public function getOptions()
{
return $this->options;
}
/**
* {@inheritdoc}
*
* @see \Concrete\Core\Service\Rule\ConfigurableRuleInterface::getOption()
*/
public function getOption($handle)
{
return isset($this->options[$handle]) ? $this->options[$handle] : null;
}
}