Rinvex\Pages\Traits\Pageable

Complexity

Total Complexity

12

Size/Duplication

Total Lines	212
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
	saved()	0	1	?
	deleted()	0	1	?
	morphToMany()	0	10	?
A	pages()	0	6	1
A	bootPageable()	0	6	1
A	setPagesAttribute()	0	6	1
A	scopeWithAllPages()	0	10	1
A	scopeWithAnyPages()	0	6	1
A	scopeWithoutPages()	0	6	1
A	scopeWithoutAnyPages()	0	4	1
A	hasAnyPages()	0	4	1
A	hasAllPages()	0	4	1
A	attachPages()	0	7	1
A	syncPages()	0	6	1
A	detachPages()	0	6	1

<?php

declare(strict_types=1);

namespace Rinvex\Pages\Traits;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Relations\MorphToMany;

trait Pageable
{
    /**
     * Register a saved model event with the dispatcher.
     *
     * @param \Closure|string $callback
     *
     * @return void
     */
    abstract public static function saved($callback);

    /**
     * Register a deleted model event with the dispatcher.
     *
     * @param \Closure|string $callback
     *
     * @return void
     */
    abstract public static function deleted($callback);

    /**
     * Define a polymorphic many-to-many relationship.
     *
     * @param string $related
     * @param string $name
     * @param string $table

Should the type for parameter $table not be string|null?

     * @param string $foreignPivotKey

Should the type for parameter $foreignPivotKey not be string|null?

     * @param string $relatedPivotKey

Should the type for parameter $relatedPivotKey not be string|null?

     * @param string $parentKey

Should the type for parameter $parentKey not be string|null?

     * @param string $relatedKey

Should the type for parameter $relatedKey not be string|null?

     * @param bool   $inverse
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphToMany
     */
    abstract public function morphToMany(
        $related,
        $name,
        $table = null,
        $foreignPivotKey = null,
        $relatedPivotKey = null,
        $parentKey = null,
        $relatedKey = null,
        $inverse = false
    );

    /**
     * Get all attached pages to the model.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphToMany
     */
    public function pages(): MorphToMany
    {
        return $this->morphToMany(config('rinvex.pages.models.page'), 'pageable', config('rinvex.pages.tables.pageables'), 'pageable_id', 'page_id')

The method orderBy() does not exist on Illuminate\Database\Eloquent\Relations\MorphToMany. Did you maybe mean orderByPivot()?

                    ->orderBy('sort_order')
                    ->withTimestamps();
    }

    /**
     * Boot the pageable trait for the model.
     *
     * @return void
     */
    public static function bootPageable()
    {
        static::deleted(function (self $model) {
            $model->pages()->detach();
        });
    }

    /**
     * Attach the given page(s) to the model.
     *
     * @param mixed $pages
     *
     * @return void
     */
    public function setPagesAttribute($pages): void
    {
        static::saved(function (self $model) use ($pages) {
            $model->syncPages($pages);
        });
    }

    /**
     * Scope query with all the given pages.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param mixed                                 $pages
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeWithAllPages(Builder $builder, $pages): Builder
    {
        collect($pages)->each(function ($page) use ($builder) {
            $builder->whereHas('pages', function (Builder $builder) use ($page) {
                return $builder->where('id', $page);
            });
        });

        return $builder;
    }

    /**
     * Scope query with any of the given pages.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param mixed                                 $pages
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeWithAnyPages(Builder $builder, $pages): Builder
    {
        return $builder->whereHas('pages', function (Builder $builder) use ($pages) {
            $builder->whereIn('id', $pages);
        });
    }

    /**
     * Scope query without any of the given pages.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     * @param mixed                                 $pages
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeWithoutPages(Builder $builder, $pages): Builder
    {
        return $builder->whereDoesntHave('pages', function (Builder $builder) use ($pages) {
            $builder->whereIn('id', $pages);
        });
    }

    /**
     * Scope query without any pages.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeWithoutAnyPages(Builder $builder): Builder
    {
        return $builder->doesntHave('pages');
    }

    /**
     * Determine if the model has any of the given pages.
     *
     * @param mixed $pages
     *
     * @return bool
     */
    public function hasAnyPages($pages): bool
    {
        return ! $this->pages->pluck('id')->intersect($pages)->isEmpty();

The property pages does not exist. Did you maybe forget to declare it?

    }

    /**
     * Determine if the model has all of the given pages.
     *
     * @param mixed $pages
     *
     * @return bool
     */
    public function hasAllPages($pages): bool
    {
        return collect($pages)->diff($this->pages->pluck('id'))->isEmpty();
    }

    /**
     * Attach model pages.
     *
     * @param mixed $pages
     *
     * @return $this
     */
    public function attachPages($pages)
    {
        // Use 'sync' not 'attach' to avoid Integrity constraint violation
        $this->pages()->sync($pages, false);

        return $this;
    }

    /**
     * Sync model pages.
     *
     * @param mixed $pages
     * @param bool  $detaching
     *
     * @return $this
     */
    public function syncPages($pages, bool $detaching = true)
    {
        $this->pages()->sync($pages, $detaching);

        return $this;
    }

    /**
     * Detach model pages.
     *
     * @param mixed $pages
     *
     * @return $this
     */
    public function detachPages($pages = null)
    {
        $this->pages()->detach($pages);

        return $this;
    }
}