<?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 Kigkonsult\Icalcreator\Formatter\Property\IntProperty;
use Kigkonsult\Icalcreator\Pc;
use Kigkonsult\Icalcreator\Util\StringFactory;
use Kigkonsult\Icalcreator\Util\Util;

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

    /**
     * Return formatted output for calendar component property sequence
     *
     * @return string
     */
    public function createSequence() : string
    {
        return IntProperty::format(
            self::SEQUENCE,
            $this->sequence,
            $this->getConfig( self::ALLOWEMPTY )
        );
    }

    /**
     * Delete calendar component property sequence
     *
     * @return bool
     * @since  2.27.1 - 2018-12-15
     */
    public function deleteSequence() : bool
    {
        $this->sequence = null;
        return true;
    }

    /**
     * Get calendar component property sequence
     *
     * @param null|bool   $inclParam
     * @return bool|int|string|Pc
     * @since 2.41.85 2024-01-18
     */
    public function getSequence( ? bool $inclParam = false ) : bool | int | string | Pc
    {
        if( null === $this->sequence ) {
            return false;
        }
        return $inclParam ? clone $this->sequence : $this->sequence->getValue();
    }

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

    /**
     * Set calendar component property sequence
     *
     * When a calendar component is created, its sequence number is 0.
     * It is monotonically incremented by the "SingleProps2's" CUA
     * each time the "SingleProps2" makes a significant revision to the calendar component.
     * Init 0 (zero)
     *
     * @param null|int|string|Pc $value
     * @param null|mixed[] $params
     * @return static
     * @since 2.41.85 2024-01-18
     */
    public function setSequence( null|int|string|Pc $value = null, ? array $params = [] ) : static
    {
        $pc      = Pc::factory( $value, $params );
        $pcValue = $pc->getValue() ?: null;
        if(( null === $pcValue ) || ( StringFactory::$SP0 === $pcValue )) {
            $prev = $this->isSequenceSet() ? (int) $this->getSequence() : -1;
            $pc->setValue(( -1 < $prev ) ? $prev + 1 : 0 );
        }
        else {
            Util::assertInteger( $pcValue, self::SEQUENCE, 0 );
            $pc->setValue((int) $pcValue );
        }
        $this->sequence = $pc;
        return $this;
    }
}