Post::getStatuses() - Code Metrics - Inspection of "Updating the posts stuff" - ARCANESOFT/Blog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0c8810...349343 )

by ARCANEDEV

created 2017-01-20 14:18 UTC

Post::getStatuses() A

↳ Parent: Post

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
ccs	0
cts	6
cp	0
cc	1
eloc	3
nc	1
nop	0
crap	2

<?php namespace Arcanesoft\Blog\Models;

use Arcanedev\LaravelSeo\Traits\Seoable;
use Arcanesoft\Blog\Entities\PostStatus;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Str;

/**
 * Class     Post
 *
 * @package  Arcanesoft\Blog\Models
 * @author   ARCANEDEV <[email protected]>
 *
 * @property  int             id
 * @property  int             author_id
 * @property  int             category_id
 * @property  string          title
 * @property  string          slug
 * @property  string          excerpt
 * @property  string          content_raw
 * @property  string          content_html
 * @property  bool            is_draft
 * @property  \Carbon\Carbon  published_at
 * @property  \Carbon\Carbon  created_at
 * @property  \Carbon\Carbon  updated_at
 * @property  \Carbon\Carbon  deleted_at
 *
 * @property  \Arcanesoft\Contracts\Auth\Models\User  user
 * @property  \Arcanesoft\Blog\Models\Category        category
 *
 * @method  static  \Illuminate\Database\Eloquent\Builder  published()
 * @method  static  \Illuminate\Database\Eloquent\Builder  publishedAt(int $year)
 */
class Post extends AbstractModel
{
    /* ------------------------------------------------------------------------------------------------
     |  Constants
     | ------------------------------------------------------------------------------------------------
     */
    const STATUS_DRAFT     = 'draft';
    const STATUS_PUBLISHED = 'published';

    /* ------------------------------------------------------------------------------------------------
     |  Traits
     | ------------------------------------------------------------------------------------------------
     */
    use Seoable, SoftDeletes;

    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * The database table used by the model
     *
     * @var string
     */
    protected $table = 'posts';

    /**
     * The attributes that are mass assignable
     *
     * @var array
     */
    protected $fillable = [
        'author_id', 'category_id', 'title', 'excerpt', 'content', 'published_at'
    ];

    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = ['published_at', 'deleted_at'];

    /**
     * The attributes that should be casted to native types.
     *
     * @var array
     */
    protected $casts = [
        'author_id'   => 'integer',
        'category_id' => 'integer',
        'is_draft'    => 'boolean',
    ];

    /* ------------------------------------------------------------------------------------------------
     |  Scopes
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Scope only published posts.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $builder
     */
    public function scopePublished(Builder $builder)
    {
        $builder->where('is_draft', false)
                ->where('published_at', '<=', Carbon::now());
    }

    /**
     * Scope only published posts.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $builder
     * @param  int                                    $year
     */
    public function scopePublishedAt(Builder $builder, $year)
    {
        $this->scopePublished($builder);
        $builder->where(DB::raw('YEAR(published_at)'), $year);
    }

    /* ------------------------------------------------------------------------------------------------
     |  Relationships
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Author relationship.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function author()
    {
        return $this->belongsTo(
            config('auth.providers.users.model', \App\Models\User::class),
            'author_id'
        );
    }

    /**
     * Category relationship.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function category()
    {
        return $this->belongsTo(Category::class);
    }

    /**
     * Tags relationship.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function tags()
    {
        return $this->belongsToMany(Tag::class, "{$this->prefix}post_tag");
    }

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Set the title attribute.
     *
     * @param  string  $title
     */
    public function setTitleAttribute($title)
    {
        $this->attributes['title'] = $title;
        $this->attributes['slug']  = Str::slug($title);
    }

    /**
     * Set the content attribute.
     *
     * @param  string  $content
     */
    public function setContentAttribute($content)
    {
        $this->attributes['content_raw']  = $content;
        $this->attributes['content_html'] = markdown($content);
    }

    /**
     * Get the content attribute.
     *
     * @return \Illuminate\Support\HtmlString
     */
    public function getContentAttribute()
    {
        return new \Illuminate\Support\HtmlString($this->content_html);
    }

    /**
     * Set the status attribute.
     *
     * @param  string  $content
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function setStatusAttribute($status)
    {
        $this->attributes['is_draft'] = ($status === self::STATUS_DRAFT);
    }

    /**
     * Get the status name attribute.
     *
     * @return string|null
     */
    public function getStatusNameAttribute()
    {
        return self::getStatuses()->get(
            $this->isDraft() ? self::STATUS_DRAFT : self::STATUS_PUBLISHED
        );
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Create a post.
     *
     * @param  array  $inputs
     *
     * @return bool
     */
    public function createOne(array $inputs)
    {
        $attributes = [
            'author_id'   => auth()->user()->getAuthIdentifier(),
            'category_id' => $inputs['category'],
        ] + Arr::only($inputs, [
            'title', 'excerpt', 'content', 'published_at', 'status'
        ]);

        $this->fill($attributes);

        $saved = $this->save();
        $this->tags()->sync($inputs['tags']);

        $this->createSeo(
            $this->extractSeoAttributes($inputs)
        );

        return $saved;
    }

    /**
     * Create a post.
     *
     * @param  array  $inputs
     *
     * @return bool|int
     */
    public function updateOne(array $inputs)
    {
        $attributes = ['category_id' => $inputs['category']] + Arr::only($inputs, [
            'title', 'excerpt', 'content', 'published_at', 'status'
        ]);

        $updated = $this->update($attributes);
        $this->tags()->sync($inputs['tags']);

        $seoAttributes = $this->extractSeoAttributes($inputs);
        $this->hasSeo() ? $this->updateSeo($seoAttributes) : $this->createSeo($seoAttributes);

        return $updated;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Check Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Check if the post's status is "draft".
     *
     * @return bool
     */
    public function isDraft()
    {
        return $this->is_draft;
    }

    /**
     * Check if the post's status is "published".
     *
     * @return bool
     */
    public function isPublished()
    {
        return ! $this->isDraft();
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get the post statuses.
     *
     * @return \Illuminate\Support\Collection
     */
    public static function getStatuses()
    {
        return Collection::make(
            trans('blog::posts.statuses', [])
        );
    }

    /**
     * Extract the seo attributes.
     *
     * @param  array  $inputs
     *
     * @return array
     */
    protected function extractSeoAttributes(array $inputs)
    {
        return [
            'title'       => Arr::get($inputs, 'seo_title'),
            'description' => Arr::get($inputs, 'seo_description'),
            'keywords'    => Arr::get($inputs, 'seo_keywords'),
            'metas'       => Arr::get($inputs, 'seo_metas'),
        ];
    }
}


1			<?php namespace Arcanesoft\Blog\Models;
2
3			use Arcanedev\LaravelSeo\Traits\Seoable;
4			use Arcanesoft\Blog\Entities\PostStatus;
5			use Carbon\Carbon;
6			use Illuminate\Database\Eloquent\Builder;
7			use Illuminate\Database\Eloquent\SoftDeletes;
8			use Illuminate\Support\Arr;
9			use Illuminate\Support\Collection;
10			use Illuminate\Support\Facades\DB;
11			use Illuminate\Support\Str;
12
13			/**
14			* Class Post
15			*
16			* @package Arcanesoft\Blog\Models
17			* @author ARCANEDEV <[email protected]>
18			*
19			* @property int id
20			* @property int author_id
21			* @property int category_id
22			* @property string title
23			* @property string slug
24			* @property string excerpt
25			* @property string content_raw
26			* @property string content_html
27			* @property bool is_draft
28			* @property \Carbon\Carbon published_at
29			* @property \Carbon\Carbon created_at
30			* @property \Carbon\Carbon updated_at
31			* @property \Carbon\Carbon deleted_at
32			*
33			* @property \Arcanesoft\Contracts\Auth\Models\User user
34			* @property \Arcanesoft\Blog\Models\Category category
35			*
36			* @method static \Illuminate\Database\Eloquent\Builder published()
37			* @method static \Illuminate\Database\Eloquent\Builder publishedAt(int $year)
38			*/
39			class Post extends AbstractModel
40			{
41			/* ------------------------------------------------------------------------------------------------
42			\| Constants
43			\| ------------------------------------------------------------------------------------------------
44			*/
45			const STATUS_DRAFT = 'draft';
46			const STATUS_PUBLISHED = 'published';
47
48			/* ------------------------------------------------------------------------------------------------
49			\| Traits
50			\| ------------------------------------------------------------------------------------------------
51			*/
52			use Seoable, SoftDeletes;
53
54			/* ------------------------------------------------------------------------------------------------
55			\| Properties
56			\| ------------------------------------------------------------------------------------------------
57			*/
58			/**
59			* The database table used by the model
60			*
61			* @var string
62			*/
63			protected $table = 'posts';
64
65			/**
66			* The attributes that are mass assignable
67			*
68			* @var array
69			*/
70			protected $fillable = [
71			'author_id', 'category_id', 'title', 'excerpt', 'content', 'published_at'
72			];
73
74			/**
75			* The attributes that should be mutated to dates.
76			*
77			* @var array
78			*/
79			protected $dates = ['published_at', 'deleted_at'];
80
81			/**
82			* The attributes that should be casted to native types.
83			*
84			* @var array
85			*/
86			protected $casts = [
87			'author_id' => 'integer',
88			'category_id' => 'integer',
89			'is_draft' => 'boolean',
90			];
91
92			/* ------------------------------------------------------------------------------------------------
93			\| Scopes
94			\| ------------------------------------------------------------------------------------------------
95			*/
96			/**
97			* Scope only published posts.
98			*
99			* @param \Illuminate\Database\Eloquent\Builder $builder
100			*/
101			public function scopePublished(Builder $builder)
102			{
103			$builder->where('is_draft', false)
104			->where('published_at', '<=', Carbon::now());
105			}
106
107			/**
108			* Scope only published posts.
109			*
110			* @param \Illuminate\Database\Eloquent\Builder $builder
111			* @param int $year
112			*/
113			public function scopePublishedAt(Builder $builder, $year)
114			{
115			$this->scopePublished($builder);
116			$builder->where(DB::raw('YEAR(published_at)'), $year);
117			}
118
119			/* ------------------------------------------------------------------------------------------------
120			\| Relationships
121			\| ------------------------------------------------------------------------------------------------
122			*/
123			/**
124			* Author relationship.
125			*
126			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
127			*/
128			public function author()
129			{
130			return $this->belongsTo(
131			config('auth.providers.users.model', \App\Models\User::class),
132			'author_id'
133			);
134			}
135
136			/**
137			* Category relationship.
138			*
139			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
140			*/
141			public function category()
142			{
143			return $this->belongsTo(Category::class);
144			}
145
146			/**
147			* Tags relationship.
148			*
149			* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
150			*/
151			public function tags()
152			{
153			return $this->belongsToMany(Tag::class, "{$this->prefix}post_tag");
154			}
155
156			/* ------------------------------------------------------------------------------------------------
157			\| Getters & Setters
158			\| ------------------------------------------------------------------------------------------------
159			*/
160			/**
161			* Set the title attribute.
162			*
163			* @param string $title
164			*/
165			public function setTitleAttribute($title)
166			{
167			$this->attributes['title'] = $title;
168			$this->attributes['slug'] = Str::slug($title);
169			}
170
171			/**
172			* Set the content attribute.
173			*
174			* @param string $content
175			*/
176			public function setContentAttribute($content)
177			{
178			$this->attributes['content_raw'] = $content;
179			$this->attributes['content_html'] = markdown($content);
180			}
181
182			/**
183			* Get the content attribute.
184			*
185			* @return \Illuminate\Support\HtmlString
186			*/
187			public function getContentAttribute()
188			{
189			return new \Illuminate\Support\HtmlString($this->content_html);
190			}
191
192			/**
193			* Set the status attribute.
194			*
195			* @param string $content
			0 ignored issues – show Bug introduced 2017-01-20 14:24 UTC by Report Bug Copy Issue Report There is no parameter named `$content`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
196			*/
197			public function setStatusAttribute($status)
198			{
199			$this->attributes['is_draft'] = ($status === self::STATUS_DRAFT);
200			}
201
202			/**
203			* Get the status name attribute.
204			*
205			* @return string\|null
206			*/
207			public function getStatusNameAttribute()
208			{
209			return self::getStatuses()->get(
210			$this->isDraft() ? self::STATUS_DRAFT : self::STATUS_PUBLISHED
211			);
212			}
213
214			/* ------------------------------------------------------------------------------------------------
215			\| Main Functions
216			\| ------------------------------------------------------------------------------------------------
217			*/
218			/**
219			* Create a post.
220			*
221			* @param array $inputs
222			*
223			* @return bool
224			*/
225			public function createOne(array $inputs)
226			{
227			$attributes = [
228			'author_id' => auth()->user()->getAuthIdentifier(),
229			'category_id' => $inputs['category'],
230			] + Arr::only($inputs, [
231			'title', 'excerpt', 'content', 'published_at', 'status'
232			]);
233
234			$this->fill($attributes);
235
236			$saved = $this->save();
237			$this->tags()->sync($inputs['tags']);
238
239			$this->createSeo(
240			$this->extractSeoAttributes($inputs)
241			);
242
243			return $saved;
244			}
245
246			/**
247			* Create a post.
248			*
249			* @param array $inputs
250			*
251			* @return bool\|int
252			*/
253			public function updateOne(array $inputs)
254			{
255			$attributes = ['category_id' => $inputs['category']] + Arr::only($inputs, [
256			'title', 'excerpt', 'content', 'published_at', 'status'
257			]);
258
259			$updated = $this->update($attributes);
260			$this->tags()->sync($inputs['tags']);
261
262			$seoAttributes = $this->extractSeoAttributes($inputs);
263			$this->hasSeo() ? $this->updateSeo($seoAttributes) : $this->createSeo($seoAttributes);
264
265			return $updated;
266			}
267
268			/* ------------------------------------------------------------------------------------------------
269			\| Check Functions
270			\| ------------------------------------------------------------------------------------------------
271			*/
272			/**
273			* Check if the post's status is "draft".
274			*
275			* @return bool
276			*/
277			public function isDraft()
278			{
279			return $this->is_draft;
280			}
281
282			/**
283			* Check if the post's status is "published".
284			*
285			* @return bool
286			*/
287			public function isPublished()
288			{
289			return ! $this->isDraft();
290			}
291
292			/* ------------------------------------------------------------------------------------------------
293			\| Other Functions
294			\| ------------------------------------------------------------------------------------------------
295			*/
296			/**
297			* Get the post statuses.
298			*
299			* @return \Illuminate\Support\Collection
300			*/
301			public static function getStatuses()
302			{
303			return Collection::make(
304			trans('blog::posts.statuses', [])
305			);
306			}
307
308			/**
309			* Extract the seo attributes.
310			*
311			* @param array $inputs
312			*
313			* @return array
314			*/
315			protected function extractSeoAttributes(array $inputs)
316			{
317			return [
318			'title' => Arr::get($inputs, 'seo_title'),
319			'description' => Arr::get($inputs, 'seo_description'),
320			'keywords' => Arr::get($inputs, 'seo_keywords'),
321			'metas' => Arr::get($inputs, 'seo_metas'),
322			];
323			}
324			}
325

ARCANESOFT / Blog

Push — master ( 0c8810...349343 )

Post::getStatuses() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like