Builder::paginateQuery() - Code Metrics - Inspection of "Merge pull request #20 from peter-gribanov/phpstan" - gpslab/pagination-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5515e9...734450 )

by Peter

created 2019-10-30 15:43 UTC

Builder::paginateQuery() A

↳ Parent: Builder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	19
ccs	10
cts	10
cp	1
rs	9.6333
c	0
b	0
f	0
cc	1
nc	1
nop	3
crap	1

<?php

/**
 * GpsLab component.
 *
 * @author    Peter Gribanov <[email protected]>
 * @copyright Copyright (c) 2011, Peter Gribanov
 * @license   http://opensource.org/licenses/MIT
 */

namespace GpsLab\Bundle\PaginationBundle\Service;

use Doctrine\ORM\QueryBuilder;
use GpsLab\Bundle\PaginationBundle\Exception\IncorrectPageNumberException;
use GpsLab\Bundle\PaginationBundle\Exception\OutOfRangeException;
use Symfony\Bundle\FrameworkBundle\Routing\Router;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;

class Builder
{
    /**
     * @var Router
     */
    private $router;

    /**
     * The number of pages displayed in the navigation.
     *
     * @var int
     */
    private $max_navigate;

    /**
     * Name of URL parameter for page number.
     *
     * @var string
     */
    private $parameter_name;

    /**
     * @param Router $router         Router service
     * @param int    $max_navigate   Maximum showing navigation links in pagination
     * @param string $parameter_name Name of URL parameter for page number
     */
    public function __construct(Router $router, $max_navigate, $parameter_name)
    {
        $this->router = $router;
        $this->max_navigate = $max_navigate;
        $this->parameter_name = $parameter_name;
    }

    /**
     * @param int $total_pages  Total available pages
     * @param int $current_page The current page number
     *
     * @return Configuration
     */
    public function paginate($total_pages = 1, $current_page = 1)
    {
        return (new Configuration($total_pages, $current_page))
            ->setMaxNavigate($this->max_navigate)
            ->setPageLink(sprintf('?%s=%%d', $this->parameter_name))
        ;
    }

    /**
     * @param QueryBuilder $query        Query for select entities
     * @param int          $per_page     Entities per page
     * @param int          $current_page The current page number
     *
     * @return Configuration
     */
    public function paginateQuery(QueryBuilder $query, $per_page, $current_page = 1)
    {
        $counter = clone $query;
        $total = $counter
            ->select(sprintf('COUNT(%s)', current($query->getRootAliases())))
            ->getQuery()
            ->getSingleScalarResult()
        ;

        $total_pages = (int) ceil($total / $per_page);
        $current_page = $this->validateCurrentPage($current_page, $total_pages);

        $query
            ->setFirstResult(($current_page - 1) * $per_page)
            ->setMaxResults($per_page)
        ;

        return $this->paginate($total_pages, $current_page);
    }

    /**
     * @param Request $request        Current HTTP request
     * @param int     $total_pages    Total available pages
     * @param string  $parameter_name Name of URL parameter for page number
     * @param int     $reference_type The type of reference (one of the constants in UrlGeneratorInterface)
     *
     * @return Configuration
     */
    public function paginateRequest(

        Request $request,
        $total_pages,
        $parameter_name = '',
        $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH
    ) {
        $parameter_name = $parameter_name ?: $this->parameter_name;
        $current_page = $this->validateCurrentPage($request->get($parameter_name), $total_pages);

        return $this->configureFromRequest(
            $request,
            $this->paginate($total_pages, $current_page),
            $parameter_name,
            $reference_type
        );
    }

    /**
     * @param Request      $request        Current HTTP request
     * @param QueryBuilder $query          Query for select entities
     * @param int          $per_page       Entities per page
     * @param string       $parameter_name Name of URL parameter for page number
     * @param int          $reference_type The type of reference (one of the constants in UrlGeneratorInterface)
     *
     * @return Configuration
     */
    public function paginateRequestQuery(

        Request $request,
        QueryBuilder $query,
        $per_page,
        $parameter_name = 'page',
        $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH
    ) {
        $parameter_name = $parameter_name ?: $this->parameter_name;

        return $this->configureFromRequest(
            $request,
            $this->paginateQuery($query, $per_page, $request->get($parameter_name)),
            $parameter_name,
            $reference_type
        );
    }

    /**
     * @param mixed $current_page
     * @param int   $total_pages
     *
     * @return int
     */
    private function validateCurrentPage($current_page, $total_pages)
    {
        if ($current_page === null) {
            return 1;
        }

        if (!is_int($current_page) && (!is_string($current_page) || !ctype_digit($current_page))) {
            throw IncorrectPageNumberException::incorrect($current_page);
        }

        if ($current_page < 1 || $current_page > $total_pages) {
            throw OutOfRangeException::out((int) $current_page, $total_pages);
        }

        return (int) $current_page;
    }

    /**
     * @param Request       $request
     * @param Configuration $configuration
     * @param string        $parameter_name
     * @param int           $reference_type
     *
     * @return Configuration
     */
    private function configureFromRequest(
        Request $request,
        Configuration $configuration,
        $parameter_name,
        $reference_type
    ) {
        $route = $request->get('_route');
        $route_params = array_merge($request->query->all(), $request->get('_route_params', []));
        unset($route_params[$parameter_name]);

        return $configuration
            ->setPageLink(function ($number) use ($route, $route_params, $parameter_name, $reference_type) {
                $params = array_merge($route_params, [$parameter_name => $number]);

                return $this->router->generate($route, $params, $reference_type);
            })
            ->setFirstPageLink($this->router->generate($route, $route_params, $reference_type))
        ;
    }
}


1			<?php
2
3			/**
4			* GpsLab component.
5			*
6			* @author Peter Gribanov <[email protected]>
7			* @copyright Copyright (c) 2011, Peter Gribanov
8			* @license http://opensource.org/licenses/MIT
9			*/
10
11			namespace GpsLab\Bundle\PaginationBundle\Service;
12
13			use Doctrine\ORM\QueryBuilder;
14			use GpsLab\Bundle\PaginationBundle\Exception\IncorrectPageNumberException;
15			use GpsLab\Bundle\PaginationBundle\Exception\OutOfRangeException;
16			use Symfony\Bundle\FrameworkBundle\Routing\Router;
17			use Symfony\Component\HttpFoundation\Request;
18			use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
19
20			class Builder
21			{
22			/**
23			* @var Router
24			*/
25			private $router;
26
27			/**
28			* The number of pages displayed in the navigation.
29			*
30			* @var int
31			*/
32			private $max_navigate;
33
34			/**
35			* Name of URL parameter for page number.
36			*
37			* @var string
38			*/
39			private $parameter_name;
40
41			/**
42			* @param Router $router Router service
43			* @param int $max_navigate Maximum showing navigation links in pagination
44			* @param string $parameter_name Name of URL parameter for page number
45			*/
46	14		public function __construct(Router $router, $max_navigate, $parameter_name)
47			{
48	14		$this->router = $router;
49	14		$this->max_navigate = $max_navigate;
50	14		$this->parameter_name = $parameter_name;
51	14		}
52
53			/**
54			* @param int $total_pages Total available pages
55			* @param int $current_page The current page number
56			*
57			* @return Configuration
58			*/
59	7		public function paginate($total_pages = 1, $current_page = 1)
60			{
61	7		return (new Configuration($total_pages, $current_page))
62	7		->setMaxNavigate($this->max_navigate)
63	7		->setPageLink(sprintf('?%s=%%d', $this->parameter_name))
64			;
65			}
66
67			/**
68			* @param QueryBuilder $query Query for select entities
69			* @param int $per_page Entities per page
70			* @param int $current_page The current page number
71			*
72			* @return Configuration
73			*/
74	7		public function paginateQuery(QueryBuilder $query, $per_page, $current_page = 1)
75			{
76	7		$counter = clone $query;
77			$total = $counter
78	7		->select(sprintf('COUNT(%s)', current($query->getRootAliases())))
79	7		->getQuery()
80	7		->getSingleScalarResult()
81			;
82
83	7		$total_pages = (int) ceil($total / $per_page);
84	7		$current_page = $this->validateCurrentPage($current_page, $total_pages);
85
86			$query
87	3		->setFirstResult(($current_page - 1) * $per_page)
88	3		->setMaxResults($per_page)
89			;
90
91	3		return $this->paginate($total_pages, $current_page);
92			}
93
94			/**
95			* @param Request $request Current HTTP request
96			* @param int $total_pages Total available pages
97			* @param string $parameter_name Name of URL parameter for page number
98			* @param int $reference_type The type of reference (one of the constants in UrlGeneratorInterface)
99			*
100			* @return Configuration
101			*/
102	4	View Code Duplication	public function paginateRequest(
			0 ignored issues – show Duplication introduced 2019-08-14 12:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
103			Request $request,
104			$total_pages,
105			$parameter_name = '',
106			$reference_type = UrlGeneratorInterface::ABSOLUTE_PATH
107			) {
108	4		$parameter_name = $parameter_name ?: $this->parameter_name;
109	4		$current_page = $this->validateCurrentPage($request->get($parameter_name), $total_pages);
110
111	1		return $this->configureFromRequest(
112	1		$request,
113	1		$this->paginate($total_pages, $current_page),
114	1		$parameter_name,
115	1		$reference_type
116			);
117			}
118
119			/**
120			* @param Request $request Current HTTP request
121			* @param QueryBuilder $query Query for select entities
122			* @param int $per_page Entities per page
123			* @param string $parameter_name Name of URL parameter for page number
124			* @param int $reference_type The type of reference (one of the constants in UrlGeneratorInterface)
125			*
126			* @return Configuration
127			*/
128	4	View Code Duplication	public function paginateRequestQuery(
			0 ignored issues – show Duplication introduced 2019-08-14 12:11 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
129			Request $request,
130			QueryBuilder $query,
131			$per_page,
132			$parameter_name = 'page',
133			$reference_type = UrlGeneratorInterface::ABSOLUTE_PATH
134			) {
135	4		$parameter_name = $parameter_name ?: $this->parameter_name;
136
137	4		return $this->configureFromRequest(
138	4		$request,
139	4		$this->paginateQuery($query, $per_page, $request->get($parameter_name)),
140	1		$parameter_name,
141	1		$reference_type
142			);
143			}
144
145			/**
146			* @param mixed $current_page
147			* @param int $total_pages
148			*
149			* @return int
150			*/
151	11		private function validateCurrentPage($current_page, $total_pages)
152			{
153	11		if ($current_page === null) {
154	1		return 1;
155			}
156
157	10		if (!is_int($current_page) && (!is_string($current_page) \|\| !ctype_digit($current_page))) {
158	2		throw IncorrectPageNumberException::incorrect($current_page);
159			}
160
161	8		if ($current_page < 1 \|\| $current_page > $total_pages) {
162	5		throw OutOfRangeException::out((int) $current_page, $total_pages);
163			}
164
165	3		return (int) $current_page;
166			}
167
168			/**
169			* @param Request $request
170			* @param Configuration $configuration
171			* @param string $parameter_name
172			* @param int $reference_type
173			*
174			* @return Configuration
175			*/
176	2		private function configureFromRequest(
177			Request $request,
178			Configuration $configuration,
179			$parameter_name,
180			$reference_type
181			) {
182	2		$route = $request->get('_route');
183	2		$route_params = array_merge($request->query->all(), $request->get('_route_params', []));
184	2		unset($route_params[$parameter_name]);
185
186			return $configuration
187	2		->setPageLink(function ($number) use ($route, $route_params, $parameter_name, $reference_type) {
188	2		$params = array_merge($route_params, [$parameter_name => $number]);
189
190	2		return $this->router->generate($route, $params, $reference_type);
191	2		})
192	2		->setFirstPageLink($this->router->generate($route, $route_params, $reference_type))
193			;
194			}
195			}
196

gpslab / pagination-bundle

Push — master ( 5515e9...734450 )

Builder::paginateQuery() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like