Completed
Branch V3 (ec4077)
by PastisD
11:29 queued 09:28
created

AppKernel::getCacheDir()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 0
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php
2
3
use Symfony\Component\HttpKernel\Kernel;
4
use Symfony\Component\Config\Loader\LoaderInterface;
5
6
class AppKernel extends Kernel
7
{
8
    public function registerBundles()
9
    {
10
        $bundles = [
11
          new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
12
          new Symfony\Bundle\SecurityBundle\SecurityBundle(),
13
          new Symfony\Bundle\TwigBundle\TwigBundle(),
14
          new Symfony\Bundle\MonologBundle\MonologBundle(),
15
          new Symfony\Bundle\SwiftmailerBundle\SwiftmailerBundle(),
16
          new Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
17
          new Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle(),
18
          new AppBundle\AppBundle(),
19
            /**
20
             * PhpFastCache Bundle
21
             */
22
          new Phpfastcache\Bundle\phpFastCacheBundle(),
23
        ];
24
25
        if (in_array($this->getEnvironment(), ['dev', 'test'], true)) {
26
            $bundles[] = new Symfony\Bundle\DebugBundle\DebugBundle();
27
            $bundles[] = new Symfony\Bundle\WebProfilerBundle\WebProfilerBundle();
28
            $bundles[] = new Sensio\Bundle\DistributionBundle\SensioDistributionBundle();
29
            $bundles[] = new Sensio\Bundle\GeneratorBundle\SensioGeneratorBundle();
30
        }
31
32
        return $bundles;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $bundles; (array<Symfony\Bundle\Fra...\SensioGeneratorBundle>) is incompatible with the return type declared by the interface Symfony\Component\HttpKe...erface::registerBundles of type Symfony\Component\HttpKe...undle\BundleInterface[].

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...
33
    }
34
35
    public function getRootDir()
36
    {
37
        return __DIR__;
38
    }
39
40
    public function getCacheDir()
41
    {
42
        return dirname(__DIR__).'/var/cache/'.$this->getEnvironment();
43
    }
44
45
    public function getLogDir()
46
    {
47
        return dirname(__DIR__).'/var/logs';
48
    }
49
50
    public function registerContainerConfiguration(LoaderInterface $loader)
51
    {
52
        $loader->load($this->getRootDir().'/config/config_'.$this->getEnvironment().'.yml');
53
    }
54
}
55