Taggable Behavior for Yii 2

A modern taggable behavior for the Yii framework.

Installation

The preferred way to install this extension is through composer.

Either run

$ php composer.phar require creocoder/yii2-taggable

or add

"creocoder/yii2-taggable": "*"

to the require section of your composer.json file.

Migrations

Run the following command

$ yii migrate/create create_post_table

Open the /path/to/migrations/m_xxxxxx_xxxxxx_create_post_table.php file, inside the up() method add the following

$this->createTable('{{%post}}', [
    'id' => Schema::TYPE_PK,
    'title' => Schema::TYPE_STRING . ' NOT NULL',
    'body' => Schema::TYPE_TEXT . ' NOT NULL',
]);

Run the following command

$ yii migrate/create create_tag_table

Open the /path/to/migrations/m_xxxxxx_xxxxxx_create_tag_table.php file, inside the up() method add the following

$this->createTable('{{%tag}}', [
    'id' => Schema::TYPE_PK,
    'name' => Schema::TYPE_STRING . ' NOT NULL',
    'frequency' => Schema::TYPE_INTEGER . ' NOT NULL DEFAULT 0',
]);

Run the following command

$ yii migrate/create create_post_tag_assn_table

Open the /path/to/migrations/m_xxxxxx_xxxxxx_create_post_tag_assn_table.php file, inside the up() method add the following

$this->createTable('{{%post_tag_assn}}', [
    'post_id' => Schema::TYPE_INTEGER . ' NOT NULL',
    'tag_id' => Schema::TYPE_INTEGER . ' NOT NULL',
]);

$this->addPrimaryKey('', '{{%post_tag_assn}}', ['post_id', 'tag_id']);

Configuring

Configure model as follows

use creocoder\taggable\TaggableBehavior;

/**
 * ...
 * @property string $tagNames
 */
class Post extends \yii\db\ActiveRecord
{
    public function behaviors()
    {
        return [
            'taggable' => [
                'class' => TaggableBehavior::className(),
                // 'tagNamesAsArray' => false,
                // 'tagRelation' => 'tags',
                // 'tagNameAttribute' => 'name',
                // 'tagFrequencyAttribute' => 'frequency',
            ],
        ];
    }

    public function rules()
    {
        return [
            //...
            ['tagNames', 'safe'],
        ];
    }

    public function transactions()
    {
        return [
            self::SCENARIO_DEFAULT => self::OP_ALL,
        ];
    }

    public static function find()
    {
        return new PostQuery(get_called_class());
    }

    public function getTags()
    {
        return $this->hasMany(Tag::className(), ['id' => 'tag_id'])
            ->viaTable('{{%post_tag_assn}}', ['post_id' => 'id']);
    }
}

Model Tag can be generated using Gii.

Configure query class as follows

use creocoder\taggable\TaggableQueryBehavior;

class PostQuery extends \yii\db\ActiveQuery
{
    public function behaviors()
    {
        return [
            TaggableQueryBehavior::className(),
        ];
    }
}

Usage

Setting tags to the entity

To set tags to the entity

$post = new Post();

// through string
$post->tagNames = 'foo, bar, baz';

// through array
$post->tagNames = ['foo', 'bar', 'baz'];

Adding tags to the entity

To add tags to the entity

$post = Post::findOne(1);

// through string
$post->addTagNames('bar, baz');

// through array
$post->addTagNames(['bar', 'baz']);

Remove tags from the entity

To remove tags from the entity

$post = Post::findOne(1);

// through string
$post->removeTagNames('bar, baz');

// through array
$post->removeTagNames(['bar', 'baz']);

Getting tags from the entity

To get tags from the entity

$posts = Post::find()->with('tags')->all();

foreach ($posts as $post) {
    // as string
    $tagNames = $post->tagNames;

    // as array
    $tagNamesAsArray = $post->getTagNames(true);
}

Return type of getTagNames can also be configured globally via tagNamesAsArray property.

Checking for tags in the entity

To check for tags in the entity

$post = Post::findOne(1);

// through string
$result = $post->hasTagNames('foo, bar');

// through array
$result = $post->hasTagNames(['foo', 'bar']);

Search entities by any tags

To search entities by any tags

// through string
$posts = Post::find()->anyTagNames('foo, bar')->all();

// through array
$posts = Post::find()->anyTagNames(['foo', 'bar'])->all();

Search entities by all tags

To search entities by all tags

// through string
$posts = Post::find()->allTagNames('foo, bar')->all();

// through array
$posts = Post::find()->allTagNames(['foo', 'bar'])->all();

Search entities related by tags

To search entities related by tags

// through string
$posts = Post::find()->relatedByTagNames('foo, bar')->all();

// through array
$posts = Post::find()->relatedByTagNames(['foo', 'bar'])->all();

Donating

Support this project and others by creocoder via gratipay.