PaginationBuilder::__invoke() - Code Metrics - Inspection of "Merge branch 'feature/Core-refactor_text_search_fo..." - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 7d6075...b57d28 )

unknown

created 2016-05-13 09:01 UTC

PaginationBuilder::__invoke() B

↳ Parent: PaginationBuilder

Complexity

Conditions	5
Paths	5

Size

Total Lines	19
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	2

Metric	Value
c	2
b	0
f	2
dl	0
loc	19
rs	8.8571
cc	5
eloc	10
nc	5
nop	2

<?php
/**
 * YAWIK
 *
 * @filesource
 * @license MIT
 * @copyright  2013 - 2016 Cross Solution <http://cross-solution.de>
 */
  
/** */
namespace Core\Controller\Plugin;

use Zend\Mvc\Controller\Plugin\AbstractPlugin;

/**
 * Collects pagination related configuration and passes it to the appropriate
 * controller plugin.
 *
 * In the controller, you only have to call one plugin to do all the YAWIK pagination magic.
 *
 * @see \Core\Controller\Plugin\PaginationParams
 * @see \Core\Controller\Plugin\SearchForm
 * @see \Core\Controller\Plugin\CreatePaginator
 *
 * 
 * @author Mathias Gelhausen <[email protected]>
 * @since 0.25
 */
class PaginationBuilder extends AbstractPlugin
{

    /**
     * The internal configuration stack.
     *
     * @var array
     */
    protected $stack = [];

    /**
     * The generated result array.
     *
     * @var array
     */
    protected $result = [];

    /**
     * Entry point.
     *
     * if $stack is provided, the internal stack is set to exact that value, so
     * please be sure what you're doing.
     *
     * If you pass a boolean TRUE as $stack, the internal stack is reset.
     *
     * @param null|array|bool $stack
     * @param bool $returnResult Should the result be immediately be returned instead of
     *                           self. Only affective when $stack is an array.
     *
     * @return self|array
     * @throws \InvalidArgumentException
     */
    public function __invoke($stack = null, $returnResult = true)
    {
        if (true === $stack) {
            $this->stack = [];
            return $this;
        }

        if (null === $stack) {
            return $this;
        }

        if (!is_array($stack)) {
            throw new \InvalidArgumentException('Expected argument to be of type array, but received ' . gettype($stack));
        }

        $this->stack = $stack;

        return $returnResult ? $this->getResult() : $this;
    }

    /**
     * Add arguments for the call to the CreatePaginator plugin.
     *
     * @see \Core\Controller\Plugin\CreatePaginator::__invoke()
     *
     * @param string       $paginatorName
     * @param array  $defaultParams
     * @param bool   $usePostParams
     * @param string $as The name of the key in the result array.
     *
     * @return self
     */
    public function paginator($paginatorName, $defaultParams = [], $usePostParams = false, $as = 'paginator')
    {
        if (is_string($defaultParams)) {
            $as = $defaultParams;
            $defaultParams = [];
        } else if (is_string($usePostParams)) {
            $as = $usePostParams;
            $usePostParams = false;
        }

        $this->stack['paginator'] = ['as' => $as, $paginatorName, $defaultParams, $usePostParams];
        return $this;
    }

    /**
     * Add arguments for the call to the SearchForm plugin.
     *
     * @see \Core\Controller\Plugin\SearchForm::get()
     *
     * @param        $elementsFieldset
     * @param null   $buttonsFieldset
     * @param string $as The name of the key in the result array.
     *
     * @return self
     */
    public function form($elementsFieldset, $buttonsFieldset = null, $as = 'searchform')
    {
        if (null !== $buttonsFieldset && 0 === strpos($buttonsFieldset, '@')) {
            $as = substr($buttonsFieldset, 1);
            $buttonsFieldset = null;
        }

        $this->stack['form'] = ['as' => $as, $elementsFieldset, $buttonsFieldset];
        return $this;
    }

    /**
     * Add arguments for the call to the PaginatorParams plugin.
     *
     * @see \Core\Controller\Plugin\PaginationParams::getParams()
     *
     * @param       $namespace
     * @param array $defaults
     *
     * @return self
     */
    public function params($namespace, $defaults = [ 'page' => 1 ])
    {
        $this->stack['params'] = [$namespace, $defaults];
        return $this;
    }

    /**
     * Calls the stacked plugins in the right order and returns the result array.
     *
     * The returned array can directly be returned from the controller or be used to populate a
     * view model.
     *
     * The search form plugin is only called (and thus the form only present in the result array)
     * if the request is NOT an ajax request. (as the  form is never rerendered on ajax requests)
     *
     * @param null|string $paginatorAlias Name of the paginator in the result array
     * @param null|string $formAlias Name of the search form in the result array
     *
     * @return array
     */
    public function getResult($paginatorAlias = null, $formAlias = null)
    {
        if (null === $paginatorAlias) {

            $paginatorAlias = isset($this->stack['paginator']['as'])
                            ? $this->stack['paginator']['as']
                            : 'paginator';
        }

        if (null === $formAlias) {

            $formAlias = isset($this->stack['form']['as']) ? $this->stack['form']['as'] : 'searchform';
        }

        /* @var \Zend\Mvc\Controller\AbstractController $controller
         * @var \Zend\Http\Request $request */
        $result = [];
        $controller = $this->getController();
        $request = $controller->getRequest();

        if (isset($this->stack['params'])) {
            $this->callPlugin('paginationParams', $this->stack['params']);
        }

        if (isset($this->stack['form']) && !$request->isXmlHttpRequest()) {
            $result[$formAlias] = $this->callPlugin('searchform', $this->stack['form']);
        }

        if (isset($this->stack['paginator'])) {
            $result[$paginatorAlias] = $this->callPlugin('paginator', $this->stack['paginator']);
        }

        return $result;
    }

    /**
     * Calls an invokable controller plugin.
     *
     * @param string $name
     * @param array $args
     *
     * @return mixed The return value of the called plugin.
     */
    protected function callPlugin($name, $args)
    {
        /* @var \Zend\Mvc\Controller\AbstractController $controller */
        $controller = $this->getController();
        $plugin = $controller->plugin($name);

        /* We remove the array entry with the key "as" here.
         * because we want to keep it in the stack array */
        unset($args['as']);

        return call_user_func_array($plugin, $args);
    }
}

1		<?php
2		/**
3		* YAWIK
4		*
5		* @filesource
6		* @license MIT
7		* @copyright 2013 - 2016 Cross Solution <http://cross-solution.de>
8		*/
9
10		/** */
11		namespace Core\Controller\Plugin;
12
13		use Zend\Mvc\Controller\Plugin\AbstractPlugin;
14
15		/**
16		* Collects pagination related configuration and passes it to the appropriate
17		* controller plugin.
18		*
19		* In the controller, you only have to call one plugin to do all the YAWIK pagination magic.
20		*
21		* @see \Core\Controller\Plugin\PaginationParams
22		* @see \Core\Controller\Plugin\SearchForm
23		* @see \Core\Controller\Plugin\CreatePaginator
24		*
25		*
26		* @author Mathias Gelhausen <[email protected]>
27		* @since 0.25
28		*/
29		class PaginationBuilder extends AbstractPlugin
30		{
31
32		/**
33		* The internal configuration stack.
34		*
35		* @var array
36		*/
37		protected $stack = [];
38
39		/**
40		* The generated result array.
41		*
42		* @var array
43		*/
44		protected $result = [];
45
46		/**
47		* Entry point.
48		*
49		* if $stack is provided, the internal stack is set to exact that value, so
50		* please be sure what you're doing.
51		*
52		* If you pass a boolean TRUE as $stack, the internal stack is reset.
53		*
54		* @param null\|array\|bool $stack
55		* @param bool $returnResult Should the result be immediately be returned instead of
56		* self. Only affective when $stack is an array.
57		*
58		* @return self\|array
59		* @throws \InvalidArgumentException
60		*/
61		public function __invoke($stack = null, $returnResult = true)
62		{
63		if (true === $stack) {
64		$this->stack = [];
65		return $this;
66		}
67
68		if (null === $stack) {
69		return $this;
70		}
71
72		if (!is_array($stack)) {
73		throw new \InvalidArgumentException('Expected argument to be of type array, but received ' . gettype($stack));
74		}
75
76		$this->stack = $stack;
77
78		return $returnResult ? $this->getResult() : $this;
79		}
80
81		/**
82		* Add arguments for the call to the CreatePaginator plugin.
83		*
84		* @see \Core\Controller\Plugin\CreatePaginator::__invoke()
85		*
86		* @param string $paginatorName
87		* @param array $defaultParams
88		* @param bool $usePostParams
89		* @param string $as The name of the key in the result array.
90		*
91		* @return self
92		*/
93		public function paginator($paginatorName, $defaultParams = [], $usePostParams = false, $as = 'paginator')
94		{
95		if (is_string($defaultParams)) {
96		$as = $defaultParams;
97		$defaultParams = [];
98		} else if (is_string($usePostParams)) {
99		$as = $usePostParams;
100		$usePostParams = false;
101		}
102
103		$this->stack['paginator'] = ['as' => $as, $paginatorName, $defaultParams, $usePostParams];
104		return $this;
105		}
106
107		/**
108		* Add arguments for the call to the SearchForm plugin.
109		*
110		* @see \Core\Controller\Plugin\SearchForm::get()
111		*
112		* @param $elementsFieldset
113		* @param null $buttonsFieldset
114		* @param string $as The name of the key in the result array.
115		*
116		* @return self
117		*/
118		public function form($elementsFieldset, $buttonsFieldset = null, $as = 'searchform')
119		{
120		if (null !== $buttonsFieldset && 0 === strpos($buttonsFieldset, '@')) {
121		$as = substr($buttonsFieldset, 1);
122		$buttonsFieldset = null;
123		}
124
125		$this->stack['form'] = ['as' => $as, $elementsFieldset, $buttonsFieldset];
126		return $this;
127		}
128
129		/**
130		* Add arguments for the call to the PaginatorParams plugin.
131		*
132		* @see \Core\Controller\Plugin\PaginationParams::getParams()
133		*
134		* @param $namespace
135		* @param array $defaults
136		*
137		* @return self
138		*/
139		public function params($namespace, $defaults = [ 'page' => 1 ])
140		{
141		$this->stack['params'] = [$namespace, $defaults];
142		return $this;
143		}
144
145		/**
146		* Calls the stacked plugins in the right order and returns the result array.
147		*
148		* The returned array can directly be returned from the controller or be used to populate a
149		* view model.
150		*
151		* The search form plugin is only called (and thus the form only present in the result array)
152		* if the request is NOT an ajax request. (as the form is never rerendered on ajax requests)
153		*
154		* @param null\|string $paginatorAlias Name of the paginator in the result array
155		* @param null\|string $formAlias Name of the search form in the result array
156		*
157		* @return array
158		*/
159		public function getResult($paginatorAlias = null, $formAlias = null)
160		{
161	View Code Duplication	if (null === $paginatorAlias) {
		0 ignored issues – show Duplication introduced 2016-05-13 09:17 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...
162		$paginatorAlias = isset($this->stack['paginator']['as'])
163		? $this->stack['paginator']['as']
164		: 'paginator';
165		}
166
167	View Code Duplication	if (null === $formAlias) {
		0 ignored issues – show Duplication introduced 2016-05-13 09:17 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...
168		$formAlias = isset($this->stack['form']['as']) ? $this->stack['form']['as'] : 'searchform';
169		}
170
171		/* @var \Zend\Mvc\Controller\AbstractController $controller
172		* @var \Zend\Http\Request $request */
173		$result = [];
174		$controller = $this->getController();
175		$request = $controller->getRequest();
176
177		if (isset($this->stack['params'])) {
178		$this->callPlugin('paginationParams', $this->stack['params']);
179		}
180
181		if (isset($this->stack['form']) && !$request->isXmlHttpRequest()) {
182		$result[$formAlias] = $this->callPlugin('searchform', $this->stack['form']);
183		}
184
185		if (isset($this->stack['paginator'])) {
186		$result[$paginatorAlias] = $this->callPlugin('paginator', $this->stack['paginator']);
187		}
188
189		return $result;
190		}
191
192		/**
193		* Calls an invokable controller plugin.
194		*
195		* @param string $name
196		* @param array $args
197		*
198		* @return mixed The return value of the called plugin.
199		*/
200		protected function callPlugin($name, $args)
201		{
202		/* @var \Zend\Mvc\Controller\AbstractController $controller */
203		$controller = $this->getController();
204		$plugin = $controller->plugin($name);
205
206		/* We remove the array entry with the key "as" here.
207		* because we want to keep it in the stack array */
208		unset($args['as']);
209
210		return call_user_func_array($plugin, $args);
211		}
212		}

cross-solution / YAWIK

Push — develop ( 7d6075...b57d28 )

PaginationBuilder::__invoke() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like