mintbridge/eloquent-favourites

一个优雅的包,用于收藏 eloquent 模型。

0.0.1 2016-02-21 14:19 UTC

This package is not auto-updated.

Last update: 2024-09-14 18:31:38 UTC


README

Laravel 5 包,允许用户收藏 eloquent 模型。

安装

此包可以通过 Composer 安装。

composer require mintbridge/eloquent-favourites

安装后,将服务提供者和外观添加到您的应用程序配置中

// config/app.php

'providers' => [
    '...',
    'Mintbridge\EloquentFavourites\FavouritesServiceProvider',
];

'aliases' => [
    '...',
    'Favourites' => 'Mintbridge\EloquentFavourites\FavouritesFacade',
];

您还需要发布并运行迁移来创建数据库表。

php artisan vendor:publish --provider="Mintbridge\EloquentFavourites\FavouritesServiceProvider" --tag="config"
php artisan vendor:publish --provider="Mintbridge\EloquentFavourites\FavouritesServiceProvider" --tag="migrations"
php artisan migrate

配置将写入 config/eloquent-favourites.php。选项有合理的默认值,但您应将用户模型更改为与您的应用程序中使用的模型匹配。

使用方法

此包将允许您的用户收藏在您的应用程序中使用的模型。为了做到这一点,您希望可收藏的模型必须使用 Favouritable 特性和实现 FavouritableInterface

use Mintbridge\EloquentFavourites\Favouritable;
use Mintbridge\EloquentFavourites\FavouritableInterface;

class Article extends Eloquent implements FavouritableInterface {

    use Favouritable;
    ...
}

然后可以使用 FavouritesManager 或更简单的收藏外观来收藏、取消收藏或切换模型

$article = Article::find(1);

// add article as a favourite
Favourites::add($article);

// remove article from by a favourite
Favourites::remove($article);

// toggle article as being a favourite
Favourites::toggle($article);

贡献

有关详细信息,请参阅 CONTRIBUTING

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件