xref: /webtrees/app/Module/ModuleSidebarTrait.php (revision c1afbf581bf7b7d1bdf2abeff71d3e725bd407f3)

<?php
/**
 * webtrees: online genealogy
 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace Fisharebest\Webtrees\Module;

/**
 * Trait ModuleSidebarTrait - default implementation of ModuleSidebarInterface
 */
trait ModuleSidebarTrait
{
    /** @var int The default position for this sidebar.  It can be changed in the control panel. */
    protected $sidebar_order = 0;

    /**
     * Users change change the order of sidebars using the control panel.
     *
     * @param int $sidebar_order
     *
     * @return void
     */
    public function setSidebarOrder(int $sidebar_order): void
    {
        $this->sidebar_order = $sidebar_order;
    }

    /**
     * Users change change the order of sidebars using the control panel.
     *
     * @return int
     */
    public function getSidebarOrder(): int
    {
        return $this->sidebar_order ?: $this->defaultSidebarOrder();
    }


    /**
     * The default position for this sdiebar.
     *
     * @return int
     */
    public function defaultSidebarOrder(): int
    {
        return 9999;
    }
}