Slick\Mvc\Controller\EntityListingMethods

Complexity

Total Complexity

9

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	7

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	index()	0	14	1
A	getPagination()	0	12	2
A	getListingService()	0	9	2
A	getSearchFilter()	0	8	1
A	getSearchFields()	0	11	2
A	getOrder()	0	8	1
	getRequest()	0	1	?
	getEntityDescriptor()	0	1	?
	getEntityNamePlural()	0	1	?

<?php

/**
 * This file is part of slick/mvc package
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Mvc\Controller;

use Psr\Http\Message\ServerRequestInterface;
use Slick\Filter\StaticFilter;
use Slick\Http\PhpEnvironment\Request;
use Slick\Mvc\Service\Entity\EntityListingService;
use Slick\Mvc\Service\Entity\QueryFilter\SearchFilter;
use Slick\Mvc\Utils\Pagination;
use Slick\Orm\Repository\EntityRepository;

/**
 * Entity Listing Methods
 *
 * @package Slick\Mvc\Controller
 * @author  Filipe Silva <silvam.filipe@gmail.com>
 */
trait EntityListingMethods
{
    
    /**
     * @var int
     */
    protected $rowsPerPage = 12;

    /**
     * @var Pagination
     */
    protected $pagination;

    /**
     * @var EntityListingService
     */
    protected $listingService;

    /**
     * @var string[]
     */
    protected $searchFields;

    /**
     * Handle the request to display a list of entities
     */
    public function index()
    {
        $this->getListingService()
            ->setOrder($this->getOrder())
            ->setPagination($this->getPagination())
            ->getFilters()->add($this->getSearchFilter());
        $this->set(

It seems like set() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            [
                $this->getEntityNamePlural() => $this->getListingService()
                    ->getList(),
                'pagination' => $this->getListingService()->getPagination()
            ]
        );
    }

    /**
     * Get pagination for roes per page property
     *
     * @return Pagination
     */
    protected function getPagination()
    {
        if (null == $this->pagination) {
            $this->pagination = new Pagination(
                [
                    'rowsPerPage' => $this->rowsPerPage,
                    'request' => $this->getRequest()
                ]
            );
        }
        return $this->pagination;
    }

    /**
     * Get the entity listing service
     *
     * @return EntityListingService
     */
    protected function getListingService()
    {
        if (null == $this->listingService) {
            $this->listingService = new EntityListingService(
                $this->getEntityClassName()

It seems like getEntityClassName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            );
        }
        return $this->listingService;
    }

    /**
     * Get search filter 
     * 
     * @return SearchFilter
     */
    protected function getSearchFilter()
    {
        $pattern = $this->getRequest()->getQuery('pattern', null);

The method getQuery() does not exist on Psr\Http\Message\ServerRequestInterface. Did you maybe mean getQueryParams()?

        $pattern = StaticFilter::filter('text', $pattern);
        $this->set('pattern', $pattern);

It seems like set() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        
        return new SearchFilter(['pattern' => $pattern]);
    }

    /**
     * Get the fields list to use on search filter
     * 
     * @return array|\string[]
     */
    protected function getSearchFields()
    {
        if (null == $this->searchFields) {
            $field = $this->getEntityDescriptor()->getDisplayFiled();
            $this->searchFields = [
                $this->getEntityDescriptor()
                    ->getTableName().'.'.$field->getField()
            ];
        }
        return $this->searchFields;
    }

    /**
     * Returns the query order by clause
     * 
     * @return string
     */
    protected function getOrder()
    {
        /** @var EntityRepository $repo */
        $repo = $this->getRepository();

It seems like getRepository() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $table = $repo->getEntityDescriptor()->getTableName();
        $pmk = $repo->getEntityDescriptor()->getPrimaryKey()->getField();
        return "{$table}.{$pmk} DESC";
    }

    /**
     * Gets updated HTTP request
     *
     * @return ServerRequestInterface|Request
     */
    abstract public function getRequest();

    /**
     * Get the current entity descriptor
     *
     * @return \Slick\Orm\Descriptor\EntityDescriptorInterface
     */
    abstract protected function getEntityDescriptor();

    /**
     * Get the plural name of the entity
     *
     * @return string
     */
    abstract protected function getEntityNamePlural();
}