EnumExtension::get() - Code Metrics - Inspection of "Expose Enum static methods to Twig" - Elao/PhpEnums - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#113)

unknown

created 2020-11-25 10:04 UTC

EnumExtension::get() A

↳ Parent: EnumExtension

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
cc	1
nc	1
nop	2

<?php

/*
 * This file is part of the "elao/enum" package.
 *
 * Copyright (C) Elao
 *
 * @author Elao <[email protected]>
 */

namespace Elao\Enum\Bridge\Twig\Extension;

use Elao\Enum\EnumInterface;
use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;

class EnumExtension extends AbstractExtension
{
    public function getFilters()
    {
        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());
}
            new TwigFunction('enum_get', [$this, 'get']),
            new TwigFunction('enum_values', [$this, 'values']),
            new TwigFunction('enum_accepts', [$this, 'accepts']),
            new TwigFunction('enum_instances', [$this, 'instances']),
        ];
    }

    public function get(string $className, $value): EnumInterface
    {
        $this->esureEnum($className);

        return \call_user_func([$className, 'get'], $value);
    }

    public function values(string $className): array
    {
        $this->esureEnum($className);

        return \call_user_func([$className, 'values']);
    }

    public function accepts(string $className, $value): bool
    {
        $this->esureEnum($className);

        return \call_user_func([$className, 'accepts'], $value);
    }

    public function instances(string $className): array
    {
        $this->esureEnum($className);

        return \call_user_func([$className, 'instances']);
    }

    private function esureEnum(string $className)
    {
        if (!is_a($className, EnumInterface::class)) {
            throw new Exception("$className is not an Enum.");
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the "elao/enum" package.
5			*
6			* Copyright (C) Elao
7			*
8			* @author Elao <[email protected]>
9			*/
10
11			namespace Elao\Enum\Bridge\Twig\Extension;
12
13			use Elao\Enum\EnumInterface;
14			use Twig\Extension\AbstractExtension;
15			use Twig\TwigFunction;
16
17			class EnumExtension extends AbstractExtension
18			{
19			public function getFilters()
20			{
21			return [
			0 ignored issues – show Bug Best Practice introduced 2020-11-25 10:05 UTC by Report Bug Copy Issue Report The return type of `return array(new \Twig\T...($this, 'instances')));` (`Twig\TwigFunction[]`) is incompatible with the return type declared by the interface `Twig\Extension\ExtensionInterface::getFilters` of type `Twig\TwigFilter[]`. 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...
22			new TwigFunction('enum_get', [$this, 'get']),
23			new TwigFunction('enum_values', [$this, 'values']),
24			new TwigFunction('enum_accepts', [$this, 'accepts']),
25			new TwigFunction('enum_instances', [$this, 'instances']),
26			];
27			}
28
29			public function get(string $className, $value): EnumInterface
30			{
31			$this->esureEnum($className);
32
33			return \call_user_func([$className, 'get'], $value);
34			}
35
36			public function values(string $className): array
37			{
38			$this->esureEnum($className);
39
40			return \call_user_func([$className, 'values']);
41			}
42
43			public function accepts(string $className, $value): bool
44			{
45			$this->esureEnum($className);
46
47			return \call_user_func([$className, 'accepts'], $value);
48			}
49
50			public function instances(string $className): array
51			{
52			$this->esureEnum($className);
53
54			return \call_user_func([$className, 'instances']);
55			}
56
57			private function esureEnum(string $className)
58			{
59			if (!is_a($className, EnumInterface::class)) {
60			throw new Exception("$className is not an Enum.");
61			}
62			}
63			}
64

Elao / PhpEnums

Pull Request — master (#113)

EnumExtension::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like