Component::boot() - Code Metrics - Inspection of "navigation service provider" - ScoLib/admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 86815f...7e02e6 )

by wen

created 2017-07-19 09:09 UTC

Component::boot() A

↳ Parent: Component

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Sco\Admin\Component;

use Illuminate\Foundation\Application;
use Sco\Admin\Component\Concerns\HasEvents;
use Sco\Admin\Component\Concerns\HasPermission;
use Sco\Admin\Contracts\ComponentInterface;
use Sco\Admin\Contracts\RepositoryInterface;

abstract class Component implements ComponentInterface
{
    use HasEvents, HasPermission;

    /**
     * @var
     */
    protected $name;

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

    protected $title;

    /**
     * @var mixed|\Sco\Admin\Contracts\RepositoryInterface
     */
    protected $repository;

    /**
     * @var \Illuminate\Database\Eloquent\Model
     */
    protected $model;

    protected static $booted = [];

    /**
     * @var \Illuminate\Contracts\Events\Dispatcher
     */
    protected static $dispatcher;

    /**
     * @return array
     */
    abstract public function getColumns();

    public function __construct(Application $app, $modelClass)
    {
        $this->app = $app;

        $this->repository = $this->app->make(RepositoryInterface::class);
        $this->repository->setClass($modelClass);

        $this->model = $this->repository->getModel();
        if (!$this->name) {
            $this->setDefaultName();
        }

        $this->registerObserver($this->permissionObserver);

        $this->bootIfNotBooted();
    }

    protected function setDefaultName()
    {
        $this->name = $this->getModelClassName();
    }

    protected function getModelClassName()
    {
        return snake_case(str_plural(class_basename(get_class($this->getModel()))));
    }

    public function getName()
    {
        return $this->name;
    }

    public function getTitle()
    {
        return $this->title;
    }

    public function getModel()
    {
        return $this->model;
    }

    public function getRepository()
    {
        return $this->repository;
    }

    public function get()
    {
        if (!method_exists($this, 'callView')) {
            return;
        }

        $view = $this->app->call([$this, 'callView']);
        $view->setRepository($this->getRepository());

        return $view->get();
    }

    /**
     * {@inheritdoc}
     */
    public function getConfigs()
    {
        return collect([
            'primaryKey'  => $this->getModel()->getKeyName(),
            'title'       => $this->getTitle(),
            'permissions' => $this->getPermissions(),
            'columns'     => $this->getColumns(),
            //'elements'    => $this->getElements()->values(),

        ]);
    }

    protected function bootIfNotBooted()
    {
        if (!isset(static::$booted[static::class])) {
            static::$booted[static::class] = true;

            $this->fireEvent('booting', false);

            $this->boot();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

            $this->fireEvent('booted', false);
        }
    }

    public function boot()
    {
        return true;
    }
}


1			<?php
2
3			namespace Sco\Admin\Component;
4
5			use Illuminate\Foundation\Application;
6			use Sco\Admin\Component\Concerns\HasEvents;
7			use Sco\Admin\Component\Concerns\HasPermission;
8			use Sco\Admin\Contracts\ComponentInterface;
9			use Sco\Admin\Contracts\RepositoryInterface;
10
11			abstract class Component implements ComponentInterface
12			{
13			use HasEvents, HasPermission;
14
15			/**
16			* @var
17			*/
18			protected $name;
19
20			/**
21			* @var \Illuminate\Foundation\Application
22			*/
23			protected $app;
24
25			protected $title;
26
27			/**
28			* @var mixed\|\Sco\Admin\Contracts\RepositoryInterface
29			*/
30			protected $repository;
31
32			/**
33			* @var \Illuminate\Database\Eloquent\Model
34			*/
35			protected $model;
36
37			protected static $booted = [];
38
39			/**
40			* @var \Illuminate\Contracts\Events\Dispatcher
41			*/
42			protected static $dispatcher;
43
44			/**
45			* @return array
46			*/
47			abstract public function getColumns();
48
49			public function __construct(Application $app, $modelClass)
50			{
51			$this->app = $app;
52
53			$this->repository = $this->app->make(RepositoryInterface::class);
54			$this->repository->setClass($modelClass);
55
56			$this->model = $this->repository->getModel();
57			if (!$this->name) {
58			$this->setDefaultName();
59			}
60
61			$this->registerObserver($this->permissionObserver);
62
63			$this->bootIfNotBooted();
64			}
65
66			protected function setDefaultName()
67			{
68			$this->name = $this->getModelClassName();
69			}
70
71			protected function getModelClassName()
72			{
73			return snake_case(str_plural(class_basename(get_class($this->getModel()))));
74			}
75
76			public function getName()
77			{
78			return $this->name;
79			}
80
81			public function getTitle()
82			{
83			return $this->title;
84			}
85
86			public function getModel()
87			{
88			return $this->model;
89			}
90
91			public function getRepository()
92			{
93			return $this->repository;
94			}
95
96			public function get()
97			{
98			if (!method_exists($this, 'callView')) {
99			return;
100			}
101
102			$view = $this->app->call([$this, 'callView']);
103			$view->setRepository($this->getRepository());
104
105			return $view->get();
106			}
107
108			/**
109			* {@inheritdoc}
110			*/
111			public function getConfigs()
112			{
113			return collect([
114			'primaryKey' => $this->getModel()->getKeyName(),
115			'title' => $this->getTitle(),
116			'permissions' => $this->getPermissions(),
117			'columns' => $this->getColumns(),
118			//'elements' => $this->getElements()->values(),
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-18 09:48 UTC by Report Bug Copy Issue Report `72%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
119			]);
120			}
121
122			protected function bootIfNotBooted()
123			{
124			if (!isset(static::$booted[static::class])) {
125			static::$booted[static::class] = true;
126
127			$this->fireEvent('booting', false);
128
129			$this->boot();
			0 ignored issues – show Unused Code introduced 2017-07-18 12:53 UTC by Report Bug Copy Issue Report The call to the method `Sco\Admin\Component\Component::boot()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
130
131			$this->fireEvent('booted', false);
132			}
133			}
134
135			public function boot()
136			{
137			return true;
138			}
139			}
140

ScoLib / admin

Push — master ( 86815f...7e02e6 )

Component::boot() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like