PSR16CacheSuffixProvider::getSuffixes() - Code Metrics - bpolaszek/hostname-extractor - Measure and Improve Code Quality continuously with Scrutinizer

PSR16CacheSuffixProvider::getSuffixes() A
last analyzed 2019-04-23 14:44 UTC

↳ Parent: PSR16CacheSuffixProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php

namespace BenTools\HostnameExtractor\SuffixProvider;

use Psr\SimpleCache\CacheInterface;

final class PSR16CacheSuffixProvider implements SuffixProviderInterface
{
    /**
     * @var CacheInterface
     */
    private $cache;

    /**
     * @var PublicSuffixProvider
     */
    private $suffixProvider;

    /**
     * @var string
     */
    private $key;

    /**
     *  constructor.
     * @param CacheInterface       $cache
     * @param PublicSuffixProvider $suffixProvider
     */
    public function __construct(
        CacheInterface $cache,
        SuffixProviderInterface $suffixProvider,
        string $key = 'suffix_list'
    ) {
        $this->cache = $cache;
        $this->suffixProvider = $suffixProvider;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        $this->key = $key;
    }

    /**
     * @inheritDoc
     */
    public function getSuffixes(): iterable
    {
        if (!$this->cache->has($this->key)) {
            $suffixes = \iterable_to_array($this->suffixProvider->getSuffixes());
            $this->cache->set($this->key, $suffixes);
            return $suffixes;
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());
}
        }
        return $this->cache->get($this->key);
    }
}


1			<?php
2
3			namespace BenTools\HostnameExtractor\SuffixProvider;
4
5			use Psr\SimpleCache\CacheInterface;
6
7			final class PSR16CacheSuffixProvider implements SuffixProviderInterface
8			{
9			/**
10			* @var CacheInterface
11			*/
12			private $cache;
13
14			/**
15			* @var PublicSuffixProvider
16			*/
17			private $suffixProvider;
18
19			/**
20			* @var string
21			*/
22			private $key;
23
24			/**
25			* constructor.
26			* @param CacheInterface $cache
27			* @param PublicSuffixProvider $suffixProvider
28			*/
29			public function __construct(
30			CacheInterface $cache,
31			SuffixProviderInterface $suffixProvider,
32			string $key = 'suffix_list'
33			) {
34			$this->cache = $cache;
35			$this->suffixProvider = $suffixProvider;
			0 ignored issues – show Documentation Bug introduced 2018-06-18 14:01 UTC by Report Bug Copy Issue Report `$suffixProvider` is of type `object<BenTools\Hostname...uffixProviderInterface>`, but the property `$suffixProvider` was declared to be of type `object<BenTools\Hostname...r\PublicSuffixProvider>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
36			$this->key = $key;
37			}
38
39			/**
40			* @inheritDoc
41			*/
42			public function getSuffixes(): iterable
43			{
44			if (!$this->cache->has($this->key)) {
45			$suffixes = \iterable_to_array($this->suffixProvider->getSuffixes());
46			$this->cache->set($this->key, $suffixes);
47			return $suffixes;
			0 ignored issues – show Bug Best Practice introduced 2017-12-22 11:24 UTC by Report Bug Copy Issue Report The return type of `return $suffixes;` (`array`) is incompatible with the return type declared by the interface `BenTools\HostnameExtract...rInterface::getSuffixes` of type `BenTools\HostnameExtractor\SuffixProvider\iterable`. 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...
48			}
49			return $this->cache->get($this->key);
50			}
51			}
52

bpolaszek / hostname-extractor

PSR16CacheSuffixProvider::getSuffixes() A last analyzed 2019-04-23 14:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PSR16CacheSuffixProvider::getSuffixes() A
last analyzed 2019-04-23 14:44 UTC