<?php

namespace EasyRdf\Literal;

use DateTimeInterface;

/*
 * EasyRdf
 *
 * LICENSE
 *
 * Copyright (c) 2009-2014 Nicholas J Humfrey.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. The name of the author 'Nicholas J Humfrey" 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 OWNER 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.
 *
 * @package    EasyRdf
 * @copyright  Copyright (c) 2009-2014 Nicholas J Humfrey
 * @license    https://www.opensource.org/licenses/bsd-license.php
 */

/**
 * Class that represents an RDF Literal of datatype xsd:dateTime
 *
 * @see       http://www.w3.org/TR/xmlschema-2/#date
 *
 * @copyright  Copyright (c) 2009-2014 Nicholas J Humfrey
 * @license    https://www.opensource.org/licenses/bsd-license.php
 */
class DateTime extends Date
{
    /** Constructor for creating a new date and time literal
     *
     * If the value is a DateTimeInterface object, then it will be converted to the xsd:dateTime format.
     * If no value is given or is is null, then the current time is used.
     *
     * @see \DateTime
     *
     * @param mixed  $value    The value of the literal
     * @param string $lang     Should be null (literals with a datatype can't have a language)
     * @param string $datatype Optional datatype (default 'xsd:dateTime')
     */
    public function __construct($value = null, $lang = null, $datatype = null)
    {
        /**
         * workaround to avoid PHPStan error:
         * Constructor of class EasyRdf\Literal\DateTime has an unused parameter $lang.
         */
        $lang = null;

        // If $value is null, use 'now'
        if (null === $value) {
            $value = new \DateTime('now');
        }

        // workaround for PHP < 7.2: if not used, script will throw "Undefined class constant 'ATOM'"
        if (\defined('\DateTimeInterface::ATOM')) {
            $format = \DateTimeInterface::ATOM;
        } else {
            $format = \DateTime::ATOM;
        }

        // Convert DateTime objects into string
        if ($value instanceof \DateTimeInterface) {
            $atom = $value->format($format);
            $value = preg_replace('/[\+\-]00(\:?)00$/', 'Z', $atom);
        }

        parent::__construct($value, $lang, $datatype);
    }

    /** Parses a string using DateTime and creates a new literal
     *
     * Example:
     *   $dt = EasyRdf\Literal\DateTime::parse('Mon 18 Jul 2011 18:45:43 BST');
     *
     * @see DateTime
     *
     * @param string $value The date and time to parse
     *
     * @return self
     */
    public static function parse($value)
    {
        $value = new \DateTime($value);

        return new self($value);
    }

    /** 24-hour format of the hour as an integer
     *
     * @return int
     */
    public function hour()
    {
        return (int) $this->format('H');
    }

    /** The minutes pasts the hour as an integer
     *
     * @return int
     */
    public function min()
    {
        return (int) $this->format('i');
    }

    /** The seconds pasts the minute as an integer
     *
     * @return int
     */
    public function sec()
    {
        return (int) $this->format('s');
    }
}
