Admin::guard() - Code Metrics - Inspection of "wip" - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 042892...442005 )

by Song

created 2019-06-20 09:29 UTC

Admin::guard() A

↳ Parent: Admin

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	6
rs	10
c	0
b	0
f	0

<?php

namespace Encore\Admin;

use Closure;
use Encore\Admin\Auth\Database\Menu;
use Encore\Admin\Controllers\AuthController;
use Encore\Admin\Layout\Content;
use Encore\Admin\Traits\HasAssets;
use Encore\Admin\Widgets\Navbar;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Auth;
use InvalidArgumentException;

/**
 * Class Admin.
 */
class Admin
{
    use HasAssets;

    /**
     * The Laravel admin version.
     *
     * @var string
     */
    const VERSION = '1.7.0';

    /**
     * @var Navbar
     */
    protected $navbar;

    /**
     * @var array
     */
    protected $menu = [];

    /**
     * @var string
     */
    public static $metaTitle;

    /**
     * @var string
     */
    public static $favicon;

    /**
     * @var array
     */
    public static $extensions = [];

    /**
     * @var []Closure
     */
    protected static $bootingCallbacks = [];

    /**
     * @var []Closure
     */
    protected static $bootedCallbacks = [];

    /**
     * Returns the long version of Laravel-admin.
     *
     * @return string The long application version
     */
    public static function getLongVersion()
    {
        return sprintf('Laravel-admin <comment>version</comment> <info>%s</info>', self::VERSION);
    }

    /**
     * @param $model
     * @param Closure $callable
     *
     * @return \Encore\Admin\Grid
     *
     * @deprecated since v1.6.1
     */
    public function grid($model, Closure $callable)
    {
        return new Grid($this->getModel($model), $callable);
    }

    /**
     * @param $model
     * @param Closure $callable
     *
     * @return \Encore\Admin\Form
     *
     *  @deprecated since v1.6.1
     */
    public function form($model, Closure $callable)
    {
        return new Form($this->getModel($model), $callable);
    }

    /**
     * Build a tree.
     *
     * @param $model
     * @param Closure|null $callable
     *
     * @return \Encore\Admin\Tree
     */
    public function tree($model, Closure $callable = null)
    {
        return new Tree($this->getModel($model), $callable);
    }

    /**
     * Build show page.
     *
     * @param $model
     * @param mixed $callable
     *
     * @return Show
     *
     * @deprecated since v1.6.1
     */
    public function show($model, $callable = null)
    {
        return new Show($this->getModel($model), $callable);
    }

    /**
     * @param Closure $callable
     *
     * @return \Encore\Admin\Layout\Content
     *
     * @deprecated since v1.6.1
     */
    public function content(Closure $callable = null)
    {
        return new Content($callable);
    }

    /**
     * @param $model
     *
     * @return mixed
     */
    public function getModel($model)
    {
        if ($model instanceof Model) {
            return $model;
        }

        if (is_string($model) && class_exists($model)) {
            return $this->getModel(new $model());
        }

        throw new InvalidArgumentException("$model is not a valid model");
    }

    /**
     * Left sider-bar menu.
     *
     * @return array
     */
    public function menu()
    {
        if (!empty($this->menu)) {
            return $this->menu;
        }

        $menuClass = config('admin.database.menu_model');

        /** @var Menu $menuModel */
        $menuModel = new $menuClass();

        return $this->menu = $menuModel->toTree();
    }

    /**
     * @param array $menu
     *
     * @return array
     */
    public function menuLinks($menu = [])
    {
        if (empty($menu)) {
            $menu = $this->menu();
        }

        $links = [];

        foreach ($menu as $item) {
            if (!empty($item['children'])) {
                $links = array_merge($links, $this->menuLinks($item['children']));
            } else {
                $links[] = Arr::only($item, ['title', 'uri', 'icon']);
            }
        }

        return $links;
    }

    /**
     * Set admin title.
     *
     * @param string $title
     *
     * @return void
     */
    public static function setTitle($title)
    {
        self::$metaTitle = $title;
    }

    /**
     * Get admin title.
     *
     * @return string
     */
    public function title()
    {
        return self::$metaTitle ? self::$metaTitle : config('admin.title');
    }

    /**
     * @param null|string $favicon
     *
     * @return string|void
     */
    public function favicon($favicon = null)
    {
        if (is_null($favicon)) {
            return static::$favicon;
        }

        static::$favicon = $favicon;
    }

    /**
     * Get the currently authenticated user.
     *
     * @return \Illuminate\Contracts\Auth\Authenticatable|null
     */
    public function user()
    {
        return $this->guard()->user();
    }

    /**
     * Attempt to get the guard from the local cache.
     *
     * @return \Illuminate\Contracts\Auth\Guard|\Illuminate\Contracts\Auth\StatefulGuard
     */
    public function guard()
    {
        $guard = config('admin.auth.guard') ?: 'admin';

        return Auth::guard($guard);
    }

    /**
     * Set navbar.
     *
     * @param Closure|null $builder
     *
     * @return Navbar
     */
    public function navbar(Closure $builder = null)
    {
        if (is_null($builder)) {
            return $this->getNavbar();
        }

        call_user_func($builder, $this->getNavbar());
    }

    /**
     * Get navbar object.
     *
     * @return \Encore\Admin\Widgets\Navbar
     */
    public function getNavbar()
    {
        if (is_null($this->navbar)) {
            $this->navbar = new Navbar();
        }

        return $this->navbar;
    }

    /**
     * Register the laravel-admin builtin routes.
     *
     * @return void
     *
     * @deprecated Use Admin::routes() instead();
     */
    public function registerAuthRoutes()
    {
        $this->routes();
    }

    /**
     * Register the laravel-admin builtin routes.
     *
     * @return void
     */
    public function routes()
    {
        $attributes = [
            'prefix'     => config('admin.route.prefix'),
            'middleware' => config('admin.route.middleware'),
        ];

        app('router')->group($attributes, function ($router) {

            /* @var \Illuminate\Support\Facades\Route $router */
            $router->namespace('\Encore\Admin\Controllers')->group(function ($router) {

                /* @var \Illuminate\Routing\Router $router */
                $router->resource('auth/users', 'UserController')->names('admin.auth.users');
                $router->resource('auth/roles', 'RoleController')->names('admin.auth.roles');
                $router->resource('auth/permissions', 'PermissionController')->names('admin.auth.permissions');
                $router->resource('auth/menu', 'MenuController', ['except' => ['create']])->names('admin.auth.menu');
                $router->resource('auth/logs', 'LogController', ['only' => ['index', 'destroy']])->names('admin.auth.logs');

                $router->post('_handle_form_', 'HandleController@handleForm')->name('admin.handle-form');
            });

            $authController = config('admin.auth.controller', AuthController::class);

            /* @var \Illuminate\Routing\Router $router */
            $router->get('auth/login', $authController.'@getLogin')->name('admin.login');
            $router->post('auth/login', $authController.'@postLogin');
            $router->get('auth/logout', $authController.'@getLogout')->name('admin.logout');
            $router->get('auth/setting', $authController.'@getSetting')->name('admin.setting');
            $router->put('auth/setting', $authController.'@putSetting');
        });
    }

    /**
     * Extend a extension.
     *
     * @param string $name
     * @param string $class
     *
     * @return void
     */
    public static function extend($name, $class)
    {
        static::$extensions[$name] = $class;
    }

    /**
     * @param callable $callback
     */
    public static function booting(callable $callback)
    {
        static::$bootingCallbacks[] = $callback;
    }

    /**
     * @param callable $callback
     */
    public static function booted(callable $callback)
    {
        static::$bootedCallbacks[] = $callback;
    }

    /**
     * Bootstrap the admin application.
     */
    public function bootstrap()
    {
        $this->fireBootingCallbacks();

        Form::registerBuiltinFields();

        Grid::registerColumnDisplayer();

        Grid\Filter::registerFilters();

        require config('admin.bootstrap', admin_path('bootstrap.php'));

        $assets = Form::collectFieldAssets();

        self::css($assets['css']);
        self::js($assets['js']);

        $this->fireBootedCallbacks();
    }

    /**
     * Call the booting callbacks for the admin application.
     */
    protected function fireBootingCallbacks()
    {
        foreach (static::$bootingCallbacks as $callable) {
            call_user_func($callable);
        }
    }

    /**
     * Call the booted callbacks for the admin application.
     */
    protected function fireBootedCallbacks()
    {
        foreach (static::$bootedCallbacks as $callable) {
            call_user_func($callable);
        }
    }

    /*
     * Disable Pjax for current Request
     *
     * @return void
     */
    public function disablePjax()
    {
        if (request()->pjax()) {
            request()->headers->set('X-PJAX', false);
        }
    }
}


1			<?php
2
3			namespace Encore\Admin;
4
5			use Closure;
6			use Encore\Admin\Auth\Database\Menu;
7			use Encore\Admin\Controllers\AuthController;
8			use Encore\Admin\Layout\Content;
9			use Encore\Admin\Traits\HasAssets;
10			use Encore\Admin\Widgets\Navbar;
11			use Illuminate\Database\Eloquent\Model;
12			use Illuminate\Support\Arr;
13			use Illuminate\Support\Facades\Auth;
14			use InvalidArgumentException;
15
16			/**
17			* Class Admin.
18			*/
19			class Admin
20			{
21			use HasAssets;
22
23			/**
24			* The Laravel admin version.
25			*
26			* @var string
27			*/
28			const VERSION = '1.7.0';
29
30			/**
31			* @var Navbar
32			*/
33			protected $navbar;
34
35			/**
36			* @var array
37			*/
38			protected $menu = [];
39
40			/**
41			* @var string
42			*/
43			public static $metaTitle;
44
45			/**
46			* @var string
47			*/
48			public static $favicon;
49
50			/**
51			* @var array
52			*/
53			public static $extensions = [];
54
55			/**
56			* @var []Closure
57			*/
58			protected static $bootingCallbacks = [];
59
60			/**
61			* @var []Closure
62			*/
63			protected static $bootedCallbacks = [];
64
65			/**
66			* Returns the long version of Laravel-admin.
67			*
68			* @return string The long application version
69			*/
70			public static function getLongVersion()
71			{
72			return sprintf('Laravel-admin <comment>version</comment> <info>%s</info>', self::VERSION);
73			}
74
75			/**
76			* @param $model
77			* @param Closure $callable
78			*
79			* @return \Encore\Admin\Grid
80			*
81			* @deprecated since v1.6.1
82			*/
83			public function grid($model, Closure $callable)
84			{
85			return new Grid($this->getModel($model), $callable);
86			}
87
88			/**
89			* @param $model
90			* @param Closure $callable
91			*
92			* @return \Encore\Admin\Form
93			*
94			* @deprecated since v1.6.1
95			*/
96			public function form($model, Closure $callable)
97			{
98			return new Form($this->getModel($model), $callable);
99			}
100
101			/**
102			* Build a tree.
103			*
104			* @param $model
105			* @param Closure\|null $callable
106			*
107			* @return \Encore\Admin\Tree
108			*/
109			public function tree($model, Closure $callable = null)
110			{
111			return new Tree($this->getModel($model), $callable);
112			}
113
114			/**
115			* Build show page.
116			*
117			* @param $model
118			* @param mixed $callable
119			*
120			* @return Show
121			*
122			* @deprecated since v1.6.1
123			*/
124			public function show($model, $callable = null)
125			{
126			return new Show($this->getModel($model), $callable);
127			}
128
129			/**
130			* @param Closure $callable
131			*
132			* @return \Encore\Admin\Layout\Content
133			*
134			* @deprecated since v1.6.1
135			*/
136			public function content(Closure $callable = null)
137			{
138			return new Content($callable);
139			}
140
141			/**
142			* @param $model
143			*
144			* @return mixed
145			*/
146			public function getModel($model)
147			{
148			if ($model instanceof Model) {
149			return $model;
150			}
151
152			if (is_string($model) && class_exists($model)) {
153			return $this->getModel(new $model());
154			}
155
156			throw new InvalidArgumentException("$model is not a valid model");
157			}
158
159			/**
160			* Left sider-bar menu.
161			*
162			* @return array
163			*/
164			public function menu()
165			{
166			if (!empty($this->menu)) {
167			return $this->menu;
168			}
169
170			$menuClass = config('admin.database.menu_model');
171
172			/** @var Menu $menuModel */
173			$menuModel = new $menuClass();
174
175			return $this->menu = $menuModel->toTree();
176			}
177
178			/**
179			* @param array $menu
180			*
181			* @return array
182			*/
183			public function menuLinks($menu = [])
184			{
185			if (empty($menu)) {
186			$menu = $this->menu();
187			}
188
189			$links = [];
190
191			foreach ($menu as $item) {
192			if (!empty($item['children'])) {
193			$links = array_merge($links, $this->menuLinks($item['children']));
194			} else {
195			$links[] = Arr::only($item, ['title', 'uri', 'icon']);
196			}
197			}
198
199			return $links;
200			}
201
202			/**
203			* Set admin title.
204			*
205			* @param string $title
206			*
207			* @return void
208			*/
209			public static function setTitle($title)
210			{
211			self::$metaTitle = $title;
212			}
213
214			/**
215			* Get admin title.
216			*
217			* @return string
218			*/
219			public function title()
220			{
221			return self::$metaTitle ? self::$metaTitle : config('admin.title');
222			}
223
224			/**
225			* @param null\|string $favicon
226			*
227			* @return string\|void
228			*/
229			public function favicon($favicon = null)
230			{
231			if (is_null($favicon)) {
232			return static::$favicon;
233			}
234
235			static::$favicon = $favicon;
236			}
237
238			/**
239			* Get the currently authenticated user.
240			*
241			* @return \Illuminate\Contracts\Auth\Authenticatable\|null
242			*/
243			public function user()
244			{
245			return $this->guard()->user();
246			}
247
248			/**
249			* Attempt to get the guard from the local cache.
250			*
251			* @return \Illuminate\Contracts\Auth\Guard\|\Illuminate\Contracts\Auth\StatefulGuard
252			*/
253			public function guard()
254			{
255			$guard = config('admin.auth.guard') ?: 'admin';
256
257			return Auth::guard($guard);
258			}
259
260			/**
261			* Set navbar.
262			*
263			* @param Closure\|null $builder
264			*
265			* @return Navbar
266			*/
267			public function navbar(Closure $builder = null)
268			{
269			if (is_null($builder)) {
270			return $this->getNavbar();
271			}
272
273			call_user_func($builder, $this->getNavbar());
274			}
275
276			/**
277			* Get navbar object.
278			*
279			* @return \Encore\Admin\Widgets\Navbar
280			*/
281			public function getNavbar()
282			{
283			if (is_null($this->navbar)) {
284			$this->navbar = new Navbar();
285			}
286
287			return $this->navbar;
288			}
289
290			/**
291			* Register the laravel-admin builtin routes.
292			*
293			* @return void
294			*
295			* @deprecated Use Admin::routes() instead();
296			*/
297			public function registerAuthRoutes()
298			{
299			$this->routes();
300			}
301
302			/**
303			* Register the laravel-admin builtin routes.
304			*
305			* @return void
306			*/
307			public function routes()
308			{
309			$attributes = [
310			'prefix' => config('admin.route.prefix'),
311			'middleware' => config('admin.route.middleware'),
312			];
313
314			app('router')->group($attributes, function ($router) {
315
316			/* @var \Illuminate\Support\Facades\Route $router */
317			$router->namespace('\Encore\Admin\Controllers')->group(function ($router) {
318
319			/* @var \Illuminate\Routing\Router $router */
320			$router->resource('auth/users', 'UserController')->names('admin.auth.users');
321			$router->resource('auth/roles', 'RoleController')->names('admin.auth.roles');
322			$router->resource('auth/permissions', 'PermissionController')->names('admin.auth.permissions');
323			$router->resource('auth/menu', 'MenuController', ['except' => ['create']])->names('admin.auth.menu');
324			$router->resource('auth/logs', 'LogController', ['only' => ['index', 'destroy']])->names('admin.auth.logs');
325
326			$router->post('_handle_form_', 'HandleController@handleForm')->name('admin.handle-form');
327			});
328
329			$authController = config('admin.auth.controller', AuthController::class);
330
331			/* @var \Illuminate\Routing\Router $router */
332			$router->get('auth/login', $authController.'@getLogin')->name('admin.login');
333			$router->post('auth/login', $authController.'@postLogin');
334			$router->get('auth/logout', $authController.'@getLogout')->name('admin.logout');
335			$router->get('auth/setting', $authController.'@getSetting')->name('admin.setting');
336			$router->put('auth/setting', $authController.'@putSetting');
337			});
338			}
339
340			/**
341			* Extend a extension.
342			*
343			* @param string $name
344			* @param string $class
345			*
346			* @return void
347			*/
348			public static function extend($name, $class)
349			{
350			static::$extensions[$name] = $class;
351			}
352
353			/**
354			* @param callable $callback
355			*/
356			public static function booting(callable $callback)
357			{
358			static::$bootingCallbacks[] = $callback;
359			}
360
361			/**
362			* @param callable $callback
363			*/
364			public static function booted(callable $callback)
365			{
366			static::$bootedCallbacks[] = $callback;
367			}
368
369			/**
370			* Bootstrap the admin application.
371			*/
372			public function bootstrap()
373			{
374			$this->fireBootingCallbacks();
375
376			Form::registerBuiltinFields();
377
378			Grid::registerColumnDisplayer();
379
380			Grid\Filter::registerFilters();
381
382			require config('admin.bootstrap', admin_path('bootstrap.php'));
383
384			$assets = Form::collectFieldAssets();
385
386			self::css($assets['css']);
387			self::js($assets['js']);
388
389			$this->fireBootedCallbacks();
390			}
391
392			/**
393			* Call the booting callbacks for the admin application.
394			*/
395			protected function fireBootingCallbacks()
396			{
397			foreach (static::$bootingCallbacks as $callable) {
398			call_user_func($callable);
399			}
400			}
401
402			/**
403			* Call the booted callbacks for the admin application.
404			*/
405			protected function fireBootedCallbacks()
406			{
407			foreach (static::$bootedCallbacks as $callable) {
408			call_user_func($callable);
409			}
410			}
411
412			/*
413			* Disable Pjax for current Request
414			*
415			* @return void
416			*/
417			public function disablePjax()
418			{
419			if (request()->pjax()) {
420			request()->headers->set('X-PJAX', false);
421			}
422			}
423			}
424

z-song / laravel-admin

Push — master ( 042892...442005 )

Admin::guard() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like