Fomvasss\Taxonomy\Models\Traits\HasTaxonomies

Complexity

Total Complexity

8

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	term()	0	5	1
A	scopeByTaxonomies()	0	12	4
A	scopeTermsByVocabulary()	0	4	1
A	terms()	0	5	1
A	termsByVocabulary()	0	3	1

<?php

namespace Fomvasss\Taxonomy\Models\Traits;

use Fomvasss\Taxonomy\Models\Term;

/**
 * Трейт для пользовательских классов-моделей котории имею таксономию (статьи, товары,...)
 *
 * Trait HasTaxonomies
 *
 * @package App\Models\Traits
 */
trait HasTaxonomies
{
    /**
     * Связь:
     * Сущность текущей модели "относится" к разным термам.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphToMany
     */
    public function terms()
    {
        $related = config('taxonomy.models.term', Term::class);

The function config was not found. Maybe you did not declare it correctly or list all dependencies?

        return $this->morphToMany($related, 'termable');

It seems like morphToMany() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
    
    /**
     * Связь текущей модели с термамы по указанному system_name словаря.
     * Используется для создание связей с термамы нужного словаря в пользовательских моделях.
     *
     * @param $vocabulary
     * @param string|null $vocabularyKey
     * @return mixed
     */
    public function termsByVocabulary($vocabulary)
    {
        return $this->terms()->where('vocabulary', $vocabulary);
    }

    /**
     * Термы текущей модели по указанному system_name словаря.
     *
     * @param $query
     * @param $vocabulary
     * @param string $vocabularyKey
     * @return \Illuminate\Database\Eloquent\Builder|static
     */
    public function scopeTermsByVocabulary($query, $vocabulary)
    {
        return $query->whereHas('terms', function ($t) use ($vocabulary) {
            $t->where('vocabulary', $vocabulary);
        });
    }

    /**
     * Сущности по указанным термам с соответствующих
     * указанных словарей, например:
     * получить все Статьи терма-категории "WEB-Программирование" (23) с словаря "Категории статтей" И 
     * терма-города "Киев" (35) или "Москва" (56) с словаря "Города"
     *
     * @param $query
     * @param array $taxonomies Например:
     *  [
     *      'article_categories' => 23,
     *      'cities' => [35, 56]
     *  ]
     * @param string $termKey
     * @param string $vocabularyKey
     * @return mixed
     */
    public function scopeByTaxonomies($query, array $taxonomies, string $termKey = 'id')
    {
        foreach ($taxonomies as $vocabulary => $terms) {
            $terms = is_array($terms) ? $terms : [$terms];
            if (! empty($terms)) {
                $query->whereHas('terms', function ($t) use ($vocabulary, $terms, $termKey) {
                    $t->where('vocabulary', $vocabulary)->whereIn($termKey, $terms);
                });
            }
        }

        return $query;
    }


    /**
     * Связь:
     * Сущность текущая модель "имеет" один терм.
     * Ключ для связи находится в таблице сущности (Ex.: articles.term_id)
     *
     * @param null $foreignKey

Are you sure the doc-type for parameter $foreignKey is correct as it would always require null to be passed?

     * @param null $ownerKey

Are you sure the doc-type for parameter $ownerKey is correct as it would always require null to be passed?

     * @return mixed
     */
    public function term($foreignKey = null, $ownerKey = null, $relation = null)
    {
        $related = config('taxonomy.models.term', Term::class);

The function config was not found. Maybe you did not declare it correctly or list all dependencies?

        return $this->belongsTo($related, $foreignKey, $ownerKey, $relation);

It seems like belongsTo() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}