ResultPaginateController::getDocuments() - Code Metrics - Inspection of "[!!!][TASK] Extract document parsing to parser cla..." - dkd-kaehm/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ee9c7d...9819c1 )

by Rafael

created 2017-10-09 09:18 UTC

ResultPaginateController::getDocuments() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2.351

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	5
cts	9
cp	0.5556
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	6
nc	2
nop	0
crap	2.351

<?php
namespace ApacheSolrForTypo3\Solr\ViewHelpers\Widget\Controller;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use ApacheSolrForTypo3\Solr\Widget\AbstractWidgetController;
use TYPO3\CMS\Core\Utility\ArrayUtility;

/**
 * Class ResultPaginateController
 *
 * @author Frans Saris <[email protected]>
 * @author Timo Hund <[email protected]>
 * @package ApacheSolrForTypo3\Solr\ViewHelpers\Widget\Controller
 */
class ResultPaginateController extends AbstractWidgetController
{

    /**
     * @var array
     */
    protected $configuration = [
        'insertAbove' => true,
        'insertBelow' => true,
        'maximumNumberOfLinks' => 10,
        'addQueryStringMethod' => '',
        'templatePath' => ''
    ];

    /**
     * @var \ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\SearchResultSet
     */
    protected $resultSet;

    /**
     * @var int
     */
    protected $currentPage = 1;

    /**
     * @var int
     */
    protected $displayRangeStart;

    /**
     * @var int
     */
    protected $displayRangeEnd;

    /**
     * @var int
     */
    protected $maximumNumberOfLinks = 99;

    /**
     * @var int
     */
    protected $numberOfPages = 1;

    /**
     * @var string
     */
    protected $templatePath = '';

    /**
     * @return void
     */
    public function initializeAction()
    {
        $this->resultSet = $this->widgetConfiguration['resultSet'];

        ArrayUtility::mergeRecursiveWithOverrule($this->configuration, $this->widgetConfiguration['configuration'], false);
        $this->configuration['itemsPerPage'] = $this->getItemsPerPage();
        $this->numberOfPages = (int)ceil($this->resultSet->getUsedSearch()->getNumberOfResults() / $this->configuration['itemsPerPage']);
        $this->maximumNumberOfLinks = (int)$this->configuration['maximumNumberOfLinks'];
        if (!empty($this->configuration['templatePath'])) {
            $this->templatePath = \TYPO3\CMS\Core\Utility\GeneralUtility::getFileAbsFileName($this->configuration['templatePath']);
        }
    }

    /**
     * Determines the number of results per page. When nothing is configured 10 will be returned.
     *
     * @return int
     */
    protected function getItemsPerPage()
    {
        $perPage = (int)$this->resultSet->getUsedSearch()->getQuery()->getResultsPerPage();
        return $perPage > 0 ? $perPage : 10;
    }

    /**
     * @param \ApacheSolrForTypo3\Solr\Mvc\Controller\SolrControllerContext $controllerContext
     * @return \ApacheSolrForTypo3\Solr\Mvc\Controller\SolrControllerContext
     */
    protected function setActiveSearchResultSet($controllerContext) {
        $controllerContext->setSearchResultSet($this->resultSet);
        return $controllerContext;
    }

    /**
     * @return void
     */
    public function indexAction()
    {
        // set current page
        $this->currentPage = $this->resultSet->getUsedPage();
        if ($this->currentPage < 1) {
            $this->currentPage = 1;
        }
        $this->view->assign('contentArguments', [$this->widgetConfiguration['as'] => $this->resultSet->getSearchResults(), 'pagination' => $this->buildPagination()]);
        $this->view->assign('configuration', $this->configuration);
        $this->view->assign('resultSet', $this->resultSet);
        if (!empty($this->templatePath)) {
            $this->view->setTemplatePathAndFilename($this->templatePath);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }

    /**
     * If a certain number of links should be displayed, adjust before and after
     * amounts accordingly.
     *
     * @return void
     */
    protected function calculateDisplayRange()
    {
        $maximumNumberOfLinks = $this->maximumNumberOfLinks;
        if ($maximumNumberOfLinks > $this->numberOfPages) {
            $maximumNumberOfLinks = $this->numberOfPages;
        }
        $delta = floor($maximumNumberOfLinks / 2);
        $this->displayRangeStart = $this->currentPage - $delta;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->displayRangeEnd = $this->currentPage + $delta - ($maximumNumberOfLinks % 2 === 0 ? 1 : 0);
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        if ($this->displayRangeStart < 1) {
            $this->displayRangeEnd -= $this->displayRangeStart - 1;
        }
        if ($this->displayRangeEnd > $this->numberOfPages) {
            $this->displayRangeStart -= $this->displayRangeEnd - $this->numberOfPages;
        }
        $this->displayRangeStart = (int)max($this->displayRangeStart, 1);
        $this->displayRangeEnd = (int)min($this->displayRangeEnd, $this->numberOfPages);
    }

    /**
     * Returns an array with the keys "pages", "current", "numberOfPages", "nextPage" & "previousPage"
     *
     * @return array
     */
    protected function buildPagination()
    {
        $this->calculateDisplayRange();
        $pages = [];
        for ($i = $this->displayRangeStart; $i <= $this->displayRangeEnd; $i++) {
            $pages[] = ['number' => $i, 'isCurrent' => $i === $this->currentPage];
        }
        $pagination = ['pages' => $pages, 'current' => $this->currentPage, 'numberOfPages' => $this->numberOfPages, 'displayRangeStart' => $this->displayRangeStart, 'displayRangeEnd' => $this->displayRangeEnd, 'hasLessPages' => $this->displayRangeStart > 2, 'hasMorePages' => $this->displayRangeEnd + 1 < $this->numberOfPages];
        if ($this->currentPage < $this->numberOfPages) {
            $pagination['nextPage'] = $this->currentPage + 1;
        }
        if ($this->currentPage > 1) {
            $pagination['previousPage'] = $this->currentPage - 1;
        }
        return $pagination;
    }
}


1		<?php
2		namespace ApacheSolrForTypo3\Solr\ViewHelpers\Widget\Controller;
3
4		/*
5		* This file is part of the TYPO3 CMS project.
6		*
7		* It is free software; you can redistribute it and/or modify it under
8		* the terms of the GNU General Public License, either version 2
9		* of the License, or any later version.
10		*
11		* For the full copyright and license information, please read the
12		* LICENSE.txt file that was distributed with this source code.
13		*
14		* The TYPO3 project - inspiring people to share!
15		*/
16
17		use ApacheSolrForTypo3\Solr\Widget\AbstractWidgetController;
18		use TYPO3\CMS\Core\Utility\ArrayUtility;
19
20		/**
21		* Class ResultPaginateController
22		*
23		* @author Frans Saris <[email protected]>
24		* @author Timo Hund <[email protected]>
25		* @package ApacheSolrForTypo3\Solr\ViewHelpers\Widget\Controller
26		*/
27		class ResultPaginateController extends AbstractWidgetController
28		{
29
30		/**
31		* @var array
32		*/
33		protected $configuration = [
34		'insertAbove' => true,
35		'insertBelow' => true,
36		'maximumNumberOfLinks' => 10,
37		'addQueryStringMethod' => '',
38		'templatePath' => ''
39		];
40
41		/**
42		* @var \ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\SearchResultSet
43		*/
44		protected $resultSet;
45
46		/**
47		* @var int
48		*/
49		protected $currentPage = 1;
50
51		/**
52		* @var int
53		*/
54		protected $displayRangeStart;
55
56		/**
57		* @var int
58		*/
59		protected $displayRangeEnd;
60
61		/**
62		* @var int
63		*/
64		protected $maximumNumberOfLinks = 99;
65
66		/**
67		* @var int
68		*/
69		protected $numberOfPages = 1;
70
71		/**
72		* @var string
73		*/
74		protected $templatePath = '';
75
76		/**
77		* @return void
78		*/
79		public function initializeAction()
80	27	{
81		$this->resultSet = $this->widgetConfiguration['resultSet'];
82	27
83		ArrayUtility::mergeRecursiveWithOverrule($this->configuration, $this->widgetConfiguration['configuration'], false);
84	27	$this->configuration['itemsPerPage'] = $this->getItemsPerPage();
85	27	$this->numberOfPages = (int)ceil($this->resultSet->getUsedSearch()->getNumberOfResults() / $this->configuration['itemsPerPage']);
86	27	$this->maximumNumberOfLinks = (int)$this->configuration['maximumNumberOfLinks'];
87	27	if (!empty($this->configuration['templatePath'])) {
88	27	$this->templatePath = \TYPO3\CMS\Core\Utility\GeneralUtility::getFileAbsFileName($this->configuration['templatePath']);
89		}
90		}
91	27
92		/**
93		* Determines the number of results per page. When nothing is configured 10 will be returned.
94		*
95		* @return int
96		*/
97		protected function getItemsPerPage()
98	27	{
99		$perPage = (int)$this->resultSet->getUsedSearch()->getQuery()->getResultsPerPage();
100	27	return $perPage > 0 ? $perPage : 10;
101	27	}
102
103		/**
104		* @param \ApacheSolrForTypo3\Solr\Mvc\Controller\SolrControllerContext $controllerContext
105		* @return \ApacheSolrForTypo3\Solr\Mvc\Controller\SolrControllerContext
106		*/
107		protected function setActiveSearchResultSet($controllerContext) {
108	27	$controllerContext->setSearchResultSet($this->resultSet);
109	27	return $controllerContext;
110	27	}
111
112		/**
113		* @return void
114		*/
115		public function indexAction()
116	27	{
117		// set current page
118		$this->currentPage = $this->resultSet->getUsedPage();
119	27	if ($this->currentPage < 1) {
120	27	$this->currentPage = 1;
121	26	}
122		$this->view->assign('contentArguments', [$this->widgetConfiguration['as'] => $this->resultSet->getSearchResults(), 'pagination' => $this->buildPagination()]);
123	27	$this->view->assign('configuration', $this->configuration);
124	27	$this->view->assign('resultSet', $this->resultSet);
125	27	if (!empty($this->templatePath)) {
126	27	$this->view->setTemplatePathAndFilename($this->templatePath);
		0 ignored issues – show Bug introduced 2017-08-25 10:57 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TYPO3\CMS\Extbase\Mvc\View\ViewInterface` as the method `setTemplatePathAndFilename()` does only exist in the following implementations of said interface: `TYPO3\CMS\Fluid\View\StandaloneView`, `TYPO3\CMS\Fluid\View\TemplateView`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
127		}
128		}
129	27
130		/**
131		* If a certain number of links should be displayed, adjust before and after
132		* amounts accordingly.
133		*
134		* @return void
135		*/
136		protected function calculateDisplayRange()
137	27	{
138		$maximumNumberOfLinks = $this->maximumNumberOfLinks;
139	27	if ($maximumNumberOfLinks > $this->numberOfPages) {
140	27	$maximumNumberOfLinks = $this->numberOfPages;
141	27	}
142		$delta = floor($maximumNumberOfLinks / 2);
143	27	$this->displayRangeStart = $this->currentPage - $delta;
		0 ignored issues – show Documentation Bug introduced 2017-08-25 10:57 UTC by Report Bug Copy Issue Report The property `$displayRangeStart` was declared of type `integer`, but `$this->currentPage - $delta` is of type `double`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
144	27	$this->displayRangeEnd = $this->currentPage + $delta - ($maximumNumberOfLinks % 2 === 0 ? 1 : 0);
		0 ignored issues – show Documentation Bug introduced 2017-08-25 10:57 UTC by Report Bug Copy Issue Report The property `$displayRangeEnd` was declared of type `integer`, but `$this->currentPage + $de...inks % 2 === 0 ? 1 : 0)` is of type `double`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
145	27	if ($this->displayRangeStart < 1) {
146	27	$this->displayRangeEnd -= $this->displayRangeStart - 1;
147	8	}
148		if ($this->displayRangeEnd > $this->numberOfPages) {
149	27	$this->displayRangeStart -= $this->displayRangeEnd - $this->numberOfPages;
150		}
151		$this->displayRangeStart = (int)max($this->displayRangeStart, 1);
152	27	$this->displayRangeEnd = (int)min($this->displayRangeEnd, $this->numberOfPages);
153	27	}
154	27
155		/**
156		* Returns an array with the keys "pages", "current", "numberOfPages", "nextPage" & "previousPage"
157		*
158		* @return array
159		*/
160		protected function buildPagination()
161	27	{
162		$this->calculateDisplayRange();
163	27	$pages = [];
164	27	for ($i = $this->displayRangeStart; $i <= $this->displayRangeEnd; $i++) {
165	27	$pages[] = ['number' => $i, 'isCurrent' => $i === $this->currentPage];
166	22	}
167		$pagination = ['pages' => $pages, 'current' => $this->currentPage, 'numberOfPages' => $this->numberOfPages, 'displayRangeStart' => $this->displayRangeStart, 'displayRangeEnd' => $this->displayRangeEnd, 'hasLessPages' => $this->displayRangeStart > 2, 'hasMorePages' => $this->displayRangeEnd + 1 < $this->numberOfPages];
168	27	if ($this->currentPage < $this->numberOfPages) {
169	27	$pagination['nextPage'] = $this->currentPage + 1;
170	8	}
171		if ($this->currentPage > 1) {
172	27	$pagination['previousPage'] = $this->currentPage - 1;
173	1	}
174		return $pagination;
175	27	}
176		}
177

dkd-kaehm / ext-solr

Push — master ( ee9c7d...9819c1 )

ResultPaginateController::getDocuments() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like