pluf/assort

A pluf 模块,用于管理分类和标签


README

Build Status

这是一个 Pluf 模块,提供与分类和标签相关的工具。它可以用来管理(添加、删除、更新、搜索)分类和标签。

实体

本模块包含以下两个重要实体

- Category (Assort_Category)
- Tag (Assort_Tag)

分类

分类的 PHP 类名为 Assort_Category。分类具有以下属性

- id (long)
- name (string)
- creation_dtime (datetime)
- modif_dtime (datetime)
- description (string)
- parent (FK from Assort_Category)
- content (FK from CMS_Content)
- thumbnail (FK from CMS_Content)

分类应具有(名称,父级)这对值的唯一性。

标签

标签的 PHP 类名为 Assort_Tag。标签具有以下属性

- id (long)
- name (string)
- creation_dtime (datetime)
- modif_dtime (datetime)
- description (string)

标签应具有名称的唯一性。

API

本模块添加以下 API

分类 API

- GET:  	../category/find	[lists categories]
- PUSH: 	../category/new	[adds new category]
- GET:  	../category/{id}	[gets information of a category]
- PUSH  	../category/{id}	[updates information of a category]
- DELETE	../category/{id}	[deletes a category]

标签 API

- GET:  	../tag/find	[lists tags]
- PUSH: 	../tag/new		[adds new tag]
- GET:  	../tag/{id}	[gets information of a tag]
- PUSH  	../tag/{id}	[updates information of a tag]
- DELETE	../tag/{id}	[deletes a tag]

其他功能

本模块中定义以下函数并可使用

Assort_Shortcuts_GetTagByNameOr404($name)

返回具有给定名称的 Assort_Tag。如果没有给定名称的标签,则抛出异常(带有 HTTP 状态码 404)。