Tags System

Lightpack's Tags system provides framework-native way to add tagging support to any Lucid model. It is designed for many-to-many polymorphic tagging (e.g., posts, products, users can all be tagged).

Migration

The Tags system uses two tables:

Create schema migration file:

php console create:migration --support=tags

Run migration:

php console migrate:up

Adding Tagging to Your Model

Add TagsTrait to any model to make it taggable:

use Lightpack\Tags\TagsTrait;

class Post extends Model {
    use TagsTrait;
}

TagsTrait API

tags()

Returns the model's tags. Can be accessed as a property or method.

$tags = $post->tags;

Pivot Operations

Use the pivot methods to manage tag associations:

// Attach tags by ID
$post->tags()->attach([1, 2, 3]);

// Detach tags by ID
$post->tags()->detach([2]);

// Sync tags (replace all with given IDs)
$post->tags()->sync([1, 3]);

filters()

Query scope to filter models by tag IDs.

// All posts with tag 1 or 2
$posts = Post::filters(['tags' => [1, 2]])->all();

Multi-Tenancy

If your model extends TenantModel, tags are automatically scoped to the current tenant.

Basic Usage

use Lightpack\Tags\TagsTrait;

class Post extends TenantModel {
    use TagsTrait;
}
TenantContext::set($tenantId);

// Creates tag with tenant_id automatically set
$tag = new TenantTag(['name' => 'News', 'slug' => 'news']);
$tag->save();

// Only returns this tenant's tags
$tags = $post->tags;

Custom Tag Model

Override getTagModel() if you need a custom tag model with additional methods:

class Post extends TenantModel {
    use TagsTrait;

    protected function getTagModel(): string
    {
        return AppTag::class;
    }
}

Edge Cases & Behavior