Class icms_data_comment_Handler

Comment handler class.

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

icms_data_comment_Handler

Package: Data\Comment
Category: ICMS
Copyright:

License: GNU General Public License (GPL)
Author: Kazumi Ono onokazu@xoops.org
Located at data/comment/Handler.php

Methods summary
`public object &`	# `create( boolean $isNew = true )` Create a `icms_data_comment_Object` Create a `icms_data_comment_Object` Parameters `$isNew` Flag the object as "new"? Returns object See icms_core_ObjectHandler#create()
`public object &`	# `get( integer $id )` Retrieve a `icms_data_comment_Object` Retrieve a `icms_data_comment_Object` Parameters `$id` ID Returns object `icms_data_comment_Object`, FALSE on fail See htdocs/kernel/icms_core_ObjectHandler#get($int_id)
`public boolean`	# `insert( object & $comment )` Insert a comment to database Insert a comment to database Parameters `$comment` $comment Returns boolean See icms_core_ObjectHandler#insert($object)
`public boolean`	# `delete( object & $comment )` Delete a `icms_data_comment_Object` from the database Delete a `icms_data_comment_Object` from the database Parameters `$comment` $comment Returns boolean See icms_core_ObjectHandler#delete($object)
`public array`	# `getObjects( object $criteria = null, boolean $id_as_key = false )` Get some `icms_data_comment_Object`s Get some `icms_data_comment_Object`s Parameters `$criteria` `$id_as_key` Use IDs as keys into the array? Returns array Array of `icms_data_comment_Object` objects
`public integer`	# `getCount( object $criteria = null )` Count Comments Count Comments Parameters `$criteria` `icms_db_criteria_Element` Returns integer Count
`public boolean`	# `deleteAll( object $criteria = null )` Delete multiple comments Delete multiple comments Parameters `$criteria` `icms_db_criteria_Element` Returns boolean
`public array`	# `getList( object $criteria = null )` Get a list of comments Get a list of comments Parameters `$criteria` `icms_db_criteria_Element` 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 `icms_data_comment_Object` 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 `icms_data_comment_Object` objects
`public array`	# `getTopComments( integer $module_id, integer $item_id, strint $order, integer $status = null )` Get the top `icms_data_comment_Object`s Get the top `icms_data_comment_Object`s Parameters `$module_id` `$item_id` `$order` `$status` Returns array Array of `icms_data_comment_Object` 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 `icms_data_comment_Object` objects
`public boolean`	# `updateByField( object & $comment, string $field_name, mixed $field_value )` Update Update Parameters `$comment` $comment `icms_data_comment_Object` 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 icms_core_ObjectHandler
`__construct()`

Properties inherited from icms_core_ObjectHandler
`$db`

Packages

Classes

Class icms_data_comment_Handler

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns