GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.
Completed
Push — master ( da7376...acbc08 )
by Grzegorz
11:18
created

PwzValidator::getValidationOptions()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
dl 0
loc 4
rs 10
c 1
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
1
<?php
2
3
/*
4
 * This file is part of the Polish Validator Bundle package.
5
 *
6
 * (c) Grzegorz Koziński
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Kiczort\PolishValidatorBundle\Validator\Constraints;
13
14
use Kiczort\PolishValidator\ValidatorInterface;
15
use Symfony\Component\Validator\Constraint;
16
17
/**
18
 * @author Michał Mleczko <[email protected]>
19
 *
20
 * @Annotation
21
 */
22
class PwzValidator extends ValidatorAbstract
23
{
24
25
    /**
26
     * @return ValidatorInterface
27
     */
28
    public function getBaseValidator()
29
    {
30
        return new \Kiczort\PolishValidator\PwzValidator();
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \Kiczort\Poli...lidator\PwzValidator(); (Kiczort\PolishValidator\PwzValidator) is incompatible with the return type declared by the abstract method Kiczort\PolishValidatorB...tract::getBaseValidator of type Kiczort\PolishValidator\ValidatorInterface.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
31
    }
32
33
    /**
34
     * @param Constraint $constraint
35
     * @return array
36
     */
37
    public function getValidationOptions(Constraint $constraint)
38
    {
39
        return array();
40
    }
41
42
    /**
43
     * @return string
44
     */
45
    public function getValidatorConstraintClass()
46
    {
47
        return __NAMESPACE__ . '\Pwz';
48
    }
49
}
50