<?php
/**
 * iCalcreator, the PHP class package managing iCal (rfc2445/rfc5445) calendar information.
 *
 * This file is a part of iCalcreator.
 *
 * @author    Kjell-Inge Gustafsson, kigkonsult <ical@kigkonsult.se>
 * @copyright 2007-2024 Kjell-Inge Gustafsson, kigkonsult AB, All rights reserved
 * @link      https://kigkonsult.se
 * @license   Subject matter of licence is the software iCalcreator.
 *            The above copyright, link, package and version notices,
 *            this licence notice and the invariant [rfc5545] PRODID result use
 *            as implemented and invoked in iCalcreator shall be included in
 *            all copies or substantial portions of the iCalcreator.
 *
 *            iCalcreator is free software: you can redistribute it and/or modify
 *            it under the terms of the GNU Lesser General Public License as
 *            published by the Free Software Foundation, either version 3 of
 *            the License, or (at your option) any later version.
 *
 *            iCalcreator 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 Lesser General Public License for more details.
 *
 *            You should have received a copy of the GNU Lesser General Public License
 *            along with iCalcreator. If not, see <https://www.gnu.org/licenses/>.
 */
declare( strict_types = 1 );
namespace Kigkonsult\Icalcreator\Traits;

use DateTime;
use DateTimeInterface;
use Exception;
use InvalidArgumentException;
use Kigkonsult\Icalcreator\Formatter\Property\DtxProperty;
use Kigkonsult\Icalcreator\Pc;
use Kigkonsult\Icalcreator\Util\DateTimeFactory;

/**
 * TZUNTIL property functions
 *
 * @since 2.41.85 2024-01-18
 */
trait TZUNTILrfc7808trait
{
    /**
     * @var null|Pc component property TZUNTIL value
     */
    protected ? Pc $tzuntil = null;

    /**
     * Return formatted output for calendar component property TZUNTIL
     *
     * @return string
     * @throws Exception
     * @throws InvalidArgumentException
     * @since 2.41.55 - 2022-08-13
     */
    public function createTzuntil() : string
    {
        return  DtxProperty::format(
            self::TZUNTIL,
            $this->tzuntil,
            $this->getConfig( self::ALLOWEMPTY )
        );
    }

    /**
     * Delete calendar component property TZUNTIL
     *
     * @return bool
     * @since 2.41.1 2022-01-15
     */
    public function deleteTzuntil() : bool
    {
        $this->tzuntil = null;
        return true;
    }

    /**
     * Return calendar component property TZUNTIL
     *
     * @param null|bool   $inclParam
     * @return bool|string|DateTime|Pc
     * @since 2.41.85 2024-01-18
     */
    public function getTzuntil( ? bool $inclParam = false ) : DateTime | bool | string | Pc
    {
        if( empty( $this->tzuntil )) {
            return false;
        }
        return $inclParam ? clone $this->tzuntil : $this->tzuntil->getValue();
    }

    /**
     * Return bool true if set (and ignore empty property)
     *
     * @return bool
     * @since 2.41.88 2024-01-19
     */
    public function isTzuntilSet() : bool
    {
        return self::isPropSet( $this->tzuntil );
    }

    /**
     * Set calendar component property TZUNTIL, datetime UTC
     *
     * @param null|string|Pc|DateTimeInterface  $value
     * @param null|mixed[] $params
     * @return static
     * @throws Exception
     * @throws InvalidArgumentException
     * @since 2.41.85 2024-01-18
     */
    public function setTzuntil(
        null | string | Pc | DateTimeInterface $value = null,
        ? array $params = []
    ) : static
    {
        $pc      = Pc::factory( $value, $params );
        $pcValue = $pc->getValue();
        if( empty( $pcValue )) {
            $this->assertEmptyValue( $pcValue, self::TZUNTIL );
            $this->tzuntil = $pc->setEmpty();
        }
        else {
            $pc->addParamValue( self::DATE_TIME ); // req
            $this->tzuntil = DateTimeFactory::setDate( $pc, true ); // force UTC
        }
        return $this;
    }
}