Class CommentsService

Summary

File
Package hierarchy Content\Comments
Class hierarchy \CommentsService

package
Content
subpackage
Comments
copyright
© 2005-2020 PHPBoost
license
https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
author
Kevin MASSY reidlos@phpboost.com
version
PHPBoost 6.0 - last update: 2020 05 24
since
PHPBoost 3.0 - 2011 03 31
contributor
Julien BRISWALTER j1.seth@phpboost.com
contributor
Arnaud GENET elenwii@phpboost.com

This class allows you to use a comments system

Methods

__static()

__static()

static

Inherited from \CommentsService

Tags

None found

display()

display(\CommentsTopic $topic) : \Template

This function display the comments

Parameters

\CommentsTopic

$topic

Returns

\Template —

is a template object

static

Inherited from \CommentsService

Tags

None found

get_number_and_lang_comments()

get_number_and_lang_comments(string $module_id, integer $id_in_module, string $topic_identifier = \CommentsTopic::DEFAULT_TOPIC_IDENTIFIER) : string

Returns number comments and lang (example : Comments (comments_number)

Parameters

string	$module_id	the module identifier
integer	$id_in_module	id in module used in comments system
string	$topic_identifier	topic identifier (use if you have several comments system)

Returns

string —

number comments (example : Comments (comments_number)

static

Inherited from \CommentsService

Tags

None found

get_lang_comments()

get_lang_comments(string $module_id, integer $id_in_module = '', string $topic_identifier = \CommentsTopic::DEFAULT_TOPIC_IDENTIFIER) : string

Returns lang (example : "Comments" for several comments, "comment" for one comment and "No comment" if no comment

Parameters

string	$module_id	the module identifier
integer	$id_in_module	id in module used in comments system
string	$topic_identifier	topic identifier (use if you have several comments system)

Returns

string

static

Inherited from \CommentsService

Tags

None found

delete_comments_module()

delete_comments_module(string $module_id)

Delete all comments module

Parameters

string

$module_id

the module identifier

static

Inherited from \CommentsService

Tags

None found

delete_comments_topic_module()

delete_comments_topic_module(string $module_id, integer $id_in_module)

Delete comments topic according to module identifier and id in module

Parameters

string	$module_id	the module identifier
integer	$id_in_module	id in module used in comments system

static

Inherited from \CommentsService

Tags

None found

get_comments_number()

get_comments_number(string $module_id, integer $id_in_module = '', string $topic_identifier = \CommentsTopic::DEFAULT_TOPIC_IDENTIFIER) : string

Returns number comments

Parameters

string	$module_id	the module identifier
integer	$id_in_module	id in module used in comments system
string	$topic_identifier	topic identifier (use if you have several comments system)

Returns

string —

number comments

static

Inherited from \CommentsService

Tags

None found

display_comments()

display_comments(string $module_id, integer $id_in_module, string $topic_identifier, string $comments_number_to_display, array $authorizations, boolean $display_from_comments_number = false) : object

Do not use, this is used for ajax display comments

Parameters

string	$module_id	the module identifier
integer	$id_in_module	id in module used in comments system
string	$topic_identifier	topic identifier (use if you have several comments system)
string	$comments_number_to_display	number of comments to display the first time
array	$authorizations	comments topic authorizations
boolean	$display_from_comments_number	true if need to display from the number of comments to display (used in ajax to show all comments of an element)

Returns

object —

View is a view

static

Inherited from \CommentsService

Tags

None found

verify_authorized_edit_or_delete_comment()

verify_authorized_edit_or_delete_comment( $authorizations,  $comment_id)

Parameters

	$authorizations
	$comment_id

static

Inherited from \CommentsService

Tags

None found

is_authorized_edit_or_delete_comment()

is_authorized_edit_or_delete_comment( $authorizations,  $comment_id)

Parameters

	$authorizations
	$comment_id

static

Inherited from \CommentsService

Tags

None found

Properties

$user

$user :

Tags

None found

$lang

$lang :

Tags

None found

$common_lang

$common_lang :

Tags

None found

$comments_lang

$comments_lang :

Tags

None found

$comments_cache

$comments_cache :

Tags

None found

$template

$template :

Tags

None found

$display_delete_button

$display_delete_button :

Tags

None found