<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2021 webtrees development team
 * This program 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.
 * This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees;

use Carbon\CarbonImmutable;
use Fisharebest\Webtrees\Contracts\UserInterface;

use function gregoriantojd;

/**
 * A wrapper around CarbonImmutable dates.
 *
 * The future of nesbot/carbon seems uncertain.  We can always swap it out
 * for carbondate/carbon, cake-php/chronos or some other datetime class.
 */
class Carbon extends CarbonImmutable
{
    /**
     * We use julian days extensively, so a helper function to convert.
     */
    public function julianDay(): int
    {
        $local = $this->local();

        return gregoriantojd($local->month, $local->day, $local->year);
    }

    /**
     * Create a local timestamp for the current user.
     *
     * @return Carbon
     */
    public function local(): Carbon
    {
        $timezone = Auth::user()->getPreference(UserInterface::PREF_TIME_ZONE, Site::getPreference('TIMEZONE'));

        // Changing locale does not create a new immutable object.
        $this->locale(I18N::locale()->code());

        return $this->setTimezone($timezone);
    }
}
