Thinktomorrow\Chief\Urls\UrlRecord

Complexity

Total Complexity

21

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	2	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getByModel()	0	5	1
A	findByModel()	0	13	2
A	findBySlug()	0	17	3
A	replaceAndRedirect()	0	11	1
A	findRecentRedirect()	0	8	1
A	redirectTo()	0	10	3
A	revert()	0	14	3
A	isRedirect()	0	3	1
A	existsIgnoringRedirects()	0	3	1
A	exists()	0	22	4
A	isHomepage()	0	3	1

<?php

namespace Thinktomorrow\Chief\Urls;

use Illuminate\Database\Eloquent\Model;

class UrlRecord extends Model
{
    public $table = 'chief_urls';

    public $guarded = [];

    /**
     * Find matching url record for passed slug and locale. The locale parameter will try
     * to match specific given locales first and records without locale as fallback.
     *
     * @param string $slug
     * @param string $locale
     * @return UrlRecord
     * @throws UrlRecordNotFound
     */
    public static function findBySlug(string $slug, string $locale): UrlRecord
    {
        // Clear the input from any trailing slashes.
        if ($slug != '/') {
            $slug = trim($slug, '/');
        }

        $record = static::where('slug', $slug)
                        ->where('locale', $locale)
                        ->orderBy('redirect_id', 'ASC')
                        ->first();

        if (!$record) {
            throw new UrlRecordNotFound('No url record found by slug ['.$slug.'] for locale ['.$locale.'].');
        }

        return $record;
    }

    /**
     * Find matching url record for passed slug and locale. The locale parameter will try
     * to match specific given locales first and records without locale as fallback.
     *
     * @param Model $model
     * @param string $locale
     * @return UrlRecord
     * @throws UrlRecordNotFound
     */
    public static function findByModel(Model $model, string $locale): UrlRecord
    {
        $record = static::where('model_type', $model->getMorphClass())
            ->where('model_id', $model->id)
            ->where('locale', $locale)
            ->orderBy('redirect_id', 'ASC')
            ->first();

        if (!$record) {
            throw new UrlRecordNotFound('No url record found for model ['.$model->getMorphClass().'@'.$model->id.'] for locale ['.$locale.'].');
        }

        return $record;
    }

    public static function getByModel(Model $model)
    {
        return static::where('model_type', $model->getMorphClass())
                     ->where('model_id', $model->id)
                     ->get();
    }

    public static function findRecentRedirect(Model $model, string $locale): ?self
    {
        return static::where('model_type', $model->getMorphClass())
            ->where('model_id', $model->id)
            ->where('locale', $locale)
            ->where('redirect_id', '<>', null)
            ->orderBy('updated_at', 'DESC')
            ->first();
    }

    public function replaceAndRedirect(array $values): UrlRecord
    {
        $newRecord = static::create(array_merge([
            'locale'              => $this->locale,
            'model_type'          => $this->model_type,
            'model_id'            => $this->model_id,
        ], $values));

        $this->redirectTo($newRecord);

        return $newRecord;
    }

    public function redirectTo(self $record = null): ?UrlRecord
    {
        if (!$record) {
            return $this->isRedirect() ? static::find($this->redirect_id) : null;
        }

        $this->redirect_id = $record->id;
        $this->save();

        return null;
    }

    // Remove all urls that came after this one
    public function revert()
    {
        if (!$this->isRedirect()) {
            return;
        }

        // Remove this redirect relation so it's no longer cascading when main url is getting deleted.
        $redirect_id = $this->redirect_id;
        $this->redirect_id = null;
        $this->save();

        if ($record = static::where('id', $redirect_id)->first()) {
            $record->revert();
            $record->delete();
        }
    }

    public function isRedirect(): bool
    {
        return !!($this->redirect_id);
    }

    public function isHomepage(): bool
    {
        return $this->slug === '/';
    }

    public static function existsIgnoringRedirects($slug, string $locale = null, Model $ignoredModel = null): bool
    {
        return static::exists($slug, $locale, $ignoredModel, false);
    }

    public static function exists($slug, string $locale = null, Model $ignoredModel = null, bool $includeRedirects = true): bool
    {
        $builder = static::where('slug', $slug);

        if ($locale) {
            $builder->where('locale', $locale);
        }

        if (! $includeRedirects) {
            $builder->whereNull('redirect_id');
        }

        if ($ignoredModel) {
            $builder->whereNotIn('id', function ($query) use ($ignoredModel) {
                $query->select('id')
                      ->from('chief_urls')
                      ->where('model_type', '=', $ignoredModel->getMorphClass())
                      ->where('model_id', '=', $ignoredModel->id);
            });
        }

        return ($builder->count() > 0);
    }
}