Component MVC: The Administrator Side

<?php

/**
 * @package     Tallpine.Administrator
 * @subpackage  com_tallpine
 *
 * @copyright   (C) 2026 Tallpine Hiking Club
 * @license     GNU General Public License version 2 or later
 */

\defined('_JEXEC') or die;

use Joomla\CMS\Categories\CategoryFactoryInterface;
use Joomla\CMS\Component\Router\RouterFactoryInterface;
use Joomla\CMS\Dispatcher\ComponentDispatcherFactoryInterface;
use Joomla\CMS\Extension\ComponentInterface;
use Joomla\CMS\Extension\Service\Provider\CategoryFactory;
use Joomla\CMS\Extension\Service\Provider\ComponentDispatcherFactory;
use Joomla\CMS\Extension\Service\Provider\MVCFactory;
use Joomla\CMS\Extension\Service\Provider\RouterFactory;
use Joomla\CMS\HTML\Registry;
use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;
use Tallpine\Component\Tallpine\Administrator\Extension\TallpineComponent;

return new class () implements ServiceProviderInterface {
    public function register(Container $container): void
    {
        $container->registerServiceProvider(new CategoryFactory('\\Tallpine\\Component\\Tallpine'));
        $container->registerServiceProvider(new MVCFactory('\\Tallpine\\Component\\Tallpine'));
        $container->registerServiceProvider(new ComponentDispatcherFactory('\\Tallpine\\Component\\Tallpine'));
        $container->registerServiceProvider(new RouterFactory('\\Tallpine\\Component\\Tallpine'));

        $container->set(
            ComponentInterface::class,
            function (Container $container) {
                $component = new TallpineComponent($container->get(ComponentDispatcherFactoryInterface::class));

                $component->setRegistry($container->get(Registry::class));
                $component->setMVCFactory($container->get(MVCFactoryInterface::class));
                $component->setCategoryFactory($container->get(CategoryFactoryInterface::class));
                $component->setRouterFactory($container->get(RouterFactoryInterface::class));

                return $component;
            }
        );
    }
};

<?php

namespace Tallpine\Component\Tallpine\Administrator\Extension;

\defined('_JEXEC') or die;

use Joomla\CMS\Categories\CategoryServiceInterface;
use Joomla\CMS\Categories\CategoryServiceTrait;
use Joomla\CMS\Component\Router\RouterServiceInterface;
use Joomla\CMS\Component\Router\RouterServiceTrait;
use Joomla\CMS\Extension\BootableExtensionInterface;
use Joomla\CMS\Extension\MVCComponent;
use Joomla\CMS\HTML\HTMLRegistryAwareTrait;
use Psr\Container\ContainerInterface;

class TallpineComponent extends MVCComponent implements
    BootableExtensionInterface,
    CategoryServiceInterface,
    RouterServiceInterface
{
    use HTMLRegistryAwareTrait;
    use RouterServiceTrait;
    use CategoryServiceTrait;

    public function boot(ContainerInterface $container): void
    {
        // Register services that must exist before the first controller runs,
        // for example an HTML helper: $this->getRegistry()->register('trail', new Trail());
    }

    protected function getTableNameForSection(?string $section = null): string
    {
        return 'tallpine_trails';
    }
}

<?php

namespace Tallpine\Component\Tallpine\Administrator\Controller;

\defined('_JEXEC') or die;

use Joomla\CMS\MVC\Controller\BaseController;

class DisplayController extends BaseController
{
    /**
     * The default view for the display method.
     *
     * @var string
     */
    protected $default_view = 'trails';
}

<?php

namespace Tallpine\Component\Tallpine\Administrator\Controller;

\defined('_JEXEC') or die;

use Joomla\CMS\MVC\Controller\FormController;
use Joomla\Utilities\ArrayHelper;

class TrailController extends FormController
{
    protected $text_prefix = 'COM_TALLPINE_TRAIL';

    /**
     * Records can be created only in categories where the user has "core.create".
     */
    protected function allowAdd($data = [])
    {
        $categoryId = ArrayHelper::getValue($data, 'catid', $this->input->getInt('filter_category_id'), 'int');

        if ($categoryId) {
            return $this->app->getIdentity()->authorise('core.create', $this->option . '.category.' . $categoryId);
        }

        return parent::allowAdd($data);
    }

    /**
     * Editing is decided by the category of the existing record.
     */
    protected function allowEdit($data = [], $key = 'id')
    {
        $recordId = isset($data[$key]) ? (int) $data[$key] : 0;

        if ($recordId) {
            $categoryId = (int) $this->getModel()->getItem($recordId)->catid;

            if ($categoryId) {
                return $this->app->getIdentity()->authorise('core.edit', $this->option . '.category.' . $categoryId)
                    || ($this->app->getIdentity()->authorise('core.edit.own', $this->option . '.category.' . $categoryId)
                        && (int) $this->getModel()->getItem($recordId)->created_by === (int) $this->app->getIdentity()->id);
            }
        }

        return parent::allowEdit($data, $key);
    }
}

<?php

namespace Tallpine\Component\Tallpine\Administrator\Controller;

\defined('_JEXEC') or die;

use Joomla\CMS\MVC\Controller\AdminController;
use Joomla\CMS\MVC\Factory\MVCFactoryInterface;

class TrailsController extends AdminController
{
    protected $text_prefix = 'COM_TALLPINE_TRAILS';

    public function __construct($config = [], ?MVCFactoryInterface $factory = null, $app = null, $input = null)
    {
        parent::__construct($config, $factory, $app, $input);

        // "closed" and "reopened" run the same method; getTask() tells them apart.
        $this->registerTask('reopened', 'closed');
    }

    /**
     * The list controller works on the singular model.
     */
    public function getModel($name = 'Trail', $prefix = 'Administrator', $config = ['ignore_request' => true])
    {
        return parent::getModel($name, $prefix, $config);
    }

    /**
     * Marks the selected trails as seasonally closed or reopens them.
     */
    public function closed(): void
    {
        $this->checkToken();

        $ids   = array_filter((array) $this->input->get('cid', [], 'int'));
        $value = $this->getTask() === 'closed' ? 1 : 0;

        if (empty($ids)) {
            $this->app->enqueueMessage(\Joomla\CMS\Language\Text::_('COM_TALLPINE_NO_TRAILS_SELECTED'), 'warning');
        } else {
            $model = $this->getModel();

            if (!$model->close($ids, $value)) {
                $this->app->enqueueMessage($model->getError(), 'warning');
            } else {
                $this->setMessage(\Joomla\CMS\Language\Text::plural('COM_TALLPINE_N_TRAILS_CLOSED', \count($ids)));
            }
        }

        $this->setRedirect('index.php?option=com_tallpine&view=trails');
    }
}

// Reading state in a model: always give a default, and treat the value as untrusted text.
$search    = (string) $this->getState('filter.search', '');
$published = $this->getState('filter.published', '');
$ordering  = $this->getState('list.ordering', 'a.title');

<?php

namespace Tallpine\Component\Tallpine\Administrator\Model;

\defined('_JEXEC') or die;

use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
use Joomla\CMS\MVC\Model\ListModel;
use Joomla\Database\ParameterType;
use Joomla\Database\QueryInterface;

class TrailsModel extends ListModel
{
    public function __construct($config = [], ?MVCFactoryInterface $factory = null)
    {
        if (empty($config['filter_fields'])) {
            $config['filter_fields'] = [
                'id', 'a.id',
                'title', 'a.title',
                'difficulty', 'a.difficulty',
                'published', 'a.published',
                'access', 'a.access',
                'category_id', 'a.catid', 'category_title',
                'checked_out', 'a.checked_out',
                'ordering', 'a.ordering',
            ];
        }

        parent::__construct($config, $factory);
    }

    protected function populateState($ordering = 'a.title', $direction = 'asc')
    {
        // ListModel reads filter[...] and list[...] from the request and from the user state.
        parent::populateState($ordering, $direction);
    }

    protected function getStoreId($id = '')
    {
        // Every state value that changes the result must be part of the cache key.
        $id .= ':' . $this->getState('filter.search');
        $id .= ':' . $this->getState('filter.published');
        $id .= ':' . $this->getState('filter.difficulty');
        $id .= ':' . $this->getState('filter.category_id');

        return parent::getStoreId($id);
    }

    protected function getListQuery(): QueryInterface
    {
        $db    = $this->getDatabase();
        $query = $db->createQuery();

        $query->select(
            $db->quoteName(
                ['a.id', 'a.title', 'a.alias', 'a.distance_km', 'a.elevation_gain', 'a.difficulty',
                 'a.published', 'a.access', 'a.catid', 'a.checked_out', 'a.checked_out_time', 'a.ordering']
            )
        )
            ->select($db->quoteName('c.title', 'category_title'))
            ->select($db->quoteName('u.name', 'editor'))
            ->from($db->quoteName('#__tallpine_trails', 'a'))
            ->join('LEFT', $db->quoteName('#__categories', 'c'), $db->quoteName('c.id') . ' = ' . $db->quoteName('a.catid'))
            ->join('LEFT', $db->quoteName('#__users', 'u'), $db->quoteName('u.id') . ' = ' . $db->quoteName('a.checked_out'));

        // Published state: "*" shows everything, "" shows published and unpublished.
        $published = (string) $this->getState('filter.published', '');

        if (is_numeric($published)) {
            $state = (int) $published;
            $query->where($db->quoteName('a.published') . ' = :state')->bind(':state', $state, ParameterType::INTEGER);
        } elseif ($published === '') {
            $query->whereIn($db->quoteName('a.published'), [0, 1]);
        }

        // Category filter.
        if ($categoryId = (int) $this->getState('filter.category_id')) {
            $query->where($db->quoteName('a.catid') . ' = :catid')->bind(':catid', $categoryId, ParameterType::INTEGER);
        }

        // Difficulty list filter.
        if ($difficulty = (string) $this->getState('filter.difficulty', '')) {
            $query->where($db->quoteName('a.difficulty') . ' = :difficulty')->bind(':difficulty', $difficulty);
        }

        // Free text: "id:12" finds one trail, anything else searches the title.
        $search = trim((string) $this->getState('filter.search', ''));

        if ($search !== '') {
            if (stripos($search, 'id:') === 0) {
                $id = (int) substr($search, 3);
                $query->where($db->quoteName('a.id') . ' = :id')->bind(':id', $id, ParameterType::INTEGER);
            } else {
                $like = '%' . str_replace(' ', '%', $search) . '%';
                $query->where($db->quoteName('a.title') . ' LIKE :search')->bind(':search', $like);
            }
        }

        // Ordering comes from the whitelisted list[fullordering]; escape() guards the identifier anyway.
        $orderCol  = $this->getState('list.ordering', 'a.title');
        $orderDirn = $this->getState('list.direction', 'ASC');
        $query->order($db->escape($orderCol) . ' ' . $db->escape($orderDirn));

        return $query;
    }
}

<?php

namespace Tallpine\Component\Tallpine\Administrator\Model;

\defined('_JEXEC') or die;

use Joomla\CMS\Factory;
use Joomla\CMS\Form\Form;
use Joomla\CMS\MVC\Model\AdminModel;
use Joomla\CMS\Table\Table;

class TrailModel extends AdminModel
{
    public $typeAlias = 'com_tallpine.trail';

    protected $text_prefix = 'COM_TALLPINE_TRAIL';

    public function getForm($data = [], $loadData = true)
    {
        $form = $this->loadForm('com_tallpine.trail', 'trail', ['control' => 'jform', 'load_data' => $loadData]);

        if (empty($form)) {
            return false;
        }

        // Fields the user may not change are removed from the form AND from the saved data.
        if (!$this->canEditState((object) $data)) {
            $form->setFieldAttribute('published', 'disabled', 'true');
            $form->setFieldAttribute('published', 'filter', 'unset');
        }

        return $form;
    }

    protected function loadFormData()
    {
        // The session holds what the user typed if validation failed on the previous POST.
        $data = Factory::getApplication()->getUserState('com_tallpine.edit.trail.data', []);

        if (empty($data)) {
            $data = $this->getItem();
        }

        $this->preprocessData('com_tallpine.trail', $data);

        return $data;
    }

    public function getTable($name = 'Trail', $prefix = 'Administrator', $options = [])
    {
        return parent::getTable($name, $prefix, $options);
    }

    protected function canDelete($record)
    {
        if (empty($record->id) || (int) $record->published !== -2) {
            return false;
        }

        return $this->getCurrentUser()->authorise('core.delete', 'com_tallpine.category.' . (int) $record->catid);
    }

    protected function canEditState($record)
    {
        $user = $this->getCurrentUser();

        if (!empty($record->catid)) {
            return $user->authorise('core.edit.state', 'com_tallpine.category.' . (int) $record->catid);
        }

        return parent::canEditState($record);
    }

    protected function prepareTable($table)
    {
        $table->title = htmlspecialchars_decode($table->title, ENT_QUOTES);

        if (empty($table->id)) {
            // New trails go to the end of the manual ordering.
            $table->ordering = $this->getDatabase()
                ->setQuery($this->getDatabase()->createQuery()
                    ->select('MAX(' . $this->getDatabase()->quoteName('ordering') . ')')
                    ->from($this->getDatabase()->quoteName('#__tallpine_trails')))
                ->loadResult() + 1;
        }
    }

    /**
     * Marks trails as closed for the season. Used by TrailsController::closed().
     */
    public function close(array &$pks, int $value = 1): bool
    {
        $table = $this->getTable();

        foreach ($pks as $i => $pk) {
            if (!$table->load($pk)) {
                unset($pks[$i]);
                continue;
            }

            if (!$this->canEditState($table)) {
                unset($pks[$i]);
                $this->setError(\Joomla\CMS\Language\Text::_('JLIB_APPLICATION_ERROR_EDITSTATE_NOT_PERMITTED'));
                return false;
            }

            $table->closed = $value;

            if (!$table->store()) {
                $this->setError($table->getError());
                return false;
            }
        }

        return true;
    }
}

<?php

namespace Tallpine\Component\Tallpine\Administrator\View\Trails;

\defined('_JEXEC') or die;

use Joomla\CMS\Helper\ContentHelper;
use Joomla\CMS\Language\Text;
use Joomla\CMS\MVC\View\GenericDataException;
use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
use Joomla\CMS\Toolbar\Toolbar;
use Joomla\CMS\Toolbar\ToolbarHelper;

class HtmlView extends BaseHtmlView
{
    /** @var array */
    protected $items = [];

    /** @var \Joomla\CMS\Pagination\Pagination */
    protected $pagination;

    /** @var \Joomla\CMS\MVC\Model\State|\Joomla\Registry\Registry */
    protected $state;

    /** @var \Joomla\CMS\Form\Form */
    public $filterForm;

    /** @var array */
    public $activeFilters = [];

    public function display($tpl = null): void
    {
        $model = $this->getModel();

        $this->items         = $model->getItems();
        $this->pagination    = $model->getPagination();
        $this->state         = $model->getState();
        $this->filterForm    = $model->getFilterForm();
        $this->activeFilters = $model->getActiveFilters();

        if (\count($errors = $model->getErrors())) {
            throw new GenericDataException(implode("\n", $errors), 500);
        }

        // The searchtools layout needs the "task" and "boxchecked" control fields in the filter form.
        $this->filterForm->addControlField('task')->addControlField('boxchecked', '0');

        $this->addToolbar();

        parent::display($tpl);
    }

    protected function addToolbar(): void
    {
        $canDo   = ContentHelper::getActions('com_tallpine');
        $user    = $this->getCurrentUser();
        $toolbar = $this->getDocument()->getToolbar();

        ToolbarHelper::title(Text::_('COM_TALLPINE_TRAILS_TITLE'), 'map-marked-alt');

        if ($canDo->get('core.create')) {
            $toolbar->addNew('trail.add');
        }

        if ($canDo->get('core.edit.state')) {
            $dropdown = $toolbar->dropdownButton('status-group', 'JTOOLBAR_CHANGE_STATUS')
                ->toggleSplit(false)
                ->icon('icon-ellipsis-h')
                ->buttonClass('btn btn-action')
                ->listCheck(true);

            $childBar = $dropdown->getChildToolbar();
            $childBar->publish('trails.publish')->listCheck(true);
            $childBar->unpublish('trails.unpublish')->listCheck(true);
            $childBar->standardButton('closed', 'COM_TALLPINE_TOOLBAR_CLOSE_SEASON', 'trails.closed')->listCheck(true);
            $childBar->standardButton('reopened', 'COM_TALLPINE_TOOLBAR_REOPEN', 'trails.reopened')->listCheck(true);

            if ($user->authorise('core.admin')) {
                $childBar->checkin('trails.checkin');
            }

            if ($this->state->get('filter.published') != -2) {
                $childBar->trash('trails.trash')->listCheck(true);
            }
        }

        if ($canDo->get('core.delete') && $this->state->get('filter.published') == -2) {
            $toolbar->delete('trails.delete', 'JTOOLBAR_DELETE_FROM_TRASH')
                ->message('JGLOBAL_CONFIRM_DELETE')
                ->listCheck(true);
        }

        if ($user->authorise('core.admin', 'com_tallpine') || $user->authorise('core.options', 'com_tallpine')) {
            $toolbar->preferences('com_tallpine');
        }
    }
}

<?php

\defined('_JEXEC') or die;

use Joomla\CMS\HTML\HTMLHelper;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Layout\LayoutHelper;
use Joomla\CMS\Router\Route;

/** @var \Tallpine\Component\Tallpine\Administrator\View\Trails\HtmlView $this */

/** @var \Joomla\CMS\WebAsset\WebAssetManager $wa */
$wa = $this->getDocument()->getWebAssetManager();
$wa->useScript('table.columns')->useScript('multiselect');

$user      = $this->getCurrentUser();
$listOrder = $this->escape($this->state->get('list.ordering'));
$listDirn  = $this->escape($this->state->get('list.direction'));
?>
<form action="<?php echo Route::_('index.php?option=com_tallpine&view=trails'); ?>" method="post" name="adminForm" id="adminForm">
    <div id="j-main-container" class="j-main-container">
        <?php echo LayoutHelper::render('joomla.searchtools.default', ['view' => $this]); ?>

        <?php if (empty($this->items)) : ?>
            <div class="alert alert-info">
                <span class="icon-info-circle" aria-hidden="true"></span>
                <span class="visually-hidden"><?php echo Text::_('INFO'); ?></span>
                <?php echo Text::_('JGLOBAL_NO_MATCHING_RESULTS'); ?>
            </div>
        <?php else : ?>
            <table class="table" id="trailList">
                <caption class="visually-hidden">
                    <?php echo Text::_('COM_TALLPINE_TRAILS_TABLE_CAPTION'); ?>,
                    <span id="orderedBy"><?php echo Text::_('JGLOBAL_SORTED_BY'); ?> </span>,
                    <span id="filteredBy"><?php echo Text::_('JGLOBAL_FILTERED_BY'); ?></span>
                </caption>
                <thead>
                    <tr>
                        <td class="w-1 text-center"><?php echo HTMLHelper::_('grid.checkall'); ?></td>
                        <th scope="col" class="w-1 text-center"><?php echo HTMLHelper::_('searchtools.sort', 'JSTATUS', 'a.published', $listDirn, $listOrder); ?></th>
                        <th scope="col"><?php echo HTMLHelper::_('searchtools.sort', 'COM_TALLPINE_FIELD_TITLE_LABEL', 'a.title', $listDirn, $listOrder); ?></th>
                        <th scope="col" class="d-none d-md-table-cell"><?php echo HTMLHelper::_('searchtools.sort', 'COM_TALLPINE_FIELD_DIFFICULTY_LABEL', 'a.difficulty', $listDirn, $listOrder); ?></th>
                        <th scope="col" class="w-1 d-none d-md-table-cell"><?php echo HTMLHelper::_('searchtools.sort', 'JGRID_HEADING_ID', 'a.id', $listDirn, $listOrder); ?></th>
                    </tr>
                </thead>
                <tbody>
                    <?php foreach ($this->items as $i => $item) :
                        $canCheckin = $user->authorise('core.manage', 'com_checkin') || $item->checked_out == $user->id || is_null($item->checked_out);
                        $canEdit    = $user->authorise('core.edit', 'com_tallpine.category.' . (int) $item->catid);
                        ?>
                        <tr class="row<?php echo $i % 2; ?>">
                            <td class="text-center"><?php echo HTMLHelper::_('grid.id', $i, $item->id, false, 'cid', 'cb', $item->title); ?></td>
                            <td class="text-center"><?php echo HTMLHelper::_('jgrid.published', $item->published, $i, 'trails.', $canEdit, 'cb'); ?></td>
                            <th scope="row">
                                <?php if ($item->checked_out) : ?>
                                    <?php echo HTMLHelper::_('jgrid.checkedout', $i, $item->editor, $item->checked_out_time, 'trails.', $canCheckin); ?>
                                <?php endif; ?>
                                <?php if ($canEdit) : ?>
                                    <a href="<?php echo Route::_('index.php?option=com_tallpine&task=trail.edit&id=' . (int) $item->id); ?>">
                                        <?php echo $this->escape($item->title); ?>
                                    </a>
                                <?php else : ?>
                                    <?php echo $this->escape($item->title); ?>
                                <?php endif; ?>
                                <div class="small"><?php echo $this->escape($item->category_title); ?></div>
                            </th>
                            <td class="d-none d-md-table-cell"><?php echo $this->escape($item->difficulty); ?></td>
                            <td class="d-none d-md-table-cell"><?php echo (int) $item->id; ?></td>
                        </tr>
                    <?php endforeach; ?>
                </tbody>
            </table>

            <?php echo $this->pagination->getListFooter(); ?>
        <?php endif; ?>

        <input type="hidden" name="task" value="">
        <input type="hidden" name="boxchecked" value="0">
        <?php echo HTMLHelper::_('form.token'); ?>
    </div>
</form>

<?php

namespace Tallpine\Component\Tallpine\Administrator\View\Trail;

\defined('_JEXEC') or die;

use Joomla\CMS\Factory;
use Joomla\CMS\Helper\ContentHelper;
use Joomla\CMS\Language\Text;
use Joomla\CMS\MVC\View\GenericDataException;
use Joomla\CMS\MVC\View\HtmlView as BaseHtmlView;
use Joomla\CMS\Toolbar\Toolbar;
use Joomla\CMS\Toolbar\ToolbarHelper;

class HtmlView extends BaseHtmlView
{
    /** @var \Joomla\CMS\Form\Form */
    protected $form;

    /** @var \stdClass */
    protected $item;

    /** @var \Joomla\CMS\MVC\Model\State|\Joomla\Registry\Registry */
    protected $state;

    public function display($tpl = null): void
    {
        $model = $this->getModel();

        $this->form  = $model->getForm();
        $this->item  = $model->getItem();
        $this->state = $model->getState();

        if (\count($errors = $model->getErrors())) {
            throw new GenericDataException(implode("\n", $errors), 500);
        }

        $this->addToolbar();

        $this->form->addControlField('task');

        parent::display($tpl);
    }

    protected function addToolbar(): void
    {
        // The administrator menu is hidden while a record is being edited.
        Factory::getApplication()->getInput()->set('hidemainmenu', true);

        $user       = $this->getCurrentUser();
        $isNew      = ((int) $this->item->id === 0);
        $checkedOut = !(\is_null($this->item->checked_out) || (int) $this->item->checked_out === (int) $user->id);
        $toolbar    = $this->getDocument()->getToolbar();
        $canDo      = ContentHelper::getActions('com_tallpine', 'category', $this->item->catid);

        ToolbarHelper::title(Text::_($isNew ? 'COM_TALLPINE_TRAIL_NEW' : 'COM_TALLPINE_TRAIL_EDIT'), 'map-marked-alt');

        $canSave = !$checkedOut && ($canDo->get('core.edit') || \count($user->getAuthorisedCategories('com_tallpine', 'core.create')) > 0);

        if ($canSave) {
            $toolbar->apply('trail.apply');
        }

        $toolbar->dropdownButton('save-group')->configure(
            function (Toolbar $childBar) use ($canSave, $canDo, $isNew) {
                if ($canSave) {
                    $childBar->save('trail.save');

                    if ($canDo->get('core.create')) {
                        $childBar->save2new('trail.save2new');
                    }
                }

                if (!$isNew && $canDo->get('core.create')) {
                    $childBar->save2copy('trail.save2copy');
                }
            }
        );

        $toolbar->cancel('trail.cancel', $isNew ? 'JTOOLBAR_CANCEL' : 'JTOOLBAR_CLOSE');
    }
}

<?php

\defined('_JEXEC') or die;

use Joomla\CMS\HTML\HTMLHelper;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Layout\LayoutHelper;
use Joomla\CMS\Router\Route;

/** @var \Tallpine\Component\Tallpine\Administrator\View\Trail\HtmlView $this */

/** @var \Joomla\CMS\WebAsset\WebAssetManager $wa */
$wa = $this->getDocument()->getWebAssetManager();
$wa->useScript('keepalive')->useScript('form.validate');
?>
<form action="<?php echo Route::_('index.php?option=com_tallpine&layout=edit&id=' . (int) $this->item->id); ?>"
      method="post" name="adminForm" id="trail-form" class="form-validate"
      aria-label="<?php echo Text::_('COM_TALLPINE_TRAIL_' . ((int) $this->item->id === 0 ? 'NEW' : 'EDIT'), true); ?>">

    <?php echo LayoutHelper::render('joomla.edit.title_alias', $this); ?>

    <div class="main-card">
        <div class="row">
            <div class="col-lg-9">
                <?php echo $this->form->renderField('catid'); ?>
                <?php echo $this->form->renderField('distance_km'); ?>
                <?php echo $this->form->renderField('elevation_gain'); ?>
                <?php echo $this->form->renderField('difficulty'); ?>
                <?php echo $this->form->renderField('seasons'); ?>
            </div>
            <div class="col-lg-3">
                <?php echo LayoutHelper::render('joomla.edit.global', $this); ?>
            </div>
        </div>
    </div>

    <?php echo $this->form->renderControlFields(); ?>
    <?php echo HTMLHelper::_('form.token'); ?>
</form>

public function sticky(): void
{
    // 1. Authenticate the request.
    $this->checkToken();

    // 2. Read and filter input.
    $ids = array_filter((array) $this->input->get('cid', [], 'int'));

    // 3. Act through the model; the model checks permissions per record.
    if ($ids === []) {
        $this->app->enqueueMessage(Text::_('COM_TALLPINE_NO_TRAILS_SELECTED'), 'warning');
    } elseif (!$this->getModel()->stick($ids, 1)) {
        $this->app->enqueueMessage($this->getModel()->getError(), 'warning');
    } else {
        $this->setMessage(Text::plural('COM_TALLPINE_N_TRAILS_STUCK', \count($ids)));
    }

    // 4. Redirect; never echo a page from a POST task.
    $this->setRedirect(Route::_('index.php?option=com_tallpine&view=trails', false));
}

// Releasing a lock programmatically, for example in an installer script or a CLI command.
$table = $this->getTable('Trail');
$table->load($id);

if ($table->checked_out) {
    $table->checkIn($id);
}