rtconner / laravel-tagging

src/Model/Tag.php

<?php

namespace Conner\Tagging\Model;

use Conner\Tagging\TaggingUtility;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

/**
 * @package Conner\Tagging\Model
 * @property string id
 * @property string name
 * @property string slug
 * @property bool suggest
 * @property integer count
 * @property TagGroup group
 * @method static suggested()
 * @method static inGroup(string $groupName)
 */
class Tag extends Model
{
    protected $table = 'tagging_tags';
    public $timestamps = false;
    public $fillable = ['name'];

    /**
     * @param array $attributes
     */
    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);

        $this->connection = config('tagging.connection');
    }

    /**
     * @inheritDoc
     */
    public function save(array $options = [])
    {
        if(strlen($this->name) < 1) {
            throw new \RuntimeException('Cannot save a tag with an empty name');
        }

        $this->slug = TaggingUtility::normalize($this->name);

        return parent::save($options);
    }

    /**
     * Tag group setter
     * @param string $groupName
     * @return Tag
     */
    public function setGroup($groupName)
    {
        $tagGroup = TagGroup::query()
            ->where('slug', TaggingUtility::normalize($groupName))
            ->first();

        if ($tagGroup) {
            $this->group()->associate($tagGroup);
            $this->save();

            return $this;
        } else {
            throw new \RuntimeException('No Tag Group found: '. $groupName);
        }
    }

    /**
     * Tag group remove
     * @param string $groupName
     * @return Tag
     */
    public function removeGroup(string $groupName)
    {
        $tagGroup = TagGroup::query()->where('slug', TaggingUtility::normalize($groupName))->first();

        if ($tagGroup) {
            $this->group()->dissociate($tagGroup);

The call to Illuminate\Database\Eloquent\Relations\BelongsTo::dissociate() has too many arguments starting with $tagGroup.

            $this->save();

            return $this;
        } else {
            throw new \RuntimeException('No Tag Group found: '. $groupName);
        }
    }

    /**
     * Tag group helper function
     * @param string $groupName
     * @return bool
     */
    public function isInGroup($groupName): bool
    {
        if ($this->group && ($this->group->slug == TaggingUtility::normalize($groupName))) {
            return true;
        }

        return false;
    }

    /**
     * Tag group relationship
     */
    public function group()
    {
        return $this->belongsTo(TagGroup::class, 'tag_group_id');
    }

    /**
     * Get suggested tags
     */
    public function scopeSuggested($query)
    {
        return $query->where('suggest', true);
    }

    /**
     * Get suggested tags
     * @param Builder $query
     * @param $groupName
     * @return Builder
     */
    public function scopeInGroup(Builder $query, $groupName)
    {
        $groupSlug = TaggingUtility::normalize($groupName);

        return $query->whereHas('group', function (Builder $query) use ($groupSlug) {
            $query->where('slug', $groupSlug);
        });
    }

    /**
     * Set the name of the tag : $tag->name = 'myname';
     *
     * @param string $value
     */
    public function setNameAttribute(string $value)
    {
        $this->attributes['name'] = TaggingUtility::displayize($value);
    }

    /**
     * Look at the tags table and delete any tags that are no longer in use by any taggable database rows.
     * Does not delete tags where 'suggest' value is true
     *
     * @return mixed
     */
    public static function deleteUnused()
    {
        return (new static)->newQuery()
            ->where('count', '=', 0)
            ->where('suggest', false)
            ->delete();
    }
}