api/components/com_menus/src/View/Items/JsonapiView.php - 5.4-dev - githubmirror/joomla-cms

api/components/com_menus/src/View/Items/JsonapiView.php
209 строк6 KB
Denitz
Min and max usage (#41646)
12 сен 2023, 20:56
12 сен 2023, 20:56151587e
<?php

/**
 * @package     Joomla.API
 * @subpackage  com_menus
 *
 * @copyright   (C) 2019 Open Source Matters, Inc. <https://www.joomla.org>
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\Component\Menus\Api\View\Items;

use Joomla\CMS\Language\Text;
use Joomla\CMS\MVC\View\JsonApiView as BaseApiView;
use Joomla\CMS\Serializer\JoomlaSerializer;
use Joomla\CMS\Uri\Uri;
use Tobscure\JsonApi\Collection;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * The items view
 *
 * @since  4.0.0
 */
class JsonapiView extends BaseApiView
{
    /**
     * The fields to render item in the documents
     *
     * @var  array
     * @since  4.0.0
     */
    protected $fieldsToRenderItem = [
        'id',
        'parent_id',
        'level',
        'lft',
        'rgt',
        'alias',
        'typeAlias',
        'menutype',
        'title',
        'note',
        'path',
        'link',
        'type',
        'published',
        'component_id',
        'checked_out',
        'checked_out_time',
        'browserNav',
        'access',
        'img',
        'template_style_id',
        'params',
        'home',
        'language',
        'client_id',
        'publish_up',
        'publish_down',
        'request',
        'associations',
        'menuordering',
    ];

    /**
     * The fields to render items in the documents
     *
     * @var  array
     * @since  4.0.0
     */
    protected $fieldsToRenderList  = [
        'id',
        'menutype',
        'title',
        'alias',
        'note',
        'path',
        'link',
        'type',
        'parent_id',
        'level',
        'a.published',
        'component_id',
        'checked_out',
        'checked_out_time',
        'browserNav',
        'access',
        'img',
        'template_style_id',
        'params',
        'lft',
        'rgt',
        'home',
        'language',
        'client_id',
        'enabled',
        'publish_up',
        'publish_down',
        'published',
        'language_title',
        'language_image',
        'language_sef',
        'editor',
        'componentname',
        'access_level',
        'menutype_id',
        'menutype_title',
        'association',
        'name',
    ];

    /**
     * Execute and display a list items types.
     *
     * @return  string
     *
     * @since   4.0.0
     */
    public function displayListTypes()
    {
        /** @var \Joomla\Component\Menus\Administrator\Model\MenutypesModel $model */
        $model = $this->getModel();
        $items = [];

        foreach ($model->getTypeOptions() as $type => $data) {
            $groupItems = [];

            foreach ($data as $item) {
                $item->id          = implode('/', $item->request);
                $item->title       = Text::_($item->title);
                $item->description = Text::_($item->description);
                $item->group       = Text::_($type);

                $groupItems[] = $item;
            }

            $items = array_merge($items, $groupItems);
        }

        // Set up links for pagination
        $currentUrl                    = Uri::getInstance();
        $currentPageDefaultInformation = ['offset' => 0, 'limit' => 20];
        $currentPageQuery              = $currentUrl->getVar('page', $currentPageDefaultInformation);

        $offset              = $currentPageQuery['offset'];
        $limit               = $currentPageQuery['limit'];
        $totalItemsCount     = \count($items);
        $totalPagesAvailable = ceil($totalItemsCount / $limit);

        $items = array_splice($items, $offset, $limit);

        $firstPage                = clone $currentUrl;
        $firstPageQuery           = $currentPageQuery;
        $firstPageQuery['offset'] = 0;
        $firstPage->setVar('page', $firstPageQuery);

        $nextPage                = clone $currentUrl;
        $nextPageQuery           = $currentPageQuery;
        $nextOffset              = $currentPageQuery['offset'] + $limit;
        $nextPageQuery['offset'] = ($nextOffset > ($totalPagesAvailable * $limit)) ? $totalPagesAvailable - $limit : $nextOffset;
        $nextPage->setVar('page', $nextPageQuery);

        $previousPage                = clone $currentUrl;
        $previousPageQuery           = $currentPageQuery;
        $previousOffset              = $currentPageQuery['offset'] - $limit;
        $previousPageQuery['offset'] = max($previousOffset, 0);
        $previousPage->setVar('page', $previousPageQuery);

        $lastPage                = clone $currentUrl;
        $lastPageQuery           = $currentPageQuery;
        $lastPageQuery['offset'] = $totalPagesAvailable - $limit;
        $lastPage->setVar('page', $lastPageQuery);

        $collection = (new Collection($items, new JoomlaSerializer('menutypes')));

        // Set the data into the document and render it
        $this->getDocument()->addMeta('total-pages', $totalPagesAvailable)
            ->setData($collection)
            ->addLink('self', (string) $currentUrl)
            ->addLink('first', (string) $firstPage)
            ->addLink('next', (string) $nextPage)
            ->addLink('previous', (string) $previousPage)
            ->addLink('last', (string) $lastPage);

        return $this->getDocument()->render();
    }

    /**
     * Prepare item before render.
     *
     * @param   object  $item  The model item
     *
     * @return  object
     *
     * @since   4.0.0
     */
    protected function prepareItem($item)
    {
        if (\is_string($item->params)) {
            $item->params = json_decode($item->params);
        }

        return parent::prepareItem($item);
    }
}