Post::generateStructuredDataScript() - Code Metrics - Inspection of "Feature/posts structured data" - davide-casiraghi/movement_meets_life_nova - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Pull Request — main (#28)

by Enrico

created 2021-03-30 16:26 UTC

Post::generateStructuredDataScript() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	18
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	14
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	18
ccs	0
cts	0
cp	0
crap	2
rs	9.7998

<?php

namespace App\Models;

use App\Helpers\TextHelpers;
use App\Traits\HasStructuredData;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Spatie\MediaLibrary\HasMedia; //used for Gallery field
use Spatie\MediaLibrary\InteractsWithMedia; //used for Gallery field
use Spatie\MediaLibrary\MediaCollections\Models\Media; //used for Gallery field
use Spatie\ModelStatus\HasStatuses;
use Spatie\SchemaOrg\Schema;
use Spatie\SchemaOrg\Type;
use Spatie\Searchable\Searchable;
use Spatie\Searchable\SearchResult;
use Spatie\Sluggable\HasSlug;
use Spatie\Sluggable\SlugOptions;
use Spatie\Translatable\HasTranslations;

class Post extends Model implements HasMedia, Searchable
{
    use HasFactory;
    use HasSlug;

    use HasTranslations;
    use HasStatuses;

    use InteractsWithMedia;

    use HasStructuredData;

    /**
     * The attributes that aren't mass assignable.
     *
     * @var array
     */
    protected $guarded = [];

    /**
     * The attributes that are translatable.
     *
     * @var array
     */
    public $translatable = ['title','intro_text', 'body', 'introimage_alt'];

    /**
     * The parameters used in the index view search filters.
     *
     * @var array
     */
    public const SEARCH_PARAMETERS = [
        'title',
        'categoryId',
        'startDate',
        'endDate',
        'status',
    ];

    /**
     * The possible values the publishing status can be.
     */
    public const PUBLISHING_STATUS = [
        'unpublished' => 'unpublished',
        'published' => 'published',
    ];

    /**
     * Generates a unique slug.
     */
    public function getSlugOptions(): SlugOptions
    {
        return SlugOptions::create()
            ->generateSlugsFrom('title')
            ->saveSlugsTo('slug');
    }

    /**
     * Returns the author of the post.
     */
    public function user()
    {
        return $this->belongsTo(User::class);
    }

    /**
     * Returns the categories of the post.
     */
    public function category()
    {
        return $this->belongsTo(PostCategory::class, 'category_id');
    }

    /**
     * Returns the insights related to the the post.
     */
    public function insights()
    {
        return $this->belongsToMany(Insight::class);
    }

    /**
     * Returns the tags associated to the post.
     */
    public function tags()
    {
        return $this->belongsToMany(Tag::class);
    }

    /**
     * Get all of the post's comments.
     */
    public function comments()
    {
        return $this->morphMany('App\Models\Comment', 'commentable');
    }

    /**
     * Returns the reading time of the post.
     *
     * @param string|null $format
     *
     * @return string
     */
    public function readingTime(string $format = null): string
    {
        return TextHelpers::estimateReadingTime($this->body, 200, $format);
    }

    /**
     * Add Image gallery support using:
     * https://spatie.be/docs/laravel-medialibrary/v8/introduction
     * https://github.com/ebess/advanced-nova-media-library
     *
     * @param \Spatie\MediaLibrary\MediaCollections\Models\Media|null $media
     *
     * @throws \Spatie\Image\Exceptions\InvalidManipulation
     */
    public function registerMediaConversions(Media $media = null): void
    {
        $this->addMediaConversion('thumb')
            ->width(300)
            ->height(300);

        $this->addMediaConversion('facebook')
            ->width(1200)
            ->height(630);

        $this->addMediaConversion('twitter')
            ->width(1024)
            ->height(512);
    }

    public function registerMediaCollections(): void
    {
        $this->addMediaCollection('introimage')->singleFile();
        $this->addMediaCollection('images');
    }

    /**
     * Return true if the post is published
     *
     * @return bool
     */
    public function isPublished(): bool
    {
        return $this->latestStatus('unpublished', 'published') == 'published';
    }

    /**
     * Return the post publishing status
     *
     * @return string
     */
    public function publishingStatus(): string
    {
        return $this->latestStatus('unpublished', 'published');
    }

    /**
     * Method required by Spatie Laravel Searchable
     */
    public function getSearchResult(): SearchResult
    {
        $url = route('posts.edit', $this->id);

        return new SearchResult(
            $this,
            $this->title,
            $url
        );
    }

    /**
     * Factory method for generating the script for a blog post Schema.org type.
     *
     * @return Type
     */
    protected function generateStructuredDataScript(): Type
    {
        return Schema::blogPosting()
            ->name($this->title)
            ->headline($this->title)
            ->if($this->hasMedia('introimage'), function (\Spatie\SchemaOrg\BlogPosting $schema) {
                $schema->image($this->getMedia('introimage')->first()->getUrl());
            })
            ->about($this->category->name)
            ->about(/** @scrutinizer ignore-type */ $this->category->name)
            ->description($this->intro_text)
            ->author(Schema::person()
                ->name($this->user->profile->full_name)
            )
            ->dateCreated($this->created_at)
            ->dateCreated(/** @scrutinizer ignore-type */ $this->created_at)
            ->datePublished($this->created_at)
            ->datePublished(/** @scrutinizer ignore-type */ $this->created_at)
            ->dateModified($this->updated_at)
            ->dateModified(/** @scrutinizer ignore-type */ $this->updated_at)
            ->mainEntityOfPage(Schema::webPage()
                ->url(env('APP_URL').'/posts/'.$this->slug)
            );
    }
}


davide-casiraghi / movement_meets_life_nova

Pull Request — main (#28)

Post::generateStructuredDataScript() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like