Widget::boot() - Code Metrics - Inspection of "Move widget global scope inside the model." - yajra/cms-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( aecbb4...773e85 )

by Arjay

created 2016-07-13 04:37 UTC

Widget::boot() A

↳ Parent: Widget

Complexity

Conditions	2
Paths	1

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Yajra\CMS\Entities;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Laracasts\Presenter\PresentableTrait;
use Yajra\Acl\Models\Permission;
use Yajra\Acl\Traits\HasPermission;
use Yajra\Auditable\AuditableTrait;
use Yajra\CMS\Contracts\Cacheable;
use Yajra\CMS\Entities\Traits\CanRequireAuthentication;
use Yajra\CMS\Entities\Traits\HasOrder;
use Yajra\CMS\Entities\Traits\HasParameters;
use Yajra\CMS\Presenters\WidgetPresenter;

/**
 * @property string title
 * @property string template
 * @property string custom_template
 * @property string position
 * @property int order
 * @property bool published
 * @property bool authenticated
 * @property string body
 * @property string parameter
 * @property string parameters
 * @property string type
 * @property int id
 * @property string authorization
 * @property Collection|Permission[] permissions
 * @property bool show_title
 * @property int extension_id
 */
class Widget extends Model implements Cacheable
{
    use PresentableTrait, AuditableTrait, CanRequireAuthentication;
    use HasParameters, HasPermission, HasOrder;
    const ALL_PAGES      = 0;
    const NO_PAGES       = 1;
    const SELECTED_PAGES = 2;

    /**
     * @var \Yajra\CMS\Presenters\WidgetPresenter
     */
    protected $presenter = WidgetPresenter::class;

    /**
     * @var array
     */
    protected $fillable = [
        'title',
        'position',
        'extension_id',
        'template',
        'custom_template',
        'order',
        'parameter',
        'parameters',
        'authenticated',
        'authorization',
        'body',
    ];

    /**
     * The "booting" method of the model.
     *
     * @return void
     */
    protected static function boot()
    {
        parent::boot();

        static::addGlobalScope('menu_assignment', function(Builder $builder) {
            $widget     = new Widget;
            $assignment = [0];
            if (session()->has('active_menu')) {
                $assignment[] = session('active_menu')->id;
            }

            $widgets    = $widget->getConnection()->table('widget_menu');
            $widgets    = $widgets->whereIn('menu_id', $assignment);
            $builder->whereIn('id', $widgets->pluck('widget_id'));
        });
    }

    /**
     * Query scope by widget position.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param string $position
     * @return \Illuminate\Database\Eloquent\Builder $query
     */
    public function scopePosition($query, $position)
    {
        return $query->where('position', $position)->published()->orderBy('order', 'asc');
    }

    /**
     * Query scope by widget published state.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder $query
     */
    public function scopePublished($query)
    {
        return $query->where('published', true);
    }

    /**
     * Get list of keys used for caching.
     *
     * @return array
     */
    public function getCacheKeys()
    {
        return [
            'widgets.published',
            'widgets.all',
        ];
    }

    /**
     * Get associated permissions.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function permissions()
    {
        return $this->belongsToMany(Permission::class, 'widget_permission');
    }

    /**
     * Get menu assignment attribute.
     *
     * @return int
     */
    public function getAssignmentAttribute()
    {
        if (! $this->exists) {
            return static::ALL_PAGES;
        }

        $count = $this->menuPivot()->count();
        if ($count === 0) {
            return static::NO_PAGES;
        } elseif ($count > 1) {
            return static::SELECTED_PAGES;
        } elseif ($count === 1) {
            $pivot = $this->menuPivot()->first();
            if ($pivot->menu_id > 0) {

                return static::SELECTED_PAGES;
            }
        }

        return static::ALL_PAGES;
    }

    /**
     * Get related menus.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function menuPivot()
    {
        return $this->getConnection()->table('widget_menu')
                    ->where('widget_id', $this->id)
                    ->orWhere(function ($query) {
                        $query->where('menu_id', 0)
                              ->where('widget_id', $this->id);
                    });
    }

    /**
     * Sync widget menu assignment.
     *
     * @param array $menu
     * @param int $assignment
     * @return $this
     */
    public function syncMenuAssignment($menu, $assignment)
    {
        switch ($assignment) {
            case static::ALL_PAGES:
                $this->menus()->sync([static::ALL_PAGES]);
                break;
            case static::NO_PAGES:
                $this->menus()->detach();
                break;
            case static::SELECTED_PAGES:
                $this->menus()->sync($menu);
                break;
        }

        return $this;
    }

    /**
     * Get related menus.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function menus()
    {
        return $this->belongsToMany(Menu::class, 'widget_menu');
    }

    /**
     * Get related extension.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function extension()
    {
        return $this->belongsTo(Extension::class);
    }
}


1			<?php
2
3			namespace Yajra\CMS\Entities;
4
5			use Illuminate\Database\Eloquent\Builder;
6			use Illuminate\Database\Eloquent\Collection;
7			use Illuminate\Database\Eloquent\Model;
8			use Laracasts\Presenter\PresentableTrait;
9			use Yajra\Acl\Models\Permission;
10			use Yajra\Acl\Traits\HasPermission;
11			use Yajra\Auditable\AuditableTrait;
12			use Yajra\CMS\Contracts\Cacheable;
13			use Yajra\CMS\Entities\Traits\CanRequireAuthentication;
14			use Yajra\CMS\Entities\Traits\HasOrder;
15			use Yajra\CMS\Entities\Traits\HasParameters;
16			use Yajra\CMS\Presenters\WidgetPresenter;
17
18			/**
19			* @property string title
20			* @property string template
21			* @property string custom_template
22			* @property string position
23			* @property int order
24			* @property bool published
25			* @property bool authenticated
26			* @property string body
27			* @property string parameter
28			* @property string parameters
29			* @property string type
30			* @property int id
31			* @property string authorization
32			* @property Collection\|Permission[] permissions
33			* @property bool show_title
34			* @property int extension_id
35			*/
36			class Widget extends Model implements Cacheable
37			{
38			use PresentableTrait, AuditableTrait, CanRequireAuthentication;
39			use HasParameters, HasPermission, HasOrder;
40			const ALL_PAGES = 0;
41			const NO_PAGES = 1;
42			const SELECTED_PAGES = 2;
43
44			/**
45			* @var \Yajra\CMS\Presenters\WidgetPresenter
46			*/
47			protected $presenter = WidgetPresenter::class;
48
49			/**
50			* @var array
51			*/
52			protected $fillable = [
53			'title',
54			'position',
55			'extension_id',
56			'template',
57			'custom_template',
58			'order',
59			'parameter',
60			'parameters',
61			'authenticated',
62			'authorization',
63			'body',
64			];
65
66			/**
67			* The "booting" method of the model.
68			*
69			* @return void
70			*/
71			protected static function boot()
72			{
73			parent::boot();
74
75			static::addGlobalScope('menu_assignment', function(Builder $builder) {
76			$widget = new Widget;
77			$assignment = [0];
78			if (session()->has('active_menu')) {
79			$assignment[] = session('active_menu')->id;
80			}
81
82			$widgets = $widget->getConnection()->table('widget_menu');
83			$widgets = $widgets->whereIn('menu_id', $assignment);
84			$builder->whereIn('id', $widgets->pluck('widget_id'));
85			});
86			}
87
88			/**
89			* Query scope by widget position.
90			*
91			* @param \Illuminate\Database\Eloquent\Builder $query
92			* @param string $position
93			* @return \Illuminate\Database\Eloquent\Builder $query
94			*/
95			public function scopePosition($query, $position)
96			{
97			return $query->where('position', $position)->published()->orderBy('order', 'asc');
98			}
99
100			/**
101			* Query scope by widget published state.
102			*
103			* @param \Illuminate\Database\Eloquent\Builder $query
104			* @return \Illuminate\Database\Eloquent\Builder $query
105			*/
106			public function scopePublished($query)
107			{
108			return $query->where('published', true);
109			}
110
111			/**
112			* Get list of keys used for caching.
113			*
114			* @return array
115			*/
116			public function getCacheKeys()
117			{
118			return [
119			'widgets.published',
120			'widgets.all',
121			];
122			}
123
124			/**
125			* Get associated permissions.
126			*
127			* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
128			*/
129			public function permissions()
130			{
131			return $this->belongsToMany(Permission::class, 'widget_permission');
132			}
133
134			/**
135			* Get menu assignment attribute.
136			*
137			* @return int
138			*/
139			public function getAssignmentAttribute()
140			{
141			if (! $this->exists) {
142			return static::ALL_PAGES;
143			}
144
145			$count = $this->menuPivot()->count();
146			if ($count === 0) {
147			return static::NO_PAGES;
148			} elseif ($count > 1) {
149			return static::SELECTED_PAGES;
150			} elseif ($count === 1) {
151			$pivot = $this->menuPivot()->first();
152			if ($pivot->menu_id > 0) {
			0 ignored issues – show Bug introduced 2016-06-13 15:10 UTC by Report Bug Copy Issue Report The property `menu_id` does not seem to exist in `Illuminate\Database\Eloquent\Builder`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
153			return static::SELECTED_PAGES;
154			}
155			}
156
157			return static::ALL_PAGES;
158			}
159
160			/**
161			* Get related menus.
162			*
163			* @return \Illuminate\Database\Eloquent\Builder
164			*/
165			public function menuPivot()
166			{
167			return $this->getConnection()->table('widget_menu')
168			->where('widget_id', $this->id)
169			->orWhere(function ($query) {
170			$query->where('menu_id', 0)
171			->where('widget_id', $this->id);
172			});
173			}
174
175			/**
176			* Sync widget menu assignment.
177			*
178			* @param array $menu
179			* @param int $assignment
180			* @return $this
181			*/
182			public function syncMenuAssignment($menu, $assignment)
183			{
184			switch ($assignment) {
185			case static::ALL_PAGES:
186			$this->menus()->sync([static::ALL_PAGES]);
187			break;
188			case static::NO_PAGES:
189			$this->menus()->detach();
190			break;
191			case static::SELECTED_PAGES:
192			$this->menus()->sync($menu);
193			break;
194			}
195
196			return $this;
197			}
198
199			/**
200			* Get related menus.
201			*
202			* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
203			*/
204			public function menus()
205			{
206			return $this->belongsToMany(Menu::class, 'widget_menu');
207			}
208
209			/**
210			* Get related extension.
211			*
212			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
213			*/
214			public function extension()
215			{
216			return $this->belongsTo(Extension::class);
217			}
218			}
219

yajra / cms-core

Push — master ( aecbb4...773e85 )

Widget::boot() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like