icybee/module-comments

Allows users comments to be attached to nodes.

3.0.x-dev 2016-01-23 20:16 UTC

Requires

• php: ^5.5|^7.0
• brickrouge/css-class-names: ^2.0
• icanboogie/module-installer: ^1.2
• icybee/module-nodes: ^3.0

Requires (Dev)

• icybee/core: ^3.0

BSD-3-Clause

• Olivier Laviale

• comment

README

Allows users to attach comments to nodes.

The modules provides a comment submission form with a real time comment preview and all the screens required to manage the comments and configure the module.

Prototype methods

get_comments

The get_comments prototype method returns the approved comments associated with a node.

<?php

$app->models['articles']->one->comments;

get_comments_count

The get_comments_count prototype method returns the number of approved comments associated with a node.

<?php

$app->models['articles']->one->comments_count;

Requirements

This module is designed to work with the CMS Icybee.

Installation

The recommended way to install this package is through Composer:

$ composer require icybee/module-comments

Cloning the repository

The package is available on GitHub, its repository can be cloned with the following command line:

$ git clone git://github.com/module-comments.git comments

Documentation

The documentation for the package and its dependencies can be generated with the make doc command. The documentation is generated in the docs directory using ApiGen. The package directory can later by cleaned with the make clean command.

License

This module is licensed under the New BSD License - See the LICENSE file for details.