InArray::canHandle() - Code Metrics - Inspection of "Allow custom rules" - bramstroker/zf2-form - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#42)

unknown

created 2016-09-12 14:43 UTC

InArray::canHandle() A

↳ Parent: InArray

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * InArray
 *
 * @category  StrokerForm\Renderer\JqueryValidate\Rule
 * @package   StrokerForm\Renderer\JqueryValidate\Rule
 * @copyright 2013 ACSI Holding bv (http://www.acsi.eu)
 * @version   SVN: $Id$
 */

namespace StrokerForm\Renderer\JqueryValidate\Rule;

use Zend\Form\ElementInterface;
use Zend\Validator\ValidatorInterface;
use Zend\Validator\InArray as InArrayValidator;

class InArray extends AbstractRule
{
    /**
     * Get the validation rules
     *
     * @param  \Zend\Validator\ValidatorInterface $validator
     * @param \Zend\Form\ElementInterface         $element
     *
     * @return array
     */
    public function getRules(ValidatorInterface $validator, ElementInterface $element = null)
    {
        // Javascript doesn't support associative arrays. Therefore, check if the array is associative,
        // and if so, transform it to a non-associative one.
        if (array_keys($validator->getHaystack()) !== range(0, count($validator->getHaystack()) - 1)) {
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.
    }
}
            return array('in_array' => array_values($validator->getHaystack()));
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.
    }
}
        }

        return array('in_array' => (array)$validator->getHaystack());
    }

    /**
     * Get the validation message
     *
     * @param  \Zend\Validator\ValidatorInterface $validator
     *
     * @return string
     */
    public function getMessages(ValidatorInterface $validator)
    {
        return array(
            'in_array' =>
                $this->translateMessage('The input is not a valid option')
        );
    }

    /**
     * Whether this rule supports certain validators
     *
     * @param ValidatorInterface $validator
     * @return mixed
     */
    public function canHandle(ValidatorInterface $validator)
    {
        return $validator instanceof InArrayValidator;
    }
}


GitHub Access Token became invalid

Pull Request — master (#42)

InArray::canHandle() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2			/**
3			* InArray
4			*
5			* @category StrokerForm\Renderer\JqueryValidate\Rule
6			* @package StrokerForm\Renderer\JqueryValidate\Rule
7			* @copyright 2013 ACSI Holding bv (http://www.acsi.eu)
8			* @version SVN: $Id$
9			*/
10
11			namespace StrokerForm\Renderer\JqueryValidate\Rule;
12
13			use Zend\Form\ElementInterface;
14			use Zend\Validator\ValidatorInterface;
15			use Zend\Validator\InArray as InArrayValidator;
16
17			class InArray extends AbstractRule
18			{
19			/**
20			* Get the validation rules
21			*
22			* @param \Zend\Validator\ValidatorInterface $validator
23			* @param \Zend\Form\ElementInterface $element
24			*
25			* @return array
26			*/
27			public function getRules(ValidatorInterface $validator, ElementInterface $element = null)
28			{
29			// Javascript doesn't support associative arrays. Therefore, check if the array is associative,
30			// and if so, transform it to a non-associative one.
31			if (array_keys($validator->getHaystack()) !== range(0, count($validator->getHaystack()) - 1)) {
			0 ignored issues – show Bug introduced 2016-02-20 09:35 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Validator\ValidatorInterface` as the method `getHaystack()` does only exist in the following implementations of said interface: `Zend\Validator\InArray`. 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...
32			return array('in_array' => array_values($validator->getHaystack()));
			0 ignored issues – show Bug introduced 2016-02-20 09:35 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Validator\ValidatorInterface` as the method `getHaystack()` does only exist in the following implementations of said interface: `Zend\Validator\InArray`. 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...
33			}
34
35			return array('in_array' => (array)$validator->getHaystack());
36			}
37
38			/**
39			* Get the validation message
40			*
41			* @param \Zend\Validator\ValidatorInterface $validator
42			*
43			* @return string
44			*/
45			public function getMessages(ValidatorInterface $validator)
46			{
47			return array(
48			'in_array' =>
49			$this->translateMessage('The input is not a valid option')
50			);
51			}
52
53			/**
54			* Whether this rule supports certain validators
55			*
56			* @param ValidatorInterface $validator
57			* @return mixed
58			*/
59			public function canHandle(ValidatorInterface $validator)
60			{
61			return $validator instanceof InArrayValidator;
62			}
63			}
64

bramstroker / zf2-form

GitHub Access Token became invalid

Pull Request — master (#42)

InArray::canHandle() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like