Class XoopsCommentHandler

XOOPS comment handler class.

This class is responsible for providing data access mechanisms to the data source of XOOPS comment class objects.

XoopsCommentHandler

Package: kernel\comment
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at ernel/comment.php

Methods summary
`public XoopsComment`	# `create( boolean $isNew = true )` Create a `XoopsComment` Create a `XoopsComment` Parameters `$isNew` Flag the object as "new"? Returns `XoopsComment` Overrides `XoopsObjectHandler::create()`
`public XoopsComment`	# `get( integer $id )` Retrieve a `XoopsComment` Retrieve a `XoopsComment` Parameters `$id` ID Returns `XoopsComment` `XoopsComment`, FALSE on fail Overrides `XoopsObjectHandler::get()`
`public boolean`	# `insert( XoopsObject $comment )` Write a comment to database Write a comment to database Parameters `$comment` a XoopsComment object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::insert()`
`public boolean`	# `delete( XoopsObject $comment )` Delete a `XoopsComment` from the database Delete a `XoopsComment` from the database Parameters `$comment` a XoopsComment object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::delete()`
`public array`	# `getObjects( CriteriaElement $criteria = null, boolean $id_as_key = false )` Get some `XoopsComment`s Get some `XoopsComment`s Parameters `$criteria` `$id_as_key` Use IDs as keys into the array? Returns array Array of `XoopsComment` objects
`public integer`	# `getCount( CriteriaElement $criteria = null )` Count Comments Count Comments Parameters `$criteria` `CriteriaElement` Returns integer Count
`public boolean`	# `deleteAll( CriteriaElement $criteria = null )` Delete multiple comments Delete multiple comments Parameters `$criteria` `CriteriaElement` Returns boolean
`public array`	# `getList( CriteriaElement $criteria = null )` Get a list of comments Get a list of comments Parameters `$criteria` `CriteriaElement` Returns array Array of raw database records
`public array`	# `getByItemId( integer $module_id, integer $item_id, string $order = null, integer $status = null, integer $limit = null, integer $start = 0 )` Retrieves comments for an item Retrieves comments for an item Parameters `$module_id` Module ID `$item_id` Item ID `$order` Sort order `$status` Status of the comment `$limit` Max num of comments to retrieve `$start` Start offset Returns array Array of `XoopsComment` objects
`public array`	# `getCountByItemId( integer $module_id, integer $item_id, integer $status = null )` Gets total number of comments for an item Gets total number of comments for an item Parameters `$module_id` Module ID `$item_id` Item ID `$status` Status of the comment Returns array Array of `XoopsComment` objects
`public array`	# `getTopComments( integer $module_id, integer $item_id, string $order, integer $status = null )` Get the top `XoopsComment`s Get the top `XoopsComment`s Parameters `$module_id` `$item_id` `$order` `$status` Returns array Array of `XoopsComment` objects
`public array`	# `getThread( integer $comment_rootid, integer $comment_id, integer $status = null )` Retrieve a whole thread Retrieve a whole thread Parameters `$comment_rootid` `$comment_id` `$status` Returns array Array of `XoopsComment` objects
`public boolean`	# `updateByField( XoopsComment $comment, string $field_name, mixed $field_value )` Update Update Parameters `$comment` `XoopsComment` object `$field_name` Name of the field `$field_value` Value to write Returns boolean
`public boolean`	# `deleteByModule( integer $module_id )` Delete all comments for one whole module Delete all comments for one whole module Parameters `$module_id` ID of the module Returns boolean

Methods inherited from XoopsObjectHandler
`XoopsObjectHandler(), __construct()`

Properties inherited from XoopsObjectHandler
`$db`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsCommentHandler

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns