AllowedCommandValidator::validate() - Code Metrics - fattouchsquall/AMFConsoleBundle - Measure and Improve Code Quality continuously with Scrutinizer

AllowedCommandValidator::validate() A
last analyzed 2016-12-15 14:00 UTC

↳ Parent: AllowedCommandValidator

Complexity

Conditions	4
Paths	4

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	17
c	0
b	0
f	0
rs	9.2
cc	4
eloc	9
nc	4
nop	2

<?php

/*
 * This file is part of the AMFConsoleBundle.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace AMF\ConsoleBundle\Validator\Constraints;

use Symfony\Component\Validator\ConstraintValidator;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Exception\UnexpectedTypeException;

/**
 * Apply valid command constraint on posted command.
 *
 * @author Amine Fattouch <[email protected]>
 */
class AllowedCommandValidator extends ConstraintValidator
{
    /**
     * @var array
     */
    private $allowedPrefixes;

    /**
     * Constructor class.
     *
     * @param array $allowedPrefixes List of allowed prefixes.
     */
    public function __construct(array $allowedPrefixes = [])
    {
        $this->allowedPrefixes = $allowedPrefixes;
    }

    /**
     * {@inheritdoc}
     */
    public function validate($property, Constraint $constraint)
    {
        if (!$constraint instanceof AllowedCommand) {
            throw new UnexpectedTypeException($constraint, AllowedCommand::class);
        }

        $commandParts = explode(':', $property);

        if (empty($commandParts) === false) {
            if (in_array($commandParts[0], $this->allowedPrefixes)) {
                return;
            }
        }

        $this->context->buildViolation($constraint->message)
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.
    }
}
                        ->addViolation();
    }
}


1			<?php
2
3			/*
4			* This file is part of the AMFConsoleBundle.
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace AMF\ConsoleBundle\Validator\Constraints;
11
12			use Symfony\Component\Validator\ConstraintValidator;
13			use Symfony\Component\Validator\Constraint;
14			use Symfony\Component\Validator\Exception\UnexpectedTypeException;
15
16			/**
17			* Apply valid command constraint on posted command.
18			*
19			* @author Amine Fattouch <[email protected]>
20			*/
21			class AllowedCommandValidator extends ConstraintValidator
22			{
23			/**
24			* @var array
25			*/
26			private $allowedPrefixes;
27
28			/**
29			* Constructor class.
30			*
31			* @param array $allowedPrefixes List of allowed prefixes.
32			*/
33			public function __construct(array $allowedPrefixes = [])
34			{
35			$this->allowedPrefixes = $allowedPrefixes;
36			}
37
38			/**
39			* {@inheritdoc}
40			*/
41			public function validate($property, Constraint $constraint)
42			{
43			if (!$constraint instanceof AllowedCommand) {
44			throw new UnexpectedTypeException($constraint, AllowedCommand::class);
45			}
46
47			$commandParts = explode(':', $property);
48
49			if (empty($commandParts) === false) {
50			if (in_array($commandParts[0], $this->allowedPrefixes)) {
51			return;
52			}
53			}
54
55			$this->context->buildViolation($constraint->message)
			0 ignored issues – show Bug introduced 2016-12-06 13:37 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Valida...ecutionContextInterface` as the method `buildViolation()` does only exist in the following implementations of said interface: `Symfony\Component\Valida...ontext\ExecutionContext`, `Symfony\Component\Valida...\LegacyExecutionContext`. 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...
56			->addViolation();
57			}
58			}
59

fattouchsquall / AMFConsoleBundle

AllowedCommandValidator::validate() A last analyzed 2016-12-15 14:00 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

AllowedCommandValidator::validate() A
last analyzed 2016-12-15 14:00 UTC