None::ensure() - Code Metrics - Dgame/php-optional - Measure and Improve Code Quality continuously with Scrutinizer

None::ensure() A
last analyzed 2019-11-26 10:57 UTC

↳ Parent: None

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Dgame\Optional;

use Exception;
use RuntimeException;

/**
 * Class None
 * @package Dgame\Optional
 */
final class None extends OptionalBase
{
    /**
     * @var None
     */
    private static $instance;

    /**
     * None constructor.
     */
    private function __construct()
    {
    }

    /**
     *
     */
    private function __clone()
    {
    }

    /**
     * @return None

     */
    public static function instance(): self
    {
        if (self::$instance === null) {
            self::$instance = new self();
        }

        return self::$instance;
    }

    /**
     * @param mixed $value
     *
     * @return bool
     */
    public function isSome(&$value = null): bool
    {
        $value = null;

        return false;
    }

    /**
     * @throws Exception
     */
    public function unwrap(): void
    {
        throw new RuntimeException('Access to None value');
    }

    /**
     * @param callable $callback
     *
     * @return Optional
     */
    public function ensure(callable $callback): Optional
    {
        return $this;
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());
}
    }

    /**
     * @param mixed $value
     *
     * @return bool
     */
    public function isEqualTo($value): bool
    {
        return $value == null;
    }

    /**
     * @param mixed $value
     *
     * @return bool
     */
    public function isIdenticalTo($value): bool
    {
        return $value === null;
    }
}


1			<?php
2
3			namespace Dgame\Optional;
4
5			use Exception;
6			use RuntimeException;
7
8			/**
9			* Class None
10			* @package Dgame\Optional
11			*/
12			final class None extends OptionalBase
13			{
14			/**
15			* @var None
16			*/
17			private static $instance;
18
19			/**
20			* None constructor.
21			*/
22			private function __construct()
23			{
24			}
25
26			/**
27			*
28			*/
29			private function __clone()
30			{
31			}
32
33			/**
34			* @return None
			0 ignored issues – show Documentation introduced 2017-04-30 20:51 UTC by Report Bug Copy Issue Report Should the return type not be `\self`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
35			*/
36			public static function instance(): self
37			{
38			if (self::$instance === null) {
39			self::$instance = new self();
40			}
41
42			return self::$instance;
43			}
44
45			/**
46			* @param mixed $value
47			*
48			* @return bool
49			*/
50			public function isSome(&$value = null): bool
51			{
52			$value = null;
53
54			return false;
55			}
56
57			/**
58			* @throws Exception
59			*/
60			public function unwrap(): void
61			{
62			throw new RuntimeException('Access to None value');
63			}
64
65			/**
66			* @param callable $callback
67			*
68			* @return Optional
69			*/
70			public function ensure(callable $callback): Optional
71			{
72			return $this;
			0 ignored issues – show Bug Best Practice introduced 2017-02-21 16:09 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Dgame\Optional\None`) is incompatible with the return type declared by the interface `Dgame\Optional\Optional::ensure` of type `self`. 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...
73			}
74
75			/**
76			* @param mixed $value
77			*
78			* @return bool
79			*/
80			public function isEqualTo($value): bool
81			{
82			return $value == null;
83			}
84
85			/**
86			* @param mixed $value
87			*
88			* @return bool
89			*/
90			public function isIdenticalTo($value): bool
91			{
92			return $value === null;
93			}
94			}
95

Dgame / php-optional

None::ensure() A last analyzed 2019-11-26 10:57 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

None::ensure() A
last analyzed 2019-11-26 10:57 UTC