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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 <?php
namespace Alpha\Model\Type;
use Alpha\Util\Helper\Validator;
use Alpha\Exception\IllegalArguementException;
use Alpha\Util\Config\ConfigProvider;
/**
* The Date 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 Date extends Type implements TypeInterface
{
/**
* The year part.
*
* @var string
*
* @since 1.0
*/
private $year;
/**
* The month part.
*
* @var string
*
* @since 1.0
*/
private $month;
/**
* The day part.
*
* @var string
*
* @since 1.0
*/
private $day;
/**
* The textual version of the day, e.g. Monday.
*
* @var string
*
* @since 1.0
*/
private $weekday;
/**
* The validation rule (reg-ex) applied to Date values.
*
* @var string
*
* @since 1.0
*/
private $validationRule;
/**
* The error message returned for invalid values.
*
* @var string
*
* @since 1.0
*/
protected $helper = 'Not a valid date value! A date should be in the ISO format YYYY-MM-DD.';
/**
* Constructor. Leave $date param empty to default to now.
*
* @param string $date Date string in the ISO format YYYY-MM-DD.
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function __construct($date = '')
{
$config = ConfigProvider::getInstance();
$this->validationRule = Validator::ALLOW_ALL;
if (empty($date)) {
if ($config->get('app.default.datetime') == 'now') {
$this->year = date('Y');
$this->month = date('m');
$this->day = date('d');
$this->weekday = date('l');
} else {
$this->year = '0000';
$this->month = '00';
$this->day = '00';
}
} else {
if (preg_match($this->validationRule, $date)) {
$this->populateFromString($date);
} else {
throw new IllegalArguementException($this->helper);
}
}
}
/**
* Accepts a full date string in ISO YYYY-mm-dd format and populates relevent Date attributes.
*
* @param string $date
*
* @since 1.0
*
* @throws \Alpha\Exception\IllegalArguementException
*/
public function setValue($date)
{
$this->populateFromString($date);
}
/**
* Set the Date attributes to match the three values provided.
*
* @param int $year
* @param int $month
* @param int $day
*
* @throws \Alpha\Exception\IllegalArguementException
*
* @since 1.0
*/
public function setDateValue($year, $month, $day)
{
$valid = null;
if (!preg_match('/^[0-9]{4}$/', $year)) {
$valid = 'Error: the year value '.$year.' provided is invalid!';
}
if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $month)) {
$valid = 'Error: the month value '.$month.' provided is invalid!';
}
if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $day)) {
$valid = 'Error: the day value '.$day.' provided is invalid!';
}
if (!isset($valid) && !checkdate($month, $day, $year)) {
$valid = 'Error: the day value '.$year.'-'.$month.'-'.$day.' provided is invalid!';
}
if (isset($valid)) {
throw new IllegalArguementException($valid);
} else {
$this->year = $year;
$this->month = str_pad($month, 2, '0', STR_PAD_LEFT);
$this->day = str_pad($day, 2, '0', STR_PAD_LEFT);
$unixTime = mktime(0, 0, 0, $this->month, $this->day, $this->year);
$this->weekday = date('l', $unixTime);
}
}
/**
* Get the date value as a string in the format "YYYY-MM-DD".
*
* @return string
*
* @since 1.0
*/
public function getValue()
{
return $this->year.'-'.$this->month.'-'.$this->day;
}
/**
* Return the value in UNIX timestamp format.
*
* @return int
*
* @since 1.0
*/
public function getUnixValue()
{
return mktime(0, 0, 0, $this->month, $this->day, $this->year);
}
/**
* Get the date value as a string in the format "DD/MM/YYYY".
*
* @return string
*
* @since 1.0
*/
public function getEuroValue()
{
return $this->day.'/'.$this->month.'/'.mb_substr($this->year, 2, 2);
}
/**
* Get the date value as a string in the format "MM/DD/YYYY".
*
* @return string
*
* @since 1.0
*/
public function getUSValue()
{
return $this->month.'/'.$this->day.'/'.mb_substr($this->year, 2, 2);
}
/**
* Get the year part.
*
* @return string
*
* @since 1.0
*/
public function getYear()
{
return $this->year;
}
/**
* Get the month part.
*
* @return string
*
* @since 1.0
*/
public function getMonth()
{
return $this->month;
}
/**
* Get the day part.
*
* @return string
*
* @since 1.0
*/
public function getDay()
{
return $this->day;
}
/**
* Get the textual weekday part, e.g. Monday.
*
* @return string
*
* @since 1.0
*/
public function getWeekday()
{
return $this->weekday;
}
/**
* Accepts a full date string in YYYY-MM-DD format and populates relevent Date attributes.
*
* @param string $date
*
* @throws \Alpha\Exception\IllegalArguementException
*
* @since 1.0
*/
public function populateFromString($date)
{
$valid = null;
if ($date == '' || $date == '0000-00-00') {
$this->year = '0000';
$this->month = '00';
$this->day = '00';
} else {
// This is just here for legacy to ensure that any old time value from a Date object is ignored
$spilt_by_space = explode(' ', $date);
if (isset($spilt_by_space[0])) {
$date = $spilt_by_space[0];
} else {
throw new IllegalArguementException('Invalid Date value ['.$date.'] provided!');
}
$split_by_dash = explode('-', $date);
// Parse for the date parts, seperated by "-"
if (isset($split_by_dash[0]) && isset($split_by_dash[1]) && isset($split_by_dash[2])) {
$year = $split_by_dash[0];
$month = $split_by_dash[1];
$day = $split_by_dash[2];
} else {
throw new IllegalArguementException('Invalid Date value ['.$date.'] provided!');
}
if (!preg_match('/^[0-9]{4}$/', $year)) {
$valid = 'Error: the year value '.$year.' provided is invalid!';
}
if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $month)) {
$valid = 'Error: the month value '.$month.' provided is invalid!';
}
if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $day)) {
$valid = 'Error: the day value '.$day.' provided is invalid!';
}
if (!isset($valid) && !checkdate($month, $day, $year)) {
$valid = 'Error: the date value '.$year.'-'.$month.'-'.$day.' provided is invalid!';
}
if (isset($valid)) {
throw new IllegalArguementException($valid);
} else {
$this->year = $year;
$this->month = str_pad($month, 2, '0', STR_PAD_LEFT);
$this->day = str_pad($day, 2, '0', STR_PAD_LEFT);
$unixTime = mktime(0, 0, 0, $this->month, $this->day, $this->year);
$this->weekday = date('l', $unixTime);
}
}
}
/**
* Get the validation rule.
*
* @return string
*
* @since 1.0
*/
public function getRule()
{
return $this->validationRule;
}
/**
* Set the validation rule.
*
* @param string $rule
*
* @since 1.0
*/
public function setRule($rule)
{
$this->validationRule = $rule;
}
}