https://github.com/pluf/assort

A pluf module to manage categories and tags. See http://pluf.ir/#!/content/plugin-assort
https://github.com/pluf/assort

pluf

Last synced: about 24 hours ago
JSON representation

A pluf module to manage categories and tags. See http://pluf.ir/#!/content/plugin-assort

• Host: GitHub
• URL: https://github.com/pluf/assort
• Owner: pluf
• License: gpl-3.0
• Created: 2017-06-10T11:28:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-16T17:20:47.000Z (over 4 years ago)
• Last Synced: 2024-04-19T16:09:01.486Z (7 months ago)
• Topics: pluf
• Language: PHP
• Homepage:
• Size: 51.8 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Assortment System

[![Build Status](https://travis-ci.org/pluf/assort.svg?branch=master)](https://travis-ci.org/pluf/assort)

This is a Pluf module to provide related tools to categories and tags. It can be used to manage (add, remove, update, search) categories and tags.

## Entities

This module contains two important entities:

	- Category (Assort_Category)

	- Tag (Assort_Tag)

	

### Category

PHP class of category is named Assort_Category. Category has following properties:

	- 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)

	

Categories should have unique values for pair (name, parent).

 

### Tag

PHP class of tag is named Assort_Tag. Tag has following properties:

	- id (long)

	- name (string)

	- creation_dtime (datetime)

	- modif_dtime (datetime)

	- description (string)

	

Tags should have unique values for name.

## API

This module adds following API:

### Category 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]

	

### Tag 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]

	

## Other features

Following function in this module is defined and could be used:

### Assort_Shortcuts_GetTagByNameOr404($name)

Returns Assort_Tag with given name. Throws an exception (with http code 404) if there is no tag with given name.