PolicyManager::policies() - Code Metrics - ARCANEDEV/LaravelPolicies - Measure and Improve Code Quality continuously with Scrutinizer

PolicyManager::policies() A
last analyzed 2020-09-29 14:31 UTC

↳ Parent: PolicyManager

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelPolicies;

use Arcanedev\LaravelPolicies\Contracts\Ability as AbilityContract;
use Arcanedev\LaravelPolicies\Contracts\Policy as PolicyContract;
use Arcanedev\LaravelPolicies\Contracts\PolicyManager as PolicyManagerContract;
use Illuminate\Contracts\Auth\Access\Gate;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Collection;

/**
 * Class     PolicyManager
 *
 * @author   ARCANEDEV <[email protected]>
 */
class PolicyManager implements PolicyManagerContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var  \Illuminate\Contracts\Foundation\Application */
    protected $app;

    /** @var  \Illuminate\Support\Collection */
    protected $policies;

    /** @var  \Illuminate\Support\Collection */
    protected $abilities;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * PolicyManager constructor.
     *
     * @param  \Illuminate\Contracts\Foundation\Application  $app
     */
    public function __construct(Application $app)
    {
        $this->app       = $app;
        $this->policies  = new Collection;
        $this->abilities = new Collection;
    }

    /* -----------------------------------------------------------------
     |  Getters
     | -----------------------------------------------------------------
     */

    /**
     * Get the registered policies.
     *
     * @return \Arcanedev\LaravelPolicies\Contracts\Policy[]|\Illuminate\Support\Collection
     */
    public function policies(): Collection
    {
        return $this->policies;
    }

    /**
     * Get the registered abilities.
     *
     * @return \Arcanedev\LaravelPolicies\Ability[]|\Illuminate\Support\Collection
     */
    public function abilities(): Collection
    {
        return $this->abilities;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Parse policies classes.
     *
     * @param  iterable  $classes
     *
     * @return \Illuminate\Support\Collection
     */
    public function parsePolicies(iterable $classes): Collection
    {
        return Collection::make($classes)->transform(function (string $class) {
            return $this->parsePolicy($class);
        });
    }

    /**
     * Parse the class into a policy instance.
     *
     * @param  string  $class
     *
     * @return \Arcanedev\LaravelPolicies\Contracts\Policy|mixed
     */
    public function parsePolicy(string $class): PolicyContract
    {
        return $this->app->make($class);
    }

    /**
     * Register a policy class.
     *
     * @param  string  $class
     *
     * @return \Arcanedev\LaravelPolicies\Contracts\PolicyManager
     */
    public function registerClass(string $class): PolicyManagerContract
    {
        return $this->register(
            $this->parsePolicy($class)
        );
    }

    /**
     * Register a policy instance.
     *
     * @param  \Arcanedev\LaravelPolicies\Contracts\Policy  $policy
     *
     * @return \Arcanedev\LaravelPolicies\Contracts\PolicyManager
     */
    public function register(PolicyContract $policy): PolicyManagerContract
    {
        $this->policies->put(get_class($policy), $policy);

        foreach ($this->app->call([$policy, 'abilities']) as $ability) {
            $this->registerAbility($ability);
        }

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

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Register the ability object.
     *
     * @param  \Arcanedev\LaravelPolicies\Contracts\Ability  $ability
     *
     * @return $this
     */
    protected function registerAbility(AbilityContract $ability)
    {
        $this->abilities->put($ability->key(), $ability);
        $this->gate()->define($ability->key(), $ability->method());

        return $this;
    }

    /**
     * Get the gate access instance.
     *
     * @return \Illuminate\Contracts\Auth\Access\Gate|mixed
     */
    private function gate(): Gate
    {
        return $this->app->make(Gate::class);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Arcanedev\LaravelPolicies;
6
7		use Arcanedev\LaravelPolicies\Contracts\Ability as AbilityContract;
8		use Arcanedev\LaravelPolicies\Contracts\Policy as PolicyContract;
9		use Arcanedev\LaravelPolicies\Contracts\PolicyManager as PolicyManagerContract;
10		use Illuminate\Contracts\Auth\Access\Gate;
11		use Illuminate\Contracts\Foundation\Application;
12		use Illuminate\Support\Collection;
13
14		/**
15		* Class PolicyManager
16		*
17		* @author ARCANEDEV <[email protected]>
18		*/
19		class PolicyManager implements PolicyManagerContract
20		{
21		/* -----------------------------------------------------------------
22		\| Properties
23		\| -----------------------------------------------------------------
24		*/
25
26		/** @var \Illuminate\Contracts\Foundation\Application */
27		protected $app;
28
29		/** @var \Illuminate\Support\Collection */
30		protected $policies;
31
32		/** @var \Illuminate\Support\Collection */
33		protected $abilities;
34
35		/* -----------------------------------------------------------------
36		\| Constructor
37		\| -----------------------------------------------------------------
38		*/
39
40		/**
41		* PolicyManager constructor.
42		*
43		* @param \Illuminate\Contracts\Foundation\Application $app
44		*/
45	32	public function __construct(Application $app)
46		{
47	32	$this->app = $app;
48	32	$this->policies = new Collection;
49	32	$this->abilities = new Collection;
50	32	}
51
52		/* -----------------------------------------------------------------
53		\| Getters
54		\| -----------------------------------------------------------------
55		*/
56
57		/**
58		* Get the registered policies.
59		*
60		* @return \Arcanedev\LaravelPolicies\Contracts\Policy[]\|\Illuminate\Support\Collection
61		*/
62	12	public function policies(): Collection
63		{
64	12	return $this->policies;
65		}
66
67		/**
68		* Get the registered abilities.
69		*
70		* @return \Arcanedev\LaravelPolicies\Ability[]\|\Illuminate\Support\Collection
71		*/
72	20	public function abilities(): Collection
73		{
74	20	return $this->abilities;
75		}
76
77		/* -----------------------------------------------------------------
78		\| Main Methods
79		\| -----------------------------------------------------------------
80		*/
81
82		/**
83		* Parse policies classes.
84		*
85		* @param iterable $classes
86		*
87		* @return \Illuminate\Support\Collection
88		*/
89	4	public function parsePolicies(iterable $classes): Collection
90		{
91	4	return Collection::make($classes)->transform(function (string $class) {
92	4	return $this->parsePolicy($class);
93	4	});
94		}
95
96		/**
97		* Parse the class into a policy instance.
98		*
99		* @param string $class
100		*
101		* @return \Arcanedev\LaravelPolicies\Contracts\Policy\|mixed
102		*/
103	24	public function parsePolicy(string $class): PolicyContract
104		{
105	24	return $this->app->make($class);
106		}
107
108		/**
109		* Register a policy class.
110		*
111		* @param string $class
112		*
113		* @return \Arcanedev\LaravelPolicies\Contracts\PolicyManager
114		*/
115	16	public function registerClass(string $class): PolicyManagerContract
116		{
117	16	return $this->register(
118	16	$this->parsePolicy($class)
119		);
120		}
121
122		/**
123		* Register a policy instance.
124		*
125		* @param \Arcanedev\LaravelPolicies\Contracts\Policy $policy
126		*
127		* @return \Arcanedev\LaravelPolicies\Contracts\PolicyManager
128		*/
129	20	public function register(PolicyContract $policy): PolicyManagerContract
130		{
131	20	$this->policies->put(get_class($policy), $policy);
132
133	20	foreach ($this->app->call([$policy, 'abilities']) as $ability) {
134	20	$this->registerAbility($ability);
135		}
136
137	20	return $this;
		0 ignored issues – show Bug Best Practice introduced 2019-10-12 14:05 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Arcanedev\LaravelPolicies\PolicyManager`) is incompatible with the return type declared by the interface `Arcanedev\LaravelPolicie...PolicyManager::register` 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...
138		}
139
140		/* -----------------------------------------------------------------
141		\| Other Methods
142		\| -----------------------------------------------------------------
143		*/
144
145		/**
146		* Register the ability object.
147		*
148		* @param \Arcanedev\LaravelPolicies\Contracts\Ability $ability
149		*
150		* @return $this
151		*/
152	20	protected function registerAbility(AbilityContract $ability)
153		{
154	20	$this->abilities->put($ability->key(), $ability);
155	20	$this->gate()->define($ability->key(), $ability->method());
156
157	20	return $this;
158		}
159
160		/**
161		* Get the gate access instance.
162		*
163		* @return \Illuminate\Contracts\Auth\Access\Gate\|mixed
164		*/
165	10	private function gate(): Gate
166		{
167	10	return $this->app->make(Gate::class);
168		}
169		}
170

ARCANEDEV / LaravelPolicies

PolicyManager::policies() A last analyzed 2020-09-29 14:31 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

PolicyManager::policies() A
last analyzed 2020-09-29 14:31 UTC