blob: f6168805a2d812b93ab673247dfaceaffca0c97c (
plain)
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<?php
namespace ipl\Web\Control\SearchBar;
use ipl\Stdlib\Data;
abstract class ValidatedTerm
{
/** @var string The default validation constraint */
const DEFAULT_PATTERN = '^\s*(?!%s\b).*\s*$';
/** @var string The search value */
protected $searchValue;
/** @var ?string The label */
protected $label;
/** @var ?string The validation message */
protected $message;
/** @var ?string The validation constraint */
protected $pattern;
/** @var bool Whether the term has been adjusted */
protected $changed = false;
/**
* Create a new ValidatedTerm
*
* @param string $searchValue The search value
* @param ?string $label The label
*/
public function __construct(string $searchValue, ?string $label = null)
{
$this->searchValue = $searchValue;
$this->label = $label;
}
/**
* Create a new ValidatedTerm from the given data
*
* @param array $data
*
* @return static
*/
public static function fromTermData(array $data)
{
return new static($data['search'], isset($data['label']) ? $data['label'] : null);
}
/**
* Check whether the term is valid
*
* @return bool
*/
public function isValid()
{
return $this->message === null;
}
/**
* Check whether the term has been adjusted
*
* @return bool
*/
public function hasBeenChanged()
{
return $this->changed;
}
/**
* Get the search value
*
* @return string
*/
public function getSearchValue(): string
{
return $this->searchValue;
}
/**
* Set the search value
*
* @param string $searchValue
*
* @return $this
*/
public function setSearchValue(string $searchValue): self
{
$this->searchValue = $searchValue;
$this->changed = true;
return $this;
}
/**
* Get the label
*
* @return string
*/
public function getLabel(): ?string
{
return $this->label;
}
/**
* Set the label
*
* @param ?string $label
*
* @return $this
*/
public function setLabel(?string $label): self
{
$this->label = $label;
$this->changed = true;
return $this;
}
/**
* Get the validation message
*
* @return ?string
*/
public function getMessage(): ?string
{
return $this->message;
}
/**
* Set the validation message
*
* @param string $message
*
* @return $this
*/
public function setMessage(string $message): self
{
$this->message = $message;
return $this;
}
/**
* Get the validation constraint
*
* Returns the default constraint if none is set.
*
* @return string
*/
public function getPattern(): ?string
{
if ($this->message === null) {
return null;
}
return $this->pattern ?? sprintf(self::DEFAULT_PATTERN, $this->getLabel() ?: $this->getSearchValue());
}
/**
* Set the validation constraint
*
* @param string $pattern
*
* @return $this
*/
public function setPattern(string $pattern): self
{
$this->pattern = $pattern;
return $this;
}
/**
* Get this term's data
*
* @return array
*/
public function toTermData()
{
return [
'search' => $this->getSearchValue(),
'label' => $this->getLabel() ?: $this->getSearchValue(),
'invalidMsg' => $this->getMessage(),
'pattern' => $this->getPattern()
];
}
/**
* Get this term's metadata
*
* @return Data
*/
abstract public function toMetaData();
}
|
