SiteAccessService::getAll() - Code Metrics - Inspection of "getCurrent on SiteAccessService" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dynamic_siteaccesses ( 16c7ff )

unknown

created 2019-10-16 11:41 UTC

SiteAccessService::getAll() A

↳ Parent: SiteAccessService

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
declare(strict_types=1);

namespace eZ\Publish\Core\MVC\Symfony\SiteAccess;

use AppendIterator;
use eZ\Publish\Core\Base\Exceptions\NotFoundException;
use eZ\Publish\Core\MVC\Symfony\SiteAccess;
use eZ\Publish\Core\MVC\Symfony\SiteAccessGroup;

class SiteAccessService implements SiteAccessServiceInterface
{
    /**
     * @var \eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessProviderInterface[]
     */
    private $providers;

    /**
     * @var \eZ\Publish\Core\MVC\Symfony\SiteAccessGroup[]
     */
    private $siteAccessGroups = [];

    public function __construct(iterable $providers, array $siteAccessGroups)
    {
        $this->providers = $providers;

        foreach ($siteAccessGroups as $name) {
            $this->siteAccessGroups[] = new SiteAccessGroup($name);
        }
    }

    public function exists(string $name): bool
    {
        foreach ($this->providers as $provider) {
            if ($provider->isDefined($name)) {
                return true;
            }
        }

        return false;
    }

    public function get(string $name): SiteAccess
    {
        foreach ($this->providers as $provider) {
            if ($provider->isDefined($name)) {
                return $provider->getSiteAccess($name);
            }
        }

        throw new NotFoundException('SiteAccess', $name);
    }

    public function getAll(): iterable
    {
        $iterator = new AppendIterator();
        foreach ($this->providers as $provider) {
            $iterator->append($provider->getSiteAccesses());
        }

        return $iterator;
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());
}
    }

    public function getAvailableGroups(): iterable
    {
        return $this->siteAccessGroups;
    }

    public function getCurrent(): SiteAccess
    {
        // TODO: Implement getCurrent() method.
        return null;
    }
}


1		<?php
2
3		/**
4		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
5		* @license For full copyright and license information view LICENSE file distributed with this source code.
6		*/
7		declare(strict_types=1);
8
9		namespace eZ\Publish\Core\MVC\Symfony\SiteAccess;
10
11		use AppendIterator;
12		use eZ\Publish\Core\Base\Exceptions\NotFoundException;
13		use eZ\Publish\Core\MVC\Symfony\SiteAccess;
14		use eZ\Publish\Core\MVC\Symfony\SiteAccessGroup;
15
16		class SiteAccessService implements SiteAccessServiceInterface
17		{
18		/**
19		* @var \eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessProviderInterface[]
20		*/
21		private $providers;
22
23		/**
24		* @var \eZ\Publish\Core\MVC\Symfony\SiteAccessGroup[]
25		*/
26		private $siteAccessGroups = [];
27
28		public function __construct(iterable $providers, array $siteAccessGroups)
29		{
30		$this->providers = $providers;
31
32		foreach ($siteAccessGroups as $name) {
33		$this->siteAccessGroups[] = new SiteAccessGroup($name);
34		}
35		}
36
37		public function exists(string $name): bool
38		{
39		foreach ($this->providers as $provider) {
40		if ($provider->isDefined($name)) {
41		return true;
42		}
43		}
44
45		return false;
46		}
47
48	View Code Duplication	public function get(string $name): SiteAccess
49		{
50		foreach ($this->providers as $provider) {
51		if ($provider->isDefined($name)) {
52		return $provider->getSiteAccess($name);
53		}
54		}
55
56		throw new NotFoundException('SiteAccess', $name);
57		}
58
59		public function getAll(): iterable
60		{
61		$iterator = new AppendIterator();
62		foreach ($this->providers as $provider) {
63		$iterator->append($provider->getSiteAccesses());
64		}
65
66		return $iterator;
		0 ignored issues – show Bug Best Practice introduced 2019-10-16 12:00 UTC by Report Bug Copy Issue Report The return type of `return $iterator;` (`AppendIterator`) is incompatible with the return type declared by the interface `eZ\Publish\Core\MVC\Symf...erviceInterface::getAll` of type `eZ\Publish\Core\MVC\Symfony\SiteAccess[]`. 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...
67		}
68
69		public function getAvailableGroups(): iterable
70		{
71		return $this->siteAccessGroups;
72		}
73
74		public function getCurrent(): SiteAccess
75		{
76		// TODO: Implement getCurrent() method.
77		return null;
78		}
79		}
80

ezsystems / ezpublish-kernel

Push — dynamic_siteaccesses ( 16c7ff )

SiteAccessService::getAll() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like