-
Notifications
You must be signed in to change notification settings - Fork 0
/
SmallText.php
261 lines (241 loc) · 6.18 KB
/
SmallText.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
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<?php
namespace Alpha\Model\Type;
use Alpha\Util\Helper\Validator;
use Alpha\Exception\IllegalArguementException;
/**
* The SmallText complex data type.
*
* @since 1.0
*
* @author John Collins <dev@alphaframework.org>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*/
class SmallText extends Type implements TypeInterface
{
/**
* The value of the string.
*
* @var string
*
* @since 1.0
*/
private $value;
/**
* The validation rule for the string type.
*
* @var string
*
* @since 1.0
*/
private $validationRule;
/**
* The error message for the string type when validation fails.
*
* @var string
*
* @since 1.0
*/
protected $helper = 'Not a valid smalltext value!';
/**
* The size of the value for the this String.
*
* @var int
*
* @since 1.0
*/
private $size = 255;
/**
* The absolute maximum size of the value for the this String.
*
* @var int
*
* @since 1.0
*/
const MAX_SIZE = 255;
/**
* Simple boolean to determine if the string is a password or not.
*
* @var bool
*
* @since 1.0
*/
private $password = false;
/**
* Constructor.
*
* @param string $val
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function __construct($val = '')
{
$this->validationRule = Validator::ALLOW_ALL;
if (mb_strlen($val) <= $this->size) {
if (preg_match($this->validationRule, $val)) {
$this->value = $val;
} else {
throw new IllegalArguementException($this->helper);
}
} else {
throw new IllegalArguementException($this->helper);
}
}
/**
* Setter for the value.
*
* @param string $val
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function setValue($val)
{
if (mb_strlen($val) <= $this->size) {
if (preg_match($this->validationRule, $val)) {
$this->value = $val;
} else {
throw new IllegalArguementException($this->helper);
}
} else {
throw new IllegalArguementException($this->helper);
}
}
/**
* Getter for the value.
*
* @return string
*
* @since 1.0
*/
public function getValue()
{
return $this->value;
}
/**
* Setter to override the default validation rule.
*
* @param string $rule
*
* @since 1.0
*/
public function setRule($rule)
{
$this->validationRule = $rule;
}
/**
* Get the validation rule.
*
* @return string
*
* @since 1.0
*/
public function getRule()
{
return $this->validationRule;
}
/**
* Used to set the allowable size of the String in the database field.
*
* @param int $size
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function setSize($size)
{
if ($size <= self::MAX_SIZE) {
$this->size = $size;
} else {
throw new IllegalArguementException('Error: the value '.$size.' provided by setSize is greater than the MAX_SIZE '.self::MAX_SIZE.' of this data type.');
}
}
/**
* Get the allowable size of the Double in the database field.
*
* @return int
*
* @since 1.0
*/
public function getSize()
{
return $this->size;
}
/**
* Sets up an appropriate validation rule for a required field.
*
* @param bool $req
*
* @since 1.0
*/
public function isRequired($req = true)
{
if ($req) {
$this->validationRule = Validator::REQUIRED_STRING;
$this->helper = 'This smalltext requires a value!';
}
}
/**
* Define the string as a password (making it required by validation rule).
*
* @param bool $pass
*
* @since 1.0
*/
public function isPassword($pass = true)
{
$this->password = $pass;
if ($pass) {
$this->validationRule = '/\w+/';
$this->helper = 'Password is required!';
}
}
/**
* Checks to see if the string is a password or not.
*
* @return bool
*
* @since 1.0
*/
public function checkIsPassword()
{
return $this->password;
}
}