ContentfulModel::defaultCasts() - Code Metrics - Inspection of "Fix Docblock" - Distilleries/Laravel-Contentful-Utilities - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 62a47c...f8e5cb )

unknown
created 2018-07-30 12:40 UTC
ContentfulModel::defaultCasts() A

↳ Parent: ContentfulModel
Complexity

Conditions	1
Paths	1
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	6
ccs	0
cts	6
cp	0
crap	2
rs	10
c	0
b	0
f	0
<?php

namespace Distilleries\Contentful\Models\Base;

use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Model;
use Distilleries\Contentful\Models\Asset;
use Distilleries\Contentful\Models\Traits\Localable;
use Distilleries\Contentful\Models\EntryRelationship;

abstract class ContentfulModel extends Model
{
    use Localable;

    /**
     * {@inheritdoc}
     */
    protected $primaryKey = 'contentful_id';

    /**
     * The content-type ID.
     *
     * @var string
     */
    protected $contentType = null;

    /**
     * {@inheritdoc}
     */
    protected $keyType = 'string';

    /**
     * {@inheritdoc}
     */
    public $incrementing = false;

    /**
     * ContentfulModel constructor.
     *
     * @param  array  $attributes
     * @return void

     */
    public function __construct(array $attributes = [])
    {
        // Override fillable
        foreach ($this->defaultFillable() as $defaultFillable) {
            if (! in_array($defaultFillable, $this->fillable)) {
                $this->fillable[] = $defaultFillable;
            }
        }

        // Override casts
        foreach ($this->defaultCasts() as $field => $type) {
            if (! isset($this->casts[$field])) {
                $this->casts[$field] = $type;
            }
        }

        $this->initContentType();

        parent::__construct($attributes);
    }

    /**
     * Init model content-type if needed.
     *
     * @return void
     */
    protected function initContentType()
    {
        if (empty($this->contentType)) {
            $this->contentType = lcfirst(class_basename(get_class($this)));
        }
    }

    /**
     * Return default fillable fields.
     *
     * @return array
     */
    public function defaultFillable(): array
    {
        return [
            'contentful_id',
            'country',
            'locale',
            'payload',
            'created_at',
            'updated_at',
        ];
    }

    /**
     * Return default casted fields.
     *
     * @return array
     */
    public function defaultCasts(): array
    {
        return [
            'payload' => 'array',
        ];
    }

    // --------------------------------------------------------------------------------
    // --------------------------------------------------------------------------------
    // --------------------------------------------------------------------------------

    /**
     * Return Contentful Asset for given link (sys or ID).
     *
     * @param  array|string|null  $link
     * @return \Distilleries\Contentful\Models\Asset|null
     */
    protected function contentfulAsset($link): ?Asset
    {
        $assetId = $this->contentfulLinkId($link);

        if (empty($assetId)) {
            return null;
        }

        $asset = (new Asset)->query()
            ->where('contentful_id', '=', $assetId)
            ->where('locale', '=', $this->locale)
            ->where('country', '=', $this->country)
            ->first();

        return ! empty($asset) ? $asset : null;
    }

    /**
     * Return payload of related Contentful entries.
     *
     * @param  string  $payload
     * @param  array  $links
     * @param  mixed  $query
     * @return \Illuminate\Support\Collection
     */
    protected function getAndSetPayloadContentfulEntries(string $payload, array $links, $query = null): Collection
    {
        if (empty($this->attributes[$payload])) {
            return collect();
        }

        if (! is_object($this->attributes[$payload])) {
            $this->attributes[$payload] = $this->contentfulEntries($links, $query);
        }

        return $this->attributes[$payload];
    }

    /**
     * Return payload of related Contentful entry.
     *
     * @param  string  $payload
     * @param  array  $links
     * @param  mixed  $query
     * @return \Distilleries\Contentful\Models\Base\ContentfulModel|null
     */
    protected function getAndSetPayloadContentfulEntry(string $payload, array $links, $query = null): ?ContentfulModel
    {
        if (empty($this->attributes[$payload])) {
            return null;
        }

        if (! is_object($this->attributes[$payload])) {
            $this->attributes[$payload] = $this->contentfulEntry($links, $query);
        }

        return $this->attributes[$payload];
    }

    /**
     * Return Contentful Entry for given link (sys or ID).
     *
     * @param  array|string|null  $link
     * @param  mixed  $query
     * @return \Distilleries\Contentful\Models\Base\ContentfulModel|null
     */
    protected function contentfulEntry($link, $query = null): ?ContentfulModel
    {
        $entryId = $this->contentfulLinkId($link);

        if (empty($entryId)) {
            return null;
        }

        $entries = $this->contentfulEntries([$entryId], $query);

        return $entries->isNotEmpty() ? $entries->first(): null;
    }

    /**
     * Return Contentful Entries for given ID.
     *
     * @param  array  $links
     * @param  mixed  $query
     * @return \Illuminate\Support\Collection
     */
    protected function contentfulEntries(array $links, $query = null): Collection
    {
        $entries = [];

        $entryIds = [];
        foreach ($links as $link) {
            $entryId = $this->contentfulLinkId($link);
            if (! empty($entryId)) {
                $entryIds[] = $entryId;
            }
        }

        if (! empty($entryIds)) {
            $relationships = EntryRelationship::query()

                ->select('related_contentful_id', 'related_contentful_type', 'order')
                ->distinct()
                ->locale($this->locale, $this->country)
                ->where('source_contentful_id', '=', $this->contentful_id)
                ->whereIn('related_contentful_id', $entryIds)
                ->orderBy('order', 'asc')
                ->get();

            foreach ($relationships as $relationship) {
                if ($relationship->related_contentful_type === 'asset') {
                    $model = new Asset;
                } else {
                    $modelClass = config('contentful.namespace.model') . '\\' . studly_case($relationship->related_contentful_type);
                    $model = new $modelClass;
                }

                $instance = $model->query()
                    ->where('country', '=', $this->country)
                    ->where('locale', '=', $this->locale)
                    ->where('contentful_id', '=', $relationship->related_contentful_id);

                if (! empty($query)) {
                    $instance = call_user_func($query, $instance);
                }

                $instance = $instance->first();

                if (! empty($instance)) {
                    $entries[] = $instance;
                }
            }
        }

        return collect($entries);
    }

    /**
     * Return a collection of related models for base Contentful ID.
     *
     * @param  string  $contentfulId
     * @param  string  $contentfulType
     * @return \Illuminate\Support\Collection
     */
    protected function contentfulRelatedEntries(string $contentfulId, string $contentfulType = ''): Collection
    {
        $entries = [];

        $query = EntryRelationship::query()

            ->select('source_contentful_id', 'source_contentful_type', '')
            ->locale($this->locale, $this->country)
            ->where('related_contentful_id', '=', $contentfulId);

        if (! empty($contentfulType)) {
            $query = $query->where('source_contentful_type', '=', $contentfulType);
        }

        $relationships = $query->orderBy('order', 'asc')->get();
        foreach ($relationships as $relationship) {
            if ($relationship->source_contentful_type === 'asset') {
                $model = new Asset;
            } else {
                $modelClass = rtrim(config('contentful.namespace.model'), '\\') . '\\' . studly_case($relationship->source_contentful_type);
                $model = new $modelClass;
            }

            $instance = $model->query()
                ->locale($this->locale, $this->country)
                ->where('contentful_id', '=', $relationship->source_contentful_id)
                ->first();

            if (! empty($instance)) {
                $entries[] = $instance;
            }
        }

        return collect($entries);
    }

    /**
     * Return Contentful link ID.
     *
     * @param  mixed  $link
     * @return string|null
     */
    protected function contentfulLinkId($link): ?string
    {
        if (empty($link)) {
            return null;
        }

        if (is_string($link)) {
            return $link;
        }

        if (is_array($link) and isset($link['sys']) and isset($link['sys']['id'])) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            return $link['sys']['id'];
        }

        return null;
    }

    /**
     * Return model Contentful content-type.
     *
     * @return string
     */
    public function getContentType(): string
    {
        return $this->contentType;
    }

    /**
     * Return ID attribute.
     *
     * @return mixed
     */
    public function getIdAttribute()
    {
        return $this->getKey();
    }

    /**
     * Magical extended toArray().
     *
     * @return array
     */
    public function toArray()
    {
        $array = parent::toArray();

        foreach ($this->getMutatedAttributes() as $key) {
            if (! array_key_exists($key, $array)) {
                $array[$key] = $this->{$key};
            }
        }

        return $array;
    }
}

Distilleries / Laravel-Contentful-Utilities

Push — master ( 62a47c...f8e5cb )

ContentfulModel::defaultCasts() A

Complexity

Size

Duplication

Code Coverage

Importance

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like
