README

• Laravel标签管理器软件包
  • 安装
    • Composer
  • 配置
    • 模型和转换器
    • 认证中间件
  • 提供查询功能
    • 查询功能列表
    • 用法
    • 例如
  • 路由

安装

Composer

要将此软件包包含到您的项目中，请运行以下命令。

composer require webpress/tag-manager

配置

模型和转换器

您可以通过修改配置文件 config\tag.php 使用您自己的模型和转换器类。

'models'          => [
    'tag' => App\Entities\Tag::class,
],

'transformers'    => [
    'tag' => App\Transformers\TagTransformer::class,
],

您的 Tag 模型类必须实现 VCComponent\Laravel\Tag\Contracts\TagSchema 和 VCComponent\Laravel\Tag\Contracts\TagManagement。

认证中间件

在配置文件 config\tag.php 中配置认证中间件。

'auth_middleware' => [
        'admin'    => [
            'middleware' => 'jwt.auth',
            'except'     => ['index'],
        ],
        'frontend' => [
            'middleware' => 'jwt.auth',
            'except'     => ['index'],
        ],
],

提供查询功能

查询功能列表

将查询范围仅限于包括已发布的标签。

public function scopeIsPublished($query)

将查询范围限定为按名称列排序标签。

public function scopeSortByName($query, $order = 'asc')

将查询范围限定为按使用时间排序标签。从高到低。

public function scopeMostUsed($query, $tagable_type = null) 

将查询范围限定为按使用时间排序标签。从低到高。

public function scopeLeastUsed($query, $taggable_type = null)

用法

使用特性。

namespace App\Model;

use VCComponent\Laravel\Tag\Traits\TagQueryTrait;

class Tag 
{
    use TagQueryTrait;
    \\
}

扩展 VCComponent\Laravel\Tag\Entities\Tag 实体。

namespace App\Model;

use VCComponent\Laravel\Tag\Entities\Tag as BaseTag;

class Tag extends BaseTag
{
    \\
}

例如

$category = Tag::isPublished()->mostUsed()->get();

路由

API端点应具有以下格式