shetabit / stampable
Add stamp behaviors into laravel models.
Requires
- php: >=7.1
- illuminate/support: ~5.1
Requires (Dev)
- orchestra/testbench: ~3.8
- phpunit/phpunit: >=8.2.1
- squizlabs/php_codesniffer: ^3.4
This package is auto-updated.
Last update: 2024-10-29 05:34:41 UTC
README
Laravel Stampable
This is a Laravel Package for adding stamp behaviors into laravel models. This package supports Laravel 5.2+
.
List of contents
Install
Via Composer
$ composer require shetabit/stampable
How to use
Configure Migration
In your migration you must add timestamp
field per each stamp.
// In migration, you must add published_at field like the below if you want to use it as a stamp. $table->timestamp('published_at')->nullable();
Configure Model
In your eloquent model add use HasStamps
trait like the below.
<?php namespace App\Models; use Illuminate\Database\Eloquent\Model; use Shetabit\Stampable\Contracts\Stampable; use Shetabit\Stampable\Traits\HasStamps; class Category extends Model implements Stampable { use HasStamps; // }
Define stamps
you can define stamps using protected stamps
attribute the model
<?php namespace App\Models; use Illuminate\Database\Eloquent\Model; use Shetabit\Stampable\Contracts\Stampable; use Shetabit\Stampable\Traits\HasStamps; class Category extends Model implements Stampable { use HasStamps; protected $stamps = [ 'published' => 'published_at', ]; // }
stamps must be in ['stampName' => 'databaseFieldName']
format.
Working with stamps
Model creates methods and local scopes for each stamp dynamically.
According to the latest example, now we have the below methods for each Category
instance.
<?php /** * notice that be have all of this methods and scopes for each stamps. * the name of methods will be similar to the stamp's name. **/ // methods: $category->markAsPublished(); // press published stamp on this category! $category->markAsUnpublished(); // Remove stamp mark from this category. $category->isPublished(); // Determines if this category is published. $category->isnUnpublished(); // Determinces if this category is Unpublished. // scopes: you can use scopes to filter your data using stamp status. Category::published()->get(); // retrieve published datas Category::unpublished()->get(); // retrieve unpublished datas
Change log
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email khanzadimahdi@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.