Core Boxx - Comments Module

INTRODUCTION

This is a simple comments module for Core Boxx – Add comments to a post, video, image, product, or whatever you want.

LICENSE & DOWNLOAD

Core Boxx is released under the MIT License. You are free to use it for personal and commercial projects, and modify it as you see fit. On the condition that the software is provided “as-is”. There are no warranties provided and “no strings attached”. Code Boxx and the authors are not liable for any claims, damages, or liabilities.

Download Core Boxx Comments Module | GitHub | Source Forge

INSTALLATION & REQUIREMENTS

The user module must be installed.
Import lib/SQL-Comments.sql into your database.

FILES LIST

lib/LIB-Comments.php The comments library.
lib/API-comments.php Comments API endpoint.
pages/PAGE-comment.php Comments demo page.
assets/PAGE-comment.js Comments demo page Javascript.

DEVELOPMENT NOTES

This module assumes that comments are only open for registered users.
If you want to open up for the public, some form of identification needs still need to be in place – Use a random cookie session ID as the “user ID”.
Also, you decide if users can update and delete their own comments.

COMMENTS REFERENCE

COMMENTS TABLE

Field	Description
`comment_id`	Primary key, auto-increment.
`user_id`	The user that made the comment.
`id`	The ID of whatever you want to attach comments to – Post, product, image, video, etc…
`timestamp`	The time when the comment is posted.
`message`	The comment itself.

COMMENTS LIBRARY FUNCTIONS

save($id, $message, $cid)

Save a comment.

$id The post/product/video/image ID.
$message Comment message itself.
$cid Comment ID – If left blank, will add a new entry, if not, update this entry.

echo $_CORE->Comments->save(999, "Testing")
 ? "OK" : $_CORE->error;

del($cid)

Deletes the specified comment ID.

echo $_CORE->Comments->del(999)
 ? "OK" : $_CORE->error}

get($cid)

Get comment with the specified ID.

$comment = $_CORE->Comments->get(999);

getAll($id)

Get all comments for the specified ID.

$comments = $_CORE->Comments->getAll(999);

COMMENTS API FUNCTIONS

Accessible at http://yoursite.com/api/comments/REQUEST/. These are pretty much a replica of the above library functions, except in REST API format. Feel free to delete api/API-comments.php if you don’t intend to integrate an API.

Core Boxx – Comments Module