SearchForm::renderElements() - 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

SearchForm::renderElements() C

↳ Parent: SearchForm

Complexity

Conditions	14
Paths	61

Size

Total Lines	54
Code Lines	35

Duplication

Lines	3
Ratio	5.56 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	3
loc	54
rs	6.7343
cc	14
eloc	35
nc	61
nop	4

How to fix Long Method Complexity

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

use Core\Form\Element\ViewHelperProviderInterface;
use Core\Form\TextSearchFormFieldset;
use Core\Form\ViewPartialProviderInterface;
use Zend\Form\FieldsetInterface;
use Zend\Form\FormInterface;
use Zend\Form\View\Helper\Form;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

/**
 * ${CARET}
 * 
 * @author Mathias Gelhausen <[email protected]>
 * @todo write test 
 */
class SearchForm extends Form
{

    /**
     * Invoke as function
     *
     * @param  null|FormInterface $form
     * @param array $colMap

     * @return Form|string
     */
    public function __invoke(FormInterface $form = null, $colMap=null)
    {
        if (!$form) {
            return $this;
        }

        return $this->render($form, $colMap);
    }

    public function render(FormInterface $form, $colMap=null, $buttonsSpan = null)
    {
        $headscript = $this->getView()->plugin('headscript');
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.
    }
}
        $basepath   = $this->getView()->plugin('basepath');
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.
    }
}

        $headscript->appendFile($basepath('Core/js/core.searchform.js'));

        if (is_int($colMap)) {
            $buttonsSpan = $colMap;
            $colMap = null;
        }

        if ($form instanceOf ViewPartialProviderInterface) {

            return $this->getView()->partial($form->getViewPartial(), [ 'element' => $form, 'colMap' => $colMap, 'buttonsSpan' => $buttonsSpan ]);
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.
    }
}
        }

        $elements = $form->getElements();
        $buttons  = $form->getButtons();
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.
    }
}

        $content = $this->renderElements($elements, $buttons, $colMap, $buttonsSpan);

        return $this->openTag($form)
             . '<div class="row" style="padding: 0 15px;">'
             . $content . '</div>' . $this->closeTag();

    }

    public function renderButtons($fieldset)
    {
        return $this->renderElements($fieldset, true);
    }

    public function renderElements($fieldset, $buttonsFieldset, $colMap = null, $buttonsSpan = null)
    {
        if ($fieldset instanceOf ViewPartialProviderInterface) {

            return $this->getView()->partial($fieldset->getViewPartial(), [ 'element' => $fieldset, 'colMap' => $colMap, 'buttonsSpan' => $buttonsSpan ]);
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 (true !== $buttonsFieldset && null === $colMap) {
            $colMap = $fieldset->getColumnMap();
        }

        $formElement = $this->getView()->plugin('formElement');
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.
    }
}
        $content = ''; $buttonsRendered = false; $i=0;
        foreach ($fieldset as $element) {
            if (true === $buttonsFieldset) {
                $content .= $formElement($element);
                continue;
            }

            if (isset($colMap[$element->getName()])) {
                $cols = $colMap[$element->getName()];

            } else if (isset($colMap[$i])) {
                $cols = $colMap[$i];

            } else {
                $cols = $element->getOption('span') ?: 12;
            }

            if ($fieldset instanceOf TextSearchFormFieldset && $element->getName() == $fieldset->getButtonElement()) {
                $content.='<div class="input-group col-md-' . $cols . '">'
                              . $formElement($element)
                              . '<div class="input-group-btn search-form-buttons" style="width: 0px;">'
                              . $this->renderElements($buttonsFieldset, true) . '</div>'
                              . '</div>';
                $buttonsRendered = true;
            } else {
                $content .= '<div class="input-group col-md-' . $cols . '">'
                          . $formElement($element)
                          . '</div>';
            }

            $i += 1;
        }

        if (true !== $buttonsFieldset && !$buttonsRendered) {
            if (null === $buttonsSpan) {
                $buttonsSpan = $buttonsFieldset->getSpan();
            }
            $content .= '<div class="input-group search-form-buttons col-md-' . $buttonsSpan . ' text-right">'
                      . '<div class="btn-group">' . $this->renderElements($buttonsFieldset, true) .'</div></div>';
        }

        return $content;
    }
}

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\Form\View\Helper;
12
13		use Core\Form\Element\ViewHelperProviderInterface;
14		use Core\Form\TextSearchFormFieldset;
15		use Core\Form\ViewPartialProviderInterface;
16		use Zend\Form\FieldsetInterface;
17		use Zend\Form\FormInterface;
18		use Zend\Form\View\Helper\Form;
		0 ignored issues – show Bug introduced 2016-04-07 17:16 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Core\Form\View\Helper\Form`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
19
20		/**
21		* ${CARET}
22		*
23		* @author Mathias Gelhausen <[email protected]>
24		* @todo write test
25		*/
26		class SearchForm extends Form
27		{
28
29		/**
30		* Invoke as function
31		*
32		* @param null\|FormInterface $form
33		* @param array $colMap
		0 ignored issues – show Documentation introduced 2016-05-13 09:17 UTC by Report Bug Copy Issue Report Should the type for parameter `$colMap` not be `array\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
34		* @return Form\|string
35		*/
36		public function __invoke(FormInterface $form = null, $colMap=null)
37		{
38		if (!$form) {
39		return $this;
40		}
41
42		return $this->render($form, $colMap);
43		}
44
45		public function render(FormInterface $form, $colMap=null, $buttonsSpan = null)
46		{
47		$headscript = $this->getView()->plugin('headscript');
		0 ignored issues – show Bug introduced 2016-05-13 09:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\View\Renderer\RendererInterface` as the method `plugin()` does only exist in the following implementations of said interface: `Zend\View\Renderer\PhpRenderer`. 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...
48		$basepath = $this->getView()->plugin('basepath');
		0 ignored issues – show Bug introduced 2016-05-13 09:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\View\Renderer\RendererInterface` as the method `plugin()` does only exist in the following implementations of said interface: `Zend\View\Renderer\PhpRenderer`. 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...
49
50		$headscript->appendFile($basepath('Core/js/core.searchform.js'));
51
52		if (is_int($colMap)) {
53		$buttonsSpan = $colMap;
54		$colMap = null;
55		}
56
57	View Code Duplication	if ($form instanceOf ViewPartialProviderInterface) {
		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...
58		return $this->getView()->partial($form->getViewPartial(), [ 'element' => $form, 'colMap' => $colMap, 'buttonsSpan' => $buttonsSpan ]);
		0 ignored issues – show Bug introduced 2016-05-13 09:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\View\Renderer\RendererInterface` as the method `partial()` does only exist in the following implementations of said interface: `Zend\View\Renderer\PhpRenderer`. 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...
59		}
60
61		$elements = $form->getElements();
62		$buttons = $form->getButtons();
		0 ignored issues – show Bug introduced 2016-05-13 09:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Form\FormInterface` as the method `getButtons()` does only exist in the following implementations of said interface: `Core\Form\TextSearchForm`, `Jobs\Form\AdminSearchForm`. 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...
63
64		$content = $this->renderElements($elements, $buttons, $colMap, $buttonsSpan);
65
66		return $this->openTag($form)
67		. '<div class="row" style="padding: 0 15px;">'
68		. $content . '</div>' . $this->closeTag();
69
70		}
71
72		public function renderButtons($fieldset)
73		{
74		return $this->renderElements($fieldset, true);
75		}
76
77		public function renderElements($fieldset, $buttonsFieldset, $colMap = null, $buttonsSpan = null)
78		{
79	View Code Duplication	if ($fieldset instanceOf ViewPartialProviderInterface) {
		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...
80		return $this->getView()->partial($fieldset->getViewPartial(), [ 'element' => $fieldset, 'colMap' => $colMap, 'buttonsSpan' => $buttonsSpan ]);
		0 ignored issues – show Bug introduced 2016-05-13 09:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\View\Renderer\RendererInterface` as the method `partial()` does only exist in the following implementations of said interface: `Zend\View\Renderer\PhpRenderer`. 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...
81		}
82
83		if (true !== $buttonsFieldset && null === $colMap) {
84		$colMap = $fieldset->getColumnMap();
85		}
86
87		$formElement = $this->getView()->plugin('formElement');
		0 ignored issues – show Bug introduced 2016-05-13 09:17 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\View\Renderer\RendererInterface` as the method `plugin()` does only exist in the following implementations of said interface: `Zend\View\Renderer\PhpRenderer`. 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...
88		$content = ''; $buttonsRendered = false; $i=0;
89		foreach ($fieldset as $element) {
90		if (true === $buttonsFieldset) {
91		$content .= $formElement($element);
92		continue;
93		}
94
95		if (isset($colMap[$element->getName()])) {
96		$cols = $colMap[$element->getName()];
97
98		} else if (isset($colMap[$i])) {
99		$cols = $colMap[$i];
100
101		} else {
102		$cols = $element->getOption('span') ?: 12;
103		}
104
105		if ($fieldset instanceOf TextSearchFormFieldset && $element->getName() == $fieldset->getButtonElement()) {
106		$content.='<div class="input-group col-md-' . $cols . '">'
107		. $formElement($element)
108		. '<div class="input-group-btn search-form-buttons" style="width: 0px;">'
109		. $this->renderElements($buttonsFieldset, true) . '</div>'
110		. '</div>';
111		$buttonsRendered = true;
112		} else {
113		$content .= '<div class="input-group col-md-' . $cols . '">'
114		. $formElement($element)
115		. '</div>';
116		}
117
118		$i += 1;
119		}
120
121		if (true !== $buttonsFieldset && !$buttonsRendered) {
122		if (null === $buttonsSpan) {
123		$buttonsSpan = $buttonsFieldset->getSpan();
124		}
125		$content .= '<div class="input-group search-form-buttons col-md-' . $buttonsSpan . ' text-right">'
126		. '<div class="btn-group">' . $this->renderElements($buttonsFieldset, true) .'</div></div>';
127		}
128
129		return $content;
130		}
131		}

cross-solution / YAWIK

Push — develop ( 7d6075...b57d28 )

SearchForm::renderElements() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like