AbstractPackageRendererServiceProvider::getExtensions() - Code Metrics - Inspection of "Migrating to 2.0: Mouf agnostic version" - thecodingmachine/html.renderer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 1.2 (#12)

by David

created 2018-08-19 20:40 UTC

getExtensions() A

↳ Parent: AbstractPackageRendererServiceProvider

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
nc	1
cc	1
nop	0

<?php


namespace Mouf\Html\Renderer;

use Interop\Container\ServiceProviderInterface;
use Psr\Container\ContainerInterface;
use Psr\SimpleCache\CacheInterface;

/**
 * This class can be extended to implement easily a service provider that creates "package level" renderers.
 */
abstract class AbstractPackageRendererServiceProvider implements ServiceProviderInterface
{
    /**
     * Returns the path to the templates directory.
     *
     * @return string
     */
    abstract public static function getTemplateDirectory(): string;

    public static function getPriority(): int
    {
        return 0;
    }

    /**
     * Returns a list of all container entries registered by this service provider.
     *
     * - the key is the entry name
     * - the value is a callable that will return the entry, aka the **factory**
     *
     * Factories have the following signature:
     *        function(\Psr\Container\ContainerInterface $container)
     *
     * @return callable[]
     */
    public function getFactories()
    {
        return [
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());
}
            'packageRenderer_'.static::getTemplateDirectory() => [static::class, 'createRenderer']
        ];
    }

    public static function createRenderer(ContainerInterface $container): FileBasedRenderer
    {
        return new FileBasedRenderer(static::getTemplateDirectory(), $container->get(CacheInterface::class), $container, $container->get(\Twig_Environment::class));
    }

    /**
     * Returns a list of all container entries extended by this service provider.
     *
     * - the key is the entry name
     * - the value is a callable that will return the modified entry
     *
     * Callables have the following signature:
     *        function(Psr\Container\ContainerInterface $container, $previous)
     *     or function(Psr\Container\ContainerInterface $container, $previous = null)
     *
     * About factories parameters:
     *
     * - the container (instance of `Psr\Container\ContainerInterface`)
     * - the entry to be extended. If the entry to be extended does not exist and the parameter is nullable, `null` will be passed.
     *
     * @return callable[]
     */
    public function getExtensions()
    {
        return [
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());
}
            'packageRenderers' => [static::class, 'extendPackageRenderersList']
        ];
    }

    public static function extendPackageRenderersList(ContainerInterface $container, \SplPriorityQueue $priorityQueue): \SplPriorityQueue

    {
        $priorityQueue->insert('packageRenderer_'.static::getTemplateDirectory(), static::getPriority());
        return $priorityQueue;
    }
}


1			<?php
2
3
4			namespace Mouf\Html\Renderer;
5
6			use Interop\Container\ServiceProviderInterface;
7			use Psr\Container\ContainerInterface;
8			use Psr\SimpleCache\CacheInterface;
9
10			/**
11			* This class can be extended to implement easily a service provider that creates "package level" renderers.
12			*/
13			abstract class AbstractPackageRendererServiceProvider implements ServiceProviderInterface
14			{
15			/**
16			* Returns the path to the templates directory.
17			*
18			* @return string
19			*/
20			abstract public static function getTemplateDirectory(): string;
21
22			public static function getPriority(): int
23			{
24			return 0;
25			}
26
27			/**
28			* Returns a list of all container entries registered by this service provider.
29			*
30			* - the key is the entry name
31			* - the value is a callable that will return the entry, aka the factory
32			*
33			* Factories have the following signature:
34			* function(\Psr\Container\ContainerInterface $container)
35			*
36			* @return callable[]
37			*/
38			public function getFactories()
39			{
40			return [
			0 ignored issues – show Bug Best Practice introduced 2018-08-19 20:43 UTC by Report Bug Copy Issue Report The return type of `return array('packageRen...ss, 'createRenderer'));` (`array<string,string[]>`) is incompatible with the return type declared by the interface `Interop\Container\Servic...Interface::getFactories` of type `callable[]`. 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...
41			'packageRenderer_'.static::getTemplateDirectory() => [static::class, 'createRenderer']
42			];
43			}
44
45			public static function createRenderer(ContainerInterface $container): FileBasedRenderer
46			{
47			return new FileBasedRenderer(static::getTemplateDirectory(), $container->get(CacheInterface::class), $container, $container->get(\Twig_Environment::class));
48			}
49
50			/**
51			* Returns a list of all container entries extended by this service provider.
52			*
53			* - the key is the entry name
54			* - the value is a callable that will return the modified entry
55			*
56			* Callables have the following signature:
57			* function(Psr\Container\ContainerInterface $container, $previous)
58			* or function(Psr\Container\ContainerInterface $container, $previous = null)
59			*
60			* About factories parameters:
61			*
62			* - the container (instance of `Psr\Container\ContainerInterface`)
63			* - the entry to be extended. If the entry to be extended does not exist and the parameter is nullable, `null` will be passed.
64			*
65			* @return callable[]
66			*/
67			public function getExtensions()
68			{
69			return [
			0 ignored issues – show Bug Best Practice introduced 2018-08-19 20:43 UTC by Report Bug Copy Issue Report The return type of `return array('packageRen...ackageRenderersList'));` (`array<string,string[]>`) is incompatible with the return type declared by the interface `Interop\Container\Servic...nterface::getExtensions` of type `callable[]`. 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...
70			'packageRenderers' => [static::class, 'extendPackageRenderersList']
71			];
72			}
73
74			public static function extendPackageRenderersList(ContainerInterface $container, \SplPriorityQueue $priorityQueue): \SplPriorityQueue
			0 ignored issues – show Unused Code introduced 2018-08-19 20:43 UTC by Report Bug Copy Issue Report The parameter `$container` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
75			{
76			$priorityQueue->insert('packageRenderer_'.static::getTemplateDirectory(), static::getPriority());
77			return $priorityQueue;
78			}
79			}
80

thecodingmachine / html.renderer

Pull Request — 1.2 (#12)

getExtensions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like