DateTime.php

<?php
/**
 * @link https://craftcms.com/
 * @copyright Copyright (c) Pixel & Tonic, Inc.
 * @license https://craftcms.github.io/license/
 */

namespace craft\gql\types;

use craft\errors\GqlException;
use craft\gql\base\SingularTypeInterface;
use craft\gql\directives\FormatDateTime;
use craft\gql\GqlEntityRegistry;
use craft\helpers\DateTimeHelper;
use craft\helpers\Json;
use GraphQL\Language\AST\StringValueNode;
use GraphQL\Type\Definition\ScalarType;

/**
 * Class DateTime implements the Datetime scalar type for GraphQL.
 *
 * @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
 * @since 3.3.0
 */
class DateTime extends ScalarType implements SingularTypeInterface
{
    /**
     * @var string
     */
    public $name = 'DateTime';

    /**
     * @var string
     */
    public $description = 'The `DateTime` scalar type represents a point in time.';

    /**
     * @var bool Whether parsed dates should be set to the system time zone
     * @since 4.5.11
     */
    public bool $setToSystemTimeZone = true;

    /**
     * Returns a singleton instance to ensure one type per schema.
     *
     * @return DateTime
     */
    public static function getType(): DateTime
    {
        return GqlEntityRegistry::getOrCreate(self::getName(), fn() => new self());
    }

    /**
     * @return string
     */
    public static function getName(): string
    {
        return 'DateTime';
    }

    /**
     * @inheritdoc
     */
    public function serialize($value)
    {
        // The value not being a datetime would indicate an already formatted date.
        if ($value instanceof \DateTime) {
            $value = $value->format(FormatDateTime::DEFAULT_FORMAT);
        }

        return $value;
    }

    /**
     * @inheritdoc
     */
    public function parseValue($value)
    {
        if (is_string($value)) {
            return DateTimeHelper::toDateTime(
                Json::decodeIfJson($value),
                setToSystemTimeZone: $this->setToSystemTimeZone,
            );
        }

        // This message will be lost by the wrapping exception, but it feels good to provide one.
        throw new GqlException('DateTime must be a string.');
    }

    /**
     * @inheritdoc
     */
    public function parseLiteral($valueNode, ?array $variables = null)
    {
        if ($valueNode instanceof StringValueNode) {
            return DateTimeHelper::toDateTime(
                Json::decodeIfJson($valueNode->value),
                setToSystemTimeZone: $this->setToSystemTimeZone,
            );
        }

        // This message will be lost by the wrapping exception, but it feels good to provide one.
        throw new GqlException('DateTime must be a string.');
    }
}