b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (Version 1.8) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Class: CommentList

Source Location: /blogs/inc/MODEL/comments/_commentlist.class.php

Class CommentList

Class Overview

CommentList Class

Located in /blogs/inc/MODEL/comments/_commentlist.class.php [line 39]

Widget
   |
   --Results
      |
      --DataObjectList
         |
         --CommentList
Author(s):
Information Tags:
Version:  beta

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From DataObjectList

DataObjectList::$dbIDname
DataObjectList::$dbprefix
DataObjectList::$dbtablename
DataObjectList::$Obj
DataObjectList::$objType

Inherited From Results

Results::$Cache
Results::$cols
Results::$col_headers
Results::$current_group_ID
Results::$current_idx
Results::$current_Obj
Results::$DB
Results::$filter_area
Results::$functions_area
Results::$global_idx
Results::$global_is_first
Results::$global_is_last
Results::$group_by
Results::$grp_cols
Results::$ID_col
Results::$limit
Results::$nb_cols
Results::$order_field_list
Results::$order_param
Results::$page
Results::$page_ID_array
Results::$page_ID_list
Results::$page_param
Results::$params
Results::$param_prefix
Results::$result_num_rows
Results::$rows
Results::$sql
Results::$total_pages
Results::$total_rows

Inherited From Widget

Widget::$global_icons
Widget::$title

Inherited From DataObjectList

DataObjectList::DataObjectList()
Constructor
DataObjectList::get_next()
Get next object in list

Inherited From Results

Results::Results()
Constructor
Results::count_total_rows()
Count the total number of rows of the SQL result (all pages)
Results::display()
Display paged list/table based on object parameters
Results::display_body()
Display list/table body.
Results::display_filters()
Display the filtering form
Results::display_first()
returns the link to the first page, if necessary
Results::display_functions()
Display the functions
Results::display_head()
Display list/table head.
Results::display_if_empty()
Template function: display message if list is empty
Results::display_init()
Initialize things in order to be ready for displaying.
Results::display_last()
returns the link to the last page, if necessary
Results::display_list_end()
Display list/table end.
Results::display_list_start()
Display list/table start.
Results::display_nav()
Display navigation text, based on template.
Results::display_next()
returns a link to next pages, if necessary
Results::display_prev()
returns a link to previous pages, if necessary
Results::display_totals()
Display totals line if set.
Results::first()
Returns the first page number to be displayed in the list
Results::get_col_sort_values()
Returns values needed to make sort links for a given column
Results::get_num_rows()
Get number of rows available for display
Results::get_order_field_list()
Returns order field list add to SQL query:
Results::get_page_ID_array()
Get an array of IDs for current page
Results::get_page_ID_list()
Get a list of IDs for current page
Results::instantiate_page_to_Cache()
Note: this function might actually not be very useful.
Results::last()
returns the last page number to be displayed in the list
Results::move_icons()
Results::next_idx()
Increment and update all necessary counters before processing a new line in result set
Results::page_list()
Returns the page link list under the table
Results::page_scroll_list()
Results::parse_col_content()
Handle variable subtitutions for column contents.
Results::query()
Run the query now!
Results::replace_callback()
Widget callback for template vars.
Results::restart()
Rewind resultset

Inherited From Widget

Widget::gen_global_icons()
Generate img tags for registered icons, through global_icon().
Widget::global_icon()
Registers a global action icon
Widget::replace_callback()
Callback function used to replace only necessary values in template.
Widget::replace_callback_wrapper()
This is an additional wrapper to replace_vars() that allows to react on the return value of it.
Widget::replace_vars()
Replaces $vars$ with appropriate values.

[ Top ]
Property Summary
mixed   $blog  

[ Top ]
Method Summary
CommentList   CommentList()   Constructor
true   display_if_empty()   Template function: display message if list is empty

[ Top ]
Methods
Constructor CommentList  [line 46]

  CommentList CommentList( [ $blog = 1], [ $comment_types = "'comment'"], [ $show_statuses = array( 'published' )], [ $p = ''], [ $author = ''], [ $order = 'DESC'], [ $orderby = ''], [ $limit = '']  )

Constructor

Parameters:
   $blog: 
   $comment_types: 
   $show_statuses: 
   $p: 
   $author: 
   $order: 
   $orderby: 
   $limit: 


[ Top ]
display_if_empty  [line 159]

  true display_if_empty( [string $message = '']  )

Template function: display message if list is empty

Parameters:
string   $message:  String to display if list is empty

API Tags:
Return:  if empty


Redefinition of:
Results::display_if_empty()
Template function: display message if list is empty

[ Top ]

Documentation generated on Tue, 18 Dec 2007 23:11:39 +0100 by phpDocumentor 1.4.0