File Model/Type/Timestamp.php | Alpha Framework 3.0.0 API Documentation

  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 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652

<?php

namespace Alpha\Model\Type;

use Alpha\Util\Helper\Validator;
use Alpha\Exception\IllegalArguementException;
use Alpha\Util\Config\ConfigProvider;

/**
 * The Timestamp 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 Timestamp 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 hour part.
     *
     * @var string
     *
     * @since 1.0
     */
    private $hour;

    /**
     * The minute part.
     *
     * @var string
     *
     * @since 1.0
     */
    private $minute;

    /**
     * The second part.
     *
     * @var string
     *
     * @since 1.0
     */
    private $second;

    /**
     * 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 timestamp value!  A timestamp should be in the format YYYY-MM-DD HH:MM:SS.';

    /**
     * Constructor.
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\IllegalArguementException
     */
    public function __construct($timestamp = '')
    {
        $config = ConfigProvider::getInstance();

        $this->validationRule = Validator::ALLOW_ALL;

        if (empty($timestamp)) {
            if ($config->get('app.default.datetime') == 'now') {
                $this->year = date('Y');
                $this->month = date('m');
                $this->day = date('d');
                $this->weekday = date('l');
                $this->hour = date('H');
                $this->minute = date('i');
                $this->second = date('s');
            } else {
                $this->year = '0000';
                $this->month = '00';
                $this->day = '00';
                $this->hour = '00';
                $this->minute = '00';
                $this->second = '00';
            }
        } else {
            if (preg_match($this->validationRule, $timestamp)) {
                $this->populateFromString($timestamp);
            } else {
                throw new IllegalArguementException($this->helper);
            }
        }
    }

    /**
     * Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format.
     *
     * @param string $dateTime
     *
     * @since 1.0
     */
    public function setValue($dateTime)
    {
        $this->populateFromString($dateTime);
    }

    /**
     * Setter for the timestamp value.
     *
     * @param int $year
     * @param int $month
     * @param int $day
     * @param int $hour
     * @param int $minute
     * @param int $second
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\IllegalArguementException
     */
    public function setTimestampValue($year, $month, $day, $hour, $minute, $second)
    {
        $valid = null;

        if (!preg_match('/^[0-9]{4}$/', $year)) {
            $valid = 'The year value '.$year.' provided is invalid!';
        }
        if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $month)) {
            $valid = 'The month value '.$month.' provided is invalid!';
        }
        if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $day)) {
            $valid = 'The day value '.$day.' provided is invalid!';
        }
        if (!isset($valid) && !checkdate($month, $day, $year)) {
            $valid = 'The day value '.$year.'-'.$month.'-'.$day.' provided is invalid!';
        }
        if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $hour) || !($hour >= 0 && $hour < 24)) {
            $valid = 'The hour value '.$hour.' provided is invalid!';
        }
        if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $minute) || !($minute >= 0 && $minute < 60)) {
            $valid = 'The minute value '.$minute.' provided is invalid!';
        }
        if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $second) || !($second >= 0 && $second < 60)) {
            $valid = 'The second value '.$second.' 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);
            $this->hour = str_pad($hour, 2, '0', STR_PAD_LEFT);
            $this->minute = str_pad($minute, 2, '0', STR_PAD_LEFT);
            $this->second = str_pad($second, 2, '0', STR_PAD_LEFT);
            $unixTime = mktime($this->hour, $this->minute, $this->second, $this->month, $this->day, $this->year);
            $this->weekday = date('l', $unixTime);
        }
    }

    /**
     * Getter for the Timestamp value.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getValue()
    {
        return $this->year.'-'.$this->month.'-'.$this->day.' '.$this->hour.':'.$this->minute.':'.$this->second;
    }

    /**
     * Return the value in UNIX timestamp format.
     *
     * @return int
     *
     * @since 1.0
     */
    public function getUnixValue()
    {
        return mktime($this->hour, $this->minute, $this->second, $this->month, $this->day, $this->year);
    }

    /**
     * Getter for the date part.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getDate()
    {
        return $this->year.'-'.$this->month.'-'.$this->day;
    }

    /**
     * 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);
    }

    /**
     * Setter for the date part.
     *
     * @param int $year
     * @param int $month
     * @param int $day
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\IllegalArguementException
     */
    public function setDate($year, $month, $day)
    {
        $valid = null;

        if (!preg_match('/^[0-9]{4}$/', $year)) {
            $valid = 'The year value '.$year.' provided is invalid!';
        }
        if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $month)) {
            $valid = 'The month value '.$month.' provided is invalid!';
        }
        if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $day)) {
            $valid = 'The day value '.$day.' provided is invalid!';
        }
        if (!isset($valid) && !checkdate($month, $day, $year)) {
            $valid = '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);
        }
    }

    /**
     * Getter for the time part.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getTime()
    {
        return $this->hour.':'.$this->minute.':'.$this->second;
    }

    /**
     * Getter for the year part.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getYear()
    {
        return $this->year;
    }

    /**
     * Getter for the month part.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getMonth()
    {
        return $this->month;
    }

    /**
     * Getter for 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;
    }

    /**
     * Getter for the hour part.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getHour()
    {
        return $this->hour;
    }

    /**
     * Getter for the minute part.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getMinute()
    {
        return $this->minute;
    }

    /**
     * Getter for the second part.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getSecond()
    {
        return $this->second;
    }

    /**
     * Setter for the time part.
     *
     * @param int $hour
     * @param int $minute
     * @param int $second
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\IllegalArguementException
     */
    public function setTime($hour, $minute, $second)
    {
        $valid = null;

        if (!isset($valid) && !preg_match('/^[0-9]{2}$/', $hour) || !($hour >= 0 && $hour < 24)) {
            $valid = 'The hour value '.$hour.' provided is invalid!';
        }
        if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $minute) || !($minute >= 0 && $minute < 60)) {
            $valid = 'The minute value '.$minute.' provided is invalid!';
        }
        if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $second) || !($second >= 0 && $second < 60)) {
            $valid = 'The second value '.$second.' provided is invalid!';
        }

        if (isset($valid)) {
            throw new IllegalArguementException($valid);
        } else {
            $this->hour = str_pad($hour, 2, '0', STR_PAD_LEFT);
            $this->minute = str_pad($minute, 2, '0', STR_PAD_LEFT);
            $this->second = str_pad($second, 2, '0', STR_PAD_LEFT);
        }
    }

    /**
     * Accepts a full date/time string in YYYY-mm-dd hh:ii:ss format.
     *
     * @param string $dateTime
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\IllegalArguementException
     */
    public function populateFromString($dateTime)
    {
        $valid = null;

        if ($dateTime == 'Please select' || $dateTime == '0000-00-00 00:00:00') {
            $this->year = '0000';
            $this->month = '00';
            $this->day = '00';
            $this->hour = '00';
            $this->minute = '00';
            $this->second = '00';
        } else {
            $spilt_by_space = explode(' ', $dateTime);

            if (isset($spilt_by_space[0])) {
                $date = $spilt_by_space[0];
            } else {
                throw new IllegalArguementException($this->helper);
            }

            if (isset($spilt_by_space[1])) {
                $time = $spilt_by_space[1];
            } else {
                throw new IllegalArguementException($this->helper);
            }

            $split_by_dash = explode('-', $date);

            if (isset($split_by_dash[0])) {
                $year = $split_by_dash[0];
            } else {
                throw new IllegalArguementException($this->helper);
            }

            if (isset($split_by_dash[1])) {
                $month = $split_by_dash[1];
            } else {
                throw new IllegalArguementException($this->helper);
            }

            if (isset($split_by_dash[2])) {
                $day = $split_by_dash[2];
            } else {
                throw new IllegalArguementException($this->helper);
            }

            $split_by_colon = explode(':', $time);

            if (isset($split_by_colon[0])) {
                $hour = $split_by_colon[0];
            } else {
                throw new IllegalArguementException($this->helper);
            }

            if (isset($split_by_colon[1])) {
                $minute = $split_by_colon[1];
            } else {
                throw new IllegalArguementException($this->helper);
            }

            if (isset($split_by_colon[2])) {
                $second = $split_by_colon[2];
            } else {
                throw new IllegalArguementException($this->helper);
            }

            if (!preg_match('/^[0-9]{4}$/', $year)) {
                $valid = 'The year value '.$year.' provided is invalid!';
            }
            if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $month)) {
                $valid = 'The month value '.$month.' provided is invalid!';
            }
            if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $day)) {
                $valid = 'The day value '.$day.' provided is invalid!';
            }
            if (!isset($valid) && !checkdate($month, $day, $year)) {
                $valid = 'The day value '.$year.'/'.$month.'/'.$day.' provided is invalid!';
            }
            if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $hour) || !($hour >= 0 && $hour < 24)) {
                $valid = 'The hour value '.$hour.' provided is invalid!';
            }
            if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $minute) || !($minute >= 0 && $minute < 60)) {
                $valid = 'The minute value '.$minute.' provided is invalid!';
            }
            if (!isset($valid) && !preg_match('/^[0-9]{1,2}$/', $second) || !($second >= 0 && $second < 60)) {
                $valid = 'The second value '.$second.' 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);
                $this->hour = str_pad($hour, 2, '0', STR_PAD_LEFT);
                $this->minute = str_pad($minute, 2, '0', STR_PAD_LEFT);
                $this->second = str_pad($second, 2, '0', STR_PAD_LEFT);
                $unixTime = mktime($this->hour, $this->minute, $this->second, $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;
    }

    /**
     * Get the validation helper text.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getHelper()
    {
        return $this->helper;
    }

    /**
     * Set the validation helper text.
     *
     * @param string $helper
     *
     * @since 1.0
     */
    public function setHelper($helper)
    {
        $this->helper = $helper;
    }

    /**
     * Returns the difference between now and this timestamp value, in a human-readable format, e.g: 3 days ago, 3 days from now.
     *
     * @return string
     *
     * @since 1.2.4
     */
    public function getTimeAway()
    {
        $periods = array('second', 'minute', 'hour', 'day', 'week', 'month', 'year', 'decade');
        $lengths = array('60', '60', '24', '7', '4.35', '12', '10');

        $now = time();
        $unixTS = $this->getUnixValue();

        if ($now > $unixTS) {
            $difference = $now-$unixTS;
            $tense = 'ago';
        } else {
            $difference = $unixTS-$now;
            $tense = 'from now';
        }

        for ($i = 0; $difference >= $lengths[$i] && $i < count($lengths)-1; ++$i) {
            $difference = round($difference/$lengths[$i]);
        }

        $difference = round($difference);

        if ($difference != 1) {
            $periods[$i] .= 's';
        }

        return $difference.' '.$periods[$i].' '.$tense;
    }
}

Namespaces

Classes

Interfaces

Exceptions