Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ramadani/catagger
Create types for Item on your Laravel App
https://github.com/ramadani/catagger
categorization laravel laravel-package taggable
Last synced: 29 days ago
JSON representation
Create types for Item on your Laravel App
- Host: GitHub
- URL: https://github.com/ramadani/catagger
- Owner: ramadani
- License: mit
- Created: 2016-10-23T01:21:36.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-11-03T23:02:27.000Z (about 8 years ago)
- Last Synced: 2024-04-17T23:46:55.010Z (8 months ago)
- Topics: categorization, laravel, laravel-package, taggable
- Language: PHP
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Catagger
Simple way to creating types for item on your Laravel App, such as category and tag for article or product, genre for movie, skill for user, etc.
## Installation
In order to install Catagger, just enter on your terminal
```bash
$ composer require redustudio/catagger
```
In `config/app.php` file, add
```php
Redustudio\Catagger\ServiceProvider::class,
```
in the `providers` array and
```php
'Catagger' => Redustudio\Catagger\Facade::class,
```
to the `aliases` array.
If you are not using Laravel 5.3, run this command for publishing migration.
```bash
$ php artisan vendor:publish --provider="Redustudio\Catagger\ServiceProvider" --tag="migrations"
```
then
```bash
$ php artisan migrate
```
for migration catagger tables.
## Usage
#### Attaching to Item
```php
// Post
use Redustudio\Catagger\CataggerTrait;
class Post extends Model
{
use CataggerTrait;
public function categories()
{
return $this->cataggers('category');
}
public function tags()
{
return $this->cataggers('tag');
}
}
$category = 'Programming';
Catagger::sync($post->categories(), $category);
$tags = ['PHP', 'Laravel', 'Package'];
Catagger::sync($post->tags(), $tags);
```
```php
// Movie
use Redustudio\Catagger\CataggerTrait;
class Movie extends Model
{
use CataggerTrait;
public function genres()
{
return $this->cataggers('genre');
}
}
$genres = ['Action', 'Adventure', 'Sci-Fi'];
Catagger::sync($movie->genres(), $genres);
```
#### Detaching from Item
```php
$genres = ['Action', 'Adventure', 'Sci-Fi'];
Catagger::sync($movie->genres(), $genres);
$genres = ['Action', 'Sci-Fi'];
Catagger::detach($movie->genres(), $genres); // detaching 'Action' and `Sci-Fi`
// detaching all genres
Catagger::detach($movie->genres());
```
## Todo
- [ ] Unit Test
## About ReduStudio
[ReduStudio][homepage] is web development freelancers based in Yogyakarta and East Borneo, Indonesia. We specialise in developing websites and web apps with Laravel, the most popular PHP Framework.
### Let's Start Project With Us
Just Contact Us At:
- Email: [[email protected]][mailto]
- Facebook: [ReduStudio's FB Page][fbpage]
## License
The [MIT][mitlink] License (MIT). Please see [License File](LICENSE.md) for more information.
[screenshot]: admin.png
[homepage]: http://redustudio.com/
[mailto]: mailto:[email protected]
[fbpage]: https://www.facebook.com/Redustudio/
[mitlink]: http://opensource.org/licenses/MIT