LogFileValidator::validate() - Code Metrics - Inspection of "Log file validator (#19)" - FriendsOfAkeneo/FOACronBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 407c5a...1fa54a )

by jean-marie

created 2017-03-13 23:17 UTC

LogFileValidator::validate() A

↳ Parent: LogFileValidator

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	2
eloc	6
nc	2
nop	2

<?php

namespace FOA\CronBundle\Validator\Constraints;

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

/**
 * @author JM Leroux <[email protected]>
 */
class LogFileValidator extends ConstraintValidator
{
    /** @var string */
    private $appDir;

    /**
     * @param string $appDir
     */
    public function __construct($appDir)
    {
        $this->appDir = $appDir;
    }

    /**
     * @param string $value
     * @param Constraint $constraint
     */
    public function validate($value, Constraint $constraint)
    {
        $allowedPattern = '#(app/logs?)|(^/tmp)#';
        if (!preg_match($allowedPattern, $value)) {
            $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.
    }
}
                ->setParameter('%string%', $value)
                ->addViolation();
        }
    }
}


1			<?php
2
3			namespace FOA\CronBundle\Validator\Constraints;
4
5			use Symfony\Component\Validator\Constraint;
6			use Symfony\Component\Validator\ConstraintValidator;
7
8			/**
9			* @author JM Leroux <[email protected]>
10			*/
11			class LogFileValidator extends ConstraintValidator
12			{
13			/** @var string */
14			private $appDir;
15
16			/**
17			* @param string $appDir
18			*/
19			public function __construct($appDir)
20			{
21			$this->appDir = $appDir;
22			}
23
24			/**
25			* @param string $value
26			* @param Constraint $constraint
27			*/
28			public function validate($value, Constraint $constraint)
29			{
30			$allowedPattern = '#(app/logs?)\|(^/tmp)#';
31			if (!preg_match($allowedPattern, $value)) {
32			$this->context->buildViolation($constraint->message)
			0 ignored issues – show Bug introduced 2017-03-10 21:42 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...
33			->setParameter('%string%', $value)
34			->addViolation();
35			}
36			}
37			}
38

FriendsOfAkeneo / FOACronBundle

Push — develop ( 407c5a...1fa54a )

LogFileValidator::validate() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like