ChangeableLimitTrait::getLimit() - Code Metrics - Inspection of "Merge branch 'master' into l10n_master" - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — l10n_master ( 67e2d3...a09cbd )

by Sander

created 2018-07-26 13:00 UTC

ChangeableLimitTrait::getLimit() A

↳ Parent: ChangeableLimitTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Kunstmaan\AdminListBundle\Traits;

use Symfony\Component\HttpFoundation\Request;

/**
 * Trait ChangeableLimitTrait
 */
trait ChangeableLimitTrait
{
    private $limit;

    /**
     * Bind current request.
     *
     * @param Request $request
     */
    public function bindRequest(Request $request)
    {
        $query = $request->query;
        $session = $request->getSession();

        $adminListName = 'listconfig_' . $request->get('_route');

        $this->page = $request->query->getInt('page', 1);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->limit = $request->query->getInt('limit', $this->getLimitOptions()[0]);

        $adminListSessionData = $request->getSession()->get($adminListName);
        if (!$query->has('limit') && null !== $adminListSessionData && isset($adminListSessionData['limit'])) {
            $this->limit = $adminListSessionData['limit'];
        }

        if ($request->query->has('limit') && !$request->query->has('page')) {
            $this->page = 1;
        }

        // Allow alphanumeric, _ & . in order by parameter!
        $this->orderBy = preg_replace('/[^[a-zA-Z0-9\_\.]]/', '', $request->query->get('orderBy', ''));
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->orderDirection = $request->query->getAlpha('orderDirection', '');
class MyClass { }

$x = new MyClass();
$x->foo = true;

        // there is a session and the filter param is not set
        if ($session->has($adminListName) && !$query->has('filter')) {

            if (!$query->has('page') && !$query->has('limit')) {
                $this->page = $adminListSessionData['page'];
            }

            if (!$query->has('orderBy')) {
                $this->orderBy = $adminListSessionData['orderBy'];
            }

            if (!$query->has('orderDirection')) {
                $this->orderDirection = $adminListSessionData['orderDirection'];
            }
        }

        // save current parameters
        $session->set(
            $adminListName,
            [
                'page' => $this->page,
                'limit' => $this->limit,
                'orderBy' => $this->orderBy,
                'orderDirection' => $this->orderDirection,
            ]
        );

        // Remove limit from query param so it doesn't affect the session of the filter builder
        $request->query->remove('limit');
        $this->getFilterBuilder()->bindRequest($request);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @return int
     */
    public function getLimit()
    {
        return $this->limit;
    }

    /** @return array */

    public function getLimitOptions()
    {
        return [
            10,
            20,
            50,
            100,
        ];
    }
}


1		<?php
2
3		namespace Kunstmaan\AdminListBundle\Traits;
4
5		use Symfony\Component\HttpFoundation\Request;
6
7		/**
8		* Trait ChangeableLimitTrait
9		*/
10		trait ChangeableLimitTrait
11		{
12		private $limit;
13
14		/**
15		* Bind current request.
16		*
17		* @param Request $request
18		*/
19		public function bindRequest(Request $request)
20		{
21		$query = $request->query;
22		$session = $request->getSession();
23
24		$adminListName = 'listconfig_' . $request->get('_route');
25
26		$this->page = $request->query->getInt('page', 1);
		0 ignored issues – show Bug introduced 2018-05-09 11:31 UTC by Report Bug Copy Issue Report The property `page` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
27		$this->limit = $request->query->getInt('limit', $this->getLimitOptions()[0]);
28
29		$adminListSessionData = $request->getSession()->get($adminListName);
30		if (!$query->has('limit') && null !== $adminListSessionData && isset($adminListSessionData['limit'])) {
31		$this->limit = $adminListSessionData['limit'];
32		}
33
34		if ($request->query->has('limit') && !$request->query->has('page')) {
35		$this->page = 1;
36		}
37
38		// Allow alphanumeric, _ & . in order by parameter!
39		$this->orderBy = preg_replace('/[^[a-zA-Z0-9\_\.]]/', '', $request->query->get('orderBy', ''));
		0 ignored issues – show Bug introduced 2018-05-09 11:31 UTC by Report Bug Copy Issue Report The property `orderBy` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
40		$this->orderDirection = $request->query->getAlpha('orderDirection', '');
		0 ignored issues – show Bug introduced 2018-05-09 11:31 UTC by Report Bug Copy Issue Report The property `orderDirection` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
41
42		// there is a session and the filter param is not set
43	View Code Duplication	if ($session->has($adminListName) && !$query->has('filter')) {
		0 ignored issues – show Duplication introduced 2018-05-09 11:31 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
44		if (!$query->has('page') && !$query->has('limit')) {
45		$this->page = $adminListSessionData['page'];
46		}
47
48		if (!$query->has('orderBy')) {
49		$this->orderBy = $adminListSessionData['orderBy'];
50		}
51
52		if (!$query->has('orderDirection')) {
53		$this->orderDirection = $adminListSessionData['orderDirection'];
54		}
55		}
56
57		// save current parameters
58		$session->set(
59		$adminListName,
60		[
61		'page' => $this->page,
62		'limit' => $this->limit,
63		'orderBy' => $this->orderBy,
64		'orderDirection' => $this->orderDirection,
65		]
66		);
67
68		// Remove limit from query param so it doesn't affect the session of the filter builder
69		$request->query->remove('limit');
70		$this->getFilterBuilder()->bindRequest($request);
		0 ignored issues – show Bug introduced 2018-05-09 11:31 UTC by Report Bug Copy Issue Report It seems like `getFilterBuilder()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
71		}
72
73		/**
74		* @return int
75		*/
76		public function getLimit()
77		{
78		return $this->limit;
79		}
80
81		/** @return array */
		0 ignored issues – show Documentation introduced 2018-05-09 11:31 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `integer[]`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
82		public function getLimitOptions()
83		{
84		return [
85		10,
86		20,
87		50,
88		100,
89		];
90		}
91		}
92

Kunstmaan / KunstmaanBundlesCMS

Push — l10n_master ( 67e2d3...a09cbd )

ChangeableLimitTrait::getLimit() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like