1 | <?php |
||
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) |
||
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) |
||
79 | |||
80 | /** |
||
81 | * Returns route by its identifier |
||
82 | * |
||
83 | * @param string $identifier |
||
84 | * |
||
85 | * @return SymfonyRoute |
||
86 | */ |
||
87 | public function getRouteByName($identifier) |
||
98 | |||
99 | public function getRoutesByNames($names, $parameters = []) |
||
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) |
||
118 | |||
119 | private function createRoute(Route $resource): SymfonyRoute |
||
132 | |||
133 | private function getRouteGenerationSettings(Route $resource): array |
||
145 | |||
146 | private function getPath(Route $resource, string $pattern): string |
||
154 | } |
||
155 |
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:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.