Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lecturize/laravel-tags
Simple way to tag Eloquent models in Laravel.
https://github.com/lecturize/laravel-tags
Last synced: about 1 month ago
JSON representation
Simple way to tag Eloquent models in Laravel.
- Host: GitHub
- URL: https://github.com/lecturize/laravel-tags
- Owner: Lecturize
- License: mit
- Created: 2015-09-02T22:54:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-21T20:24:33.000Z (almost 2 years ago)
- Last Synced: 2024-04-26T05:04:30.014Z (9 months ago)
- Language: PHP
- Homepage:
- Size: 53.7 KB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/lecturize/laravel-tags)
[](https://packagist.org/packages/lecturize/laravel-tags)
[](https://packagist.org/packages/lecturize/laravel-tags)
# Laravel Tags
Simple way to tag eloquent models in Laravel.
## Installation
Require the package from your `composer.json` file
```php
"require": {
"lecturize/laravel-tags": "^1.0"
}
```
and run `$ composer update` or both in one with `$ composer require lecturize/laravel-tags`.
## Configuration & Migration
```bash
$ php artisan vendor:publish --provider="Cviebrock\EloquentSluggable\ServiceProvider"
$ php artisan vendor:publish --provider="Lecturize\Tags\TagsServiceProvider"
```
This will publish a `config/sluggable.php`, a `config/lecturize.php` and some migration files, that you'll have to run:
```bash
$ php artisan migrate
```
For migrations to be properly published ensure that you have added the directory `database/migrations` to the classmap in your projects `composer.json`.
## Usage
First, add our `HasTags` trait to your model.
```php
```
##### Get all tags for a model
```php
$tags = $model->tags();
```
##### Check if model is tagged with a given tag
```php
$tags = $model->hasTag('Check');
```
##### Add one or more tags
```php
$tags = $model->tag('My First Tag');
$tags = $model->tag(['First', 'Second', 'Third']);
```
##### Remove given tags from model
```php
$tags = $model->untag('Remove');
```
##### Replace all existing tags for a model with new ones
```php
$tags = $model->retag('A New Tag');
$tags = $model->retag(['Fourth', 'Fifth', 'Sixth']);
```
##### Remove all existing tags from model
```php
$tags = $model->detag();
```
##### Get a list of all tags
```php
$tags = $model->listTags();
```
This is a convenience method for `$model->tags->pluck('tag')`
##### Scopes
There are two scopes included to fluently query models (e.g. Posts) with given tags.
```php
$posts = Post::withTag('My First Tag')->get();
$posts = Post::withTags(['First', 'Second', 'Third'])->get();
```
## License
Licensed under [MIT license](http://opensource.org/licenses/MIT).
## Author
**Handcrafted with love by [Alexander Manfred Poellmann](https://twitter.com/AMPoellmann) in Vienna & Rome.**