RouteProvider::getRouteByName()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 11
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 11
rs 9.4285
c 0
b 0
f 0
cc 2
eloc 6
nc 2
nop 1
1
<?php
2
/*
3
 * WellCommerce Open-Source E-Commerce Platform
4
 *
5
 * This file is part of the WellCommerce package.
6
 *
7
 * (c) Adam Piotrowski <[email protected]>
8
 *
9
 * For the full copyright and license information,
10
 * please view the LICENSE file that was distributed with this source code.
11
 */
12
13
namespace WellCommerce\Bundle\CoreBundle\Provider;
14
15
use Doctrine\Common\Collections\ArrayCollection;
16
use Doctrine\Common\Util\ClassUtils;
17
use Symfony\Cmf\Component\Routing\RouteProviderInterface;
18
use Symfony\Component\HttpFoundation\Request;
19
use Symfony\Component\Routing\Route as SymfonyRoute;
20
use Symfony\Component\Routing\RouteCollection;
21
use WellCommerce\Bundle\CoreBundle\Doctrine\Repository\RepositoryInterface;
22
use WellCommerce\Bundle\CoreBundle\Entity\Route;
23
24
/**
25
 * Class RouteProvider
26
 *
27
 * @author  Adam Piotrowski <[email protected]>
28
 */
29
final class RouteProvider implements RouteProviderInterface
30
{
31
    const DYNAMIC_PREFIX        = 'dynamic_';
32
    const PATH_PARAMS_SEPARATOR = ',';
33
    
34
    /**
35
     * @var array
36
     */
37
    private $routingGeneratorMap;
38
    
39
    /**
40
     * @var RepositoryInterface
41
     */
42
    private $repository;
43
    
44
    /**
45
     * RouteProvider constructor.
46
     *
47
     * @param array               $routingGeneratorMap
48
     * @param RepositoryInterface $repository
49
     */
50
    public function __construct(array $routingGeneratorMap = [], RepositoryInterface $repository)
51
    {
52
        $this->routingGeneratorMap = $routingGeneratorMap;
53
        $this->repository          = $repository;
54
    }
55
    
56
    /**
57
     * Returns route collection for current request
58
     *
59
     * @param Request $request
60
     *
61
     * @return RouteCollection
62
     */
63
    public function getRouteCollectionForRequest(Request $request)
64
    {
65
        $collection = new RouteCollection();
66
        $path       = $this->getNormalizedPath($request);
67
        $resource   = $this->repository->findOneBy(['path' => $path]);
68
        
69
        if ($resource) {
70
            $route = $this->createRoute($resource);
71
            $collection->add(
72
                self::DYNAMIC_PREFIX . $resource->getId(),
73
                $route
74
            );
75
        }
76
        
77
        return $collection;
78
    }
79
    
80
    /**
81
     * Returns route by its identifier
82
     *
83
     * @param string $identifier
84
     *
85
     * @return SymfonyRoute
86
     */
87
    public function getRouteByName($identifier)
88
    {
89
        $id       = str_replace(self::DYNAMIC_PREFIX, '', $identifier);
90
        $resource = $this->repository->find($id);
91
        
92
        if ($resource instanceof Route) {
93
            return $this->createRoute($resource);
94
        }
95
        
96
        return null;
97
    }
98
    
99
    public function getRoutesByNames($names, $parameters = [])
100
    {
101
        return new ArrayCollection();
0 ignored issues
show
Bug Best Practice introduced by Adam Piotrowski
The return type of return new \Doctrine\Com...ions\ArrayCollection(); (Doctrine\Common\Collections\ArrayCollection) is incompatible with the return type declared by the interface Symfony\Cmf\Component\Ro...rface::getRoutesByNames of type Symfony\Component\Routing\Route[].

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...
102
    }
103
    
104
    /**
105
     * Returns normalized path used in resource query
106
     *
107
     * @param Request $request
108
     *
109
     * @return mixed
110
     */
111
    private function getNormalizedPath(Request $request)
112
    {
113
        $path  = ltrim($request->getPathInfo(), '/');
114
        $paths = explode(self::PATH_PARAMS_SEPARATOR, $path);
115
        
116
        return current($paths);
117
    }
118
    
119
    private function createRoute(Route $resource): SymfonyRoute
120
    {
121
        $settings                        = $this->getRouteGenerationSettings($resource);
122
        $settings['defaults']['id']      = $resource->getIdentifier()->getId();
123
        $settings['defaults']['_locale'] = $resource->getLocale();
124
        
125
        return new SymfonyRoute(
126
            $this->getPath($resource, $settings['pattern']),
127
            $settings['defaults'],
128
            $settings['requirements'],
129
            $settings['options']
130
        );
131
    }
132
    
133
    private function getRouteGenerationSettings(Route $resource): array
134
    {
135
        $class = ClassUtils::getRealClass(get_class($resource));
136
        
137
        if (!isset($this->routingGeneratorMap[$class])) {
138
            throw new \InvalidArgumentException(
139
                sprintf('Route resource of type "%s" has invalid/missing configuration.', $class)
140
            );
141
        }
142
        
143
        return $this->routingGeneratorMap[$class];
144
    }
145
    
146
    private function getPath(Route $resource, string $pattern): string
147
    {
148
        if (strlen($pattern)) {
149
            return $resource->getPath() . self::PATH_PARAMS_SEPARATOR . $pattern;
150
        }
151
        
152
        return $resource->getPath();
153
    }
154
}
155