Référence de la classe XoopsCommentHandler

Graphe d'héritage de XoopsCommentHandler:

Graphe de collaboration de XoopsCommentHandler:

Fonctions membres publiques
	create ($isNew=true)
	get ($id)
	insert (XoopsObject $comment)
	delete (XoopsObject $comment)
	getObjects (CriteriaElement $criteria=null, $id_as_key=false)
	getCount (CriteriaElement $criteria=null)
	deleteAll (CriteriaElement $criteria=null)
	getList (CriteriaElement $criteria=null)
	getByItemId ($module_id, $item_id, $order=null, $status=null, $limit=null, $start=0)
	getCountByItemId ($module_id, $item_id, $status=null)
	getTopComments ($module_id, $item_id, $order, $status=null)
	getThread ($comment_rootid, $comment_id, $status=null)
	updateByField (XoopsComment $comment, $field_name, $field_value)
	deleteByModule ($module_id)
Fonctions membres publiques hérités de XoopsObjectHandler
	__construct (XoopsDatabase $db)
	XoopsObjectHandler ($db)
	create ()

Membres hérités additionnels
Champs de données hérités de XoopsObjectHandler
	$db

Documentation des fonctions membres

create()

create

(

$isNew = true

)

Create a XoopsComment

Paramètres

bool

$isNew

Flag the object as "new"?

Renvoie

XoopsComment

delete()

delete

(

XoopsObject

$comment

)

Delete a XoopsComment from the database

Paramètres

XoopsObject | XoopsComment

$comment

a XoopsComment object

Renvoie

bool true on success, otherwise false

Réimplémentée à partir de XoopsObjectHandler.

deleteAll()

deleteAll

(

CriteriaElement

$criteria = null

)

Delete multiple comments

Paramètres

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement

Renvoie

bool

Voici le graphe des appelants de cette fonction :

deleteByModule()

deleteByModule

(

$module_id

)

Delete all comments for one whole module

Paramètres

int

$module_id

ID of the module

Renvoie

bool

Voici le graphe d'appel pour cette fonction :

get()

get

(

$id

)

Retrieve a XoopsComment

Paramètres

int

$id

ID

Renvoie

XoopsComment XoopsComment, FALSE on fail

Réimplémentée à partir de XoopsObjectHandler.

getByItemId()

getByItemId	(		$module_id,
			$item_id,
			$order = null,
			$status = null,
			$limit = null,
			$start = 0
	)

Retrieves comments for an item

Paramètres

int	$module_id	Module ID
int	$item_id	Item ID
string	$order	Sort order
int	$status	Status of the comment
int	$limit	Max num of comments to retrieve
int	$start	Start offset

Renvoie

array Array of XoopsComment objects

Voici le graphe d'appel pour cette fonction :

getCount()

getCount

(

CriteriaElement

$criteria = null

)

Count Comments

Paramètres

CriteriaElement | CriteriaCompo

$criteria

CriteriaElement

Renvoie

int Count

Voici le graphe des appelants de cette fonction :

getCountByItemId()

getCountByItemId	(		$module_id,
			$item_id,
			$status = null
	)

Gets total number of comments for an item

Paramètres

int	$module_id	Module ID
int	$item_id	Item ID
int	$status	Status of the comment

Renvoie

array Array of XoopsComment objects

Voici le graphe d'appel pour cette fonction :

getList()

getList

(

CriteriaElement

$criteria = null

)

Get a list of comments

Paramètres

CriteriaElement

$criteria

CriteriaElement

Renvoie

array Array of raw database records

Voici le graphe d'appel pour cette fonction :

getObjects()

getObjects	(	CriteriaElement	$criteria = null,
			$id_as_key = false
	)

Get some XoopsComments

Paramètres

CriteriaElement | CriteriaCompo	$criteria
bool	$id_as_key	Use IDs as keys into the array?

Renvoie

array Array of XoopsComment objects

Voici le graphe des appelants de cette fonction :

getThread()

getThread	(		$comment_rootid,
			$comment_id,
			$status = null
	)

Retrieve a whole thread

Paramètres

int	$comment_rootid
int	$comment_id
int	$status

Renvoie

array Array of XoopsComment objects

Voici le graphe d'appel pour cette fonction :

getTopComments()

getTopComments	(		$module_id,
			$item_id,
			$order,
			$status = null
	)

Get the top XoopsComments

Paramètres

int	$module_id
int	$item_id
string	$order
int	$status

Renvoie

array Array of XoopsComment objects

Voici le graphe d'appel pour cette fonction :

insert()

insert

(

XoopsObject

$comment

)

Write a comment to database

Paramètres

XoopsObject | XoopsComment

$comment

a XoopsComment object

Renvoie

bool true on success, otherwise false

Réimplémentée à partir de XoopsObjectHandler.

Voici le graphe des appelants de cette fonction :

updateByField()

updateByField	(	XoopsComment	$comment,
			$field_name,
			$field_value
	)

Update

Paramètres

XoopsComment	$comment	XoopsComment object
string	$field_name	Name of the field
mixed	$field_value	Value to write

Renvoie

bool

Voici le graphe d'appel pour cette fonction :

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/kernel/comment.php