<?php
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM - Open Source CRM application.
 * Copyright (C) 2014-2023 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
 * Website: https://www.espocrm.com
 *
 * EspoCRM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * EspoCRM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

namespace Espo\Core\Select\Order;

use Espo\Core\Select\SearchParams;

use InvalidArgumentException;

/**
 * @immutable
 */
class Item
{
    private string $orderBy;
    /** @var SearchParams::ORDER_ASC|SearchParams::ORDER_DESC */
    private string $order;

    /**
     * @param SearchParams::ORDER_ASC|SearchParams::ORDER_DESC $order
     */
    private function __construct(string $orderBy, string $order)
    {
        if (
            $order !== SearchParams::ORDER_ASC &&
            $order !== SearchParams::ORDER_DESC
        ) {
            throw new InvalidArgumentException("Bad order.");
        }

        $this->orderBy = $orderBy;
        $this->order = $order;
    }

    /**
     * @param SearchParams::ORDER_ASC|SearchParams::ORDER_DESC|null $order
     */
    public static function create(string $orderBy, ?string $order = null): self
    {
        if ($order === null) {
            $order = SearchParams::ORDER_ASC;
        }

        return new self($orderBy, $order);
    }

    /**
     * Get a field.
     */
    public function getOrderBy(): string
    {
        return $this->orderBy;
    }

    /**
     * Get a direction.
     *
     * @return SearchParams::ORDER_ASC|SearchParams::ORDER_DESC
     */
    public function getOrder(): string
    {
        return $this->order;
    }
}
