DateTimeParser.php

DateTimeParser.php

@@ -0,0 +1,45 @@
<?php

namespace Charcoal\Model\Service;

use DateTime;
use DateTimeInterface;
use Exception;
use InvalidArgumentException;

/**
 * Ensure a value is a DateTime (or null).
 */
class DateTimeParser
{
    /**
     * Ensure a variable is a proper DateTime (Interface). Also allows null value.
     *
     * @param DateTimeInterface|string|null $ts The timestamp value (datetime object, null or timestamp string) to parse.
     * @throws InvalidArgumentException If the string parameter is an invalid time string, or the parameter is an invalid type.
     * @return DateTimeInterface|null
     */
    public function parse($ts)
    {
        if ($ts === null) {
            return null;
        }

        if (is_string($ts)) {
            try {
                $ts = new DateTime($ts);
            } catch (Exception $e) {
                throw new InvalidArgumentException(
                    sprintf('Caould not parse date-time string: "%s"'),
                    $e->getMessage()
                );
            }
        }

        if (!($ts instanceof DateTimeInterface)) {
            throw new InvalidArgumentException(
                'Can not parse date-time. Must be a date-time object, null or a timestamp string.'
            );
        }

        return $ts;
    }
}