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

Completed

Push — master ( 7e02e6...ea0e93 )

by wen

created 2017-07-24 08:56 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\HasNavigation;
use Sco\Admin\Component\Concerns\HasPermission;
use Sco\Admin\Contracts\ComponentInterface;
use Sco\Admin\Contracts\RepositoryInterface;
use Sco\Admin\Exceptions\BadMethodCallException;

abstract class Component implements ComponentInterface
{
    use HasEvents,
        HasPermission,
        HasNavigation;

    /**
     * @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;

    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()
    {
        $view = $this->fireView();

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

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

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

        $view->setRepository($this->getRepository());

        return $view->get();
    }


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

        ]);
    }

    /**
     * @return \Sco\Admin\Contracts\ViewInterface
     */
    protected function fireView()
    {
        if (!method_exists($this, 'callView')) {
            throw new BadMethodCallException('Not Found Method "callView"');
        }

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

    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\HasNavigation;
8			use Sco\Admin\Component\Concerns\HasPermission;
9			use Sco\Admin\Contracts\ComponentInterface;
10			use Sco\Admin\Contracts\RepositoryInterface;
11			use Sco\Admin\Exceptions\BadMethodCallException;
12
13			abstract class Component implements ComponentInterface
14			{
15			use HasEvents,
16			HasPermission,
17			HasNavigation;
18
19			/**
20			* @var
21			*/
22			protected $name;
23
24			/**
25			* @var \Illuminate\Foundation\Application
26			*/
27			protected $app;
28
29			protected $title;
30
31			/**
32			* @var mixed\|\Sco\Admin\Contracts\RepositoryInterface
33			*/
34			protected $repository;
35
36			/**
37			* @var \Illuminate\Database\Eloquent\Model
38			*/
39			protected $model;
40
41			protected static $booted = [];
42
43			/**
44			* @var \Illuminate\Contracts\Events\Dispatcher
45			*/
46			protected static $dispatcher;
47
48			public function __construct(Application $app, $modelClass)
49			{
50			$this->app = $app;
51
52			$this->repository = $this->app->make(RepositoryInterface::class);
53			$this->repository->setClass($modelClass);
54
55			$this->model = $this->repository->getModel();
56			if (!$this->name) {
57			$this->setDefaultName();
58			}
59
60			$this->registerObserver($this->permissionObserver);
61
62			$this->bootIfNotBooted();
63			}
64
65			protected function setDefaultName()
66			{
67			$this->name = $this->getModelClassName();
68			}
69
70			protected function getModelClassName()
71			{
72			return snake_case(str_plural(class_basename(get_class($this->getModel()))));
73			}
74
75			public function getName()
76			{
77			return $this->name;
78			}
79
80			public function getTitle()
81			{
82			return $this->title;
83			}
84
85			public function getModel()
86			{
87			return $this->model;
88			}
89
90			public function getRepository()
91			{
92			return $this->repository;
93			}
94
95			public function get()
96			{
97			$view = $this->fireView();
98
99			$this->getRepository();
			0 ignored issues – show Unused Code introduced 2017-07-24 08:59 UTC by Report Bug Copy Issue Report The call to the method `Sco\Admin\Component\Component::getRepository()` 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...
100
101			$view->setRepository($this->getRepository());
102
103			return $view->get();
104			}
105
106
107			/**
108			* {@inheritdoc}
109			*/
110			public function getConfigs()
111			{
112			return collect([
113			'primaryKey' => $this->getModel()->getKeyName(),
114			'title' => $this->getTitle(),
115			'permissions' => $this->getPermissions(),
116			'view' => $this->fireView(),
117			//'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...
118			]);
119			}
120
121			/**
122			* @return \Sco\Admin\Contracts\ViewInterface
123			*/
124			protected function fireView()
125			{
126			if (!method_exists($this, 'callView')) {
127			throw new BadMethodCallException('Not Found Method "callView"');
128			}
129
130			$view = $this->app->call([$this, 'callView']);
131			return $view;
132			}
133
134			protected function bootIfNotBooted()
135			{
136			if (!isset(static::$booted[static::class])) {
137			static::$booted[static::class] = true;
138
139			$this->fireEvent('booting', false);
140
141			$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...
142
143			$this->fireEvent('booted', false);
144			}
145			}
146
147			public function boot()
148			{
149			return true;
150			}
151			}
152

ScoLib / admin

Push — master ( 7e02e6...ea0e93 )

Component::boot() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like