Burzum\CakeServiceLayer\Service\ServicePaginatorTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Test Coverage

Coverage

92.86%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setPaginator()	0	5	1
A	getPaginator()	0	8	2
A	paginate()	0	28	3
A	addPagingParamToRequest()	0	3	1

<?php
/**
 * Copyright (c) Florian Krämer
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Florian Krämer
 * @link          https://github.com/burzum/cakephp-service-layer
 * @since         1.0.0
 * @license       https://opensource.org/licenses/mit-license.php MIT License
 */
declare(strict_types = 1);

namespace Burzum\CakeServiceLayer\Service;

use Cake\Datasource\Paginator;
use Cake\Datasource\PaginatorInterface;
use Cake\Event\EventDispatcherTrait;
use Cake\Http\ServerRequest;

/**
 * ServicePaginatorTrait
 */
trait ServicePaginatorTrait
{
    use EventDispatcherTrait;

    /**
     * Paginator instance
     *
     * @var \Cake\Datasource\PaginatorInterface
     */
    protected $_paginator;

    /**
     * Default paginator class
     *
     * @var string
     */
    protected $_defaultPaginatorClass = Paginator::class;

    /**
     * Set paginator instance.
     *
     * @param \Cake\Datasource\PaginatorInterface $paginator Paginator instance.
     * @return static
     */
    public function setPaginator(PaginatorInterface $paginator)
    {
        $this->_paginator = $paginator;

        return $this;
    }

    /**
     * Get paginator instance.
     *
     * @return \Cake\Datasource\PaginatorInterface
     */
    public function getPaginator()
    {
        if (empty($this->_paginator)) {
            $class = $this->_defaultPaginatorClass;
            $this->setPaginator(new $class());
        }

        return $this->_paginator;
    }

    /**
     * Paginate
     *
     * @param \Cake\Datasource\RepositoryInterface|\Cake\Datasource\QueryInterface $object The table or query to paginate.
     * @param array $params Request params
     * @param array $settings The settings/configuration used for pagination.
     * @return \Cake\Datasource\ResultSetInterface Query results
     */
    public function paginate($object, array $params = [], array $settings = [])
    {
        $event = $this->dispatchEvent('Service.beforePaginate', compact(
            'object',
            'params',
            'settings'
        ));

        if ($event->isStopped()) {
            return $event->getResult();
        }

        $result = $this->getPaginator()->paginate($object, $params, $settings);
        $pagingParams = $this->getPaginator()->getPagingParams();

        $event = $this->dispatchEvent('Service.afterPaginate', compact(
            'object',
            'params',
            'settings',
            'result',
            'pagingParams'
        ));

        if ($event->getResult() !== null) {
            return $event->getResult();
        }

        return $result;
    }

    /**
     * Adds the paginator params to the request objects params
     *
     * @param \Cake\Http\ServerRequest $request Request object
     * @return \Cake\Http\ServerRequest
     */
    public function addPagingParamToRequest(ServerRequest $request): ServerRequest
    {
        return $request->withParam('paging', $this->getPaginator()->getPagingParams() + (array)$request->getParam('paging'));
    }
}