API - XOOPS 2.5.11 Beta 2
By monxoops.fr
XoopsComments Class Reference
Inheritance diagram for XoopsComments:
Collaboration diagram for XoopsComments:

Public Member Functions

 __construct ($ctable, $id=null)
 
 load ($id)
 
 store ()
 
 delete ()
 
 getCommentTree ()
 
 getAllComments ($criteria=array(), $asobject=true, $orderby='comment_id ASC', $limit=0, $start=0)
 
 printNavBar ($item_id, $mode='flat', $order=1)
 
 showThreadHead ()
 
 showThreadPost ($order, $mode, $adminview=0, $color_num=1)
 
 showThreadFoot ()
 
 showTreeHead ($width='100%')
 
 showTreeItem ($order, $mode, $color_num)
 
 showTreeFoot ()
 
- Public Member Functions inherited from XoopsObject
 __construct ()
 
 XoopsObject ()
 
 setNew ()
 
 unsetNew ()
 
 isNew ()
 
 setDirty ()
 
 unsetDirty ()
 
 isDirty ()
 
 initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='', $enumerations='')
 
 assignVar ($key, $value)
 
 assignVars ($var_arr)
 
 setVar ($key, $value, $not_gpc=false)
 
 setVars ($var_arr, $not_gpc=false)
 
 destroyVars ($var)
 
 destoryVars ($var)
 
 setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
 
getVars ()
 
 getValues ($keys=null, $format='s', $maxDepth=1)
 
 getVar ($key, $format=null)
 
 cleanVars ()
 
 registerFilter ($filtername)
 
 _loadFilters ()
 
 loadFilters ($method)
 
 xoopsClone ()
 
 __clone ()
 
 setErrors ($err_str)
 
 getErrors ()
 
 getHtmlErrors ()
 
 toArray ()
 

Data Fields

 $ctable
 
 $db
 
- Data Fields inherited from XoopsObject
 $vars = array()
 
 $cleanVars = array()
 
 $_isNew = false
 
 $_isDirty = false
 
 $_errors = array()
 
 $_filters = array()
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $ctable,
  $id = null 
)
Parameters
$ctable
null | array$id
Here is the call graph for this function:

Member Function Documentation

◆ delete()

delete ( )

Enter description here...

Returns
int
Here is the call graph for this function:

◆ getAllComments()

getAllComments (   $criteria = array(),
  $asobject = true,
  $orderby = 'comment_id ASC',
  $limit = 0,
  $start = 0 
)

Get All Comments using criteria match

Parameters
array$criteria
bool$asobject
string$orderby
int$limit
int$start
Returns
array

◆ getCommentTree()

getCommentTree ( )

Get Comments Tree

Returns
mixed
Here is the call graph for this function:

◆ load()

load (   $id)

Load Comment by ID

Parameters
int$id
Here is the call graph for this function:
Here is the caller graph for this function:

◆ printNavBar()

printNavBar (   $item_id,
  $mode = 'flat',
  $order = 1 
)

Enter printNavBar

Parameters
int$item_id
string$mode
int$order

◆ showThreadFoot()

showThreadFoot ( )

Show Thread Footer

Here is the call graph for this function:

◆ showThreadHead()

showThreadHead ( )

Show Thread

Here is the call graph for this function:

◆ showThreadPost()

showThreadPost (   $order,
  $mode,
  $adminview = 0,
  $color_num = 1 
)

Enter description here...

Parameters
string$order
string$mode
int$adminview
int$color_num
Here is the call graph for this function:

◆ showTreeFoot()

showTreeFoot ( )

Show Thread Foot

◆ showTreeHead()

showTreeHead (   $width = '100%')

Show Thread Head

Parameters
int | string$width

◆ showTreeItem()

showTreeItem (   $order,
  $mode,
  $color_num 
)

Show Tree Items

Parameters
string$order
string$mode
int$color_num
Here is the call graph for this function:

◆ store()

store ( )

Save Comment

Returns
int|false
Here is the call graph for this function:

Field Documentation

◆ $ctable

$ctable

◆ $db

$db

The documentation for this class was generated from the following file: