Docs For Class DataObjectList2

Class Overview

Data Object List Base Class 2

This is typically an abstract class, useful only when derived. Holds DataObjects in an array and allows walking through...

This SECOND implementation will deprecate the first one when finished.

Located in /blogs/inc/MODEL/dataobjects/_dataobjectlist2.class.php [line 81]

Widget
   |
   --Results
      |
      --FilteredResults
         |
         --DataObjectList2

Author(s):

API Tags:

Abstract:

Information Tags:

Version:

beta

Methods

[ Top ]

Direct descendents

Child Class	Description
ItemList2	Item List Class 2

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From FilteredResults FilteredResults::$default_filters FilteredResults::$filters 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_callbacks 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 FilteredResults FilteredResults::is_filtered() Check if the Result set is filtered or not 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_colselect() Display the column selection 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_option_area() Display options area 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::order_callback_wrapper_objects() Wrapper method to http://www.php.net/usort, which instantiates objects and passed them on to the order callback. Results::order_callback_wrapper_rows() Wrapper method to http://www.php.net/usort, which passes the rows to the order callback. 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.

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From FilteredResults

FilteredResults::$default_filters

FilteredResults::$filters

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_callbacks

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 FilteredResults

FilteredResults::is_filtered()

Check if the Result set is filtered or not

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_colselect()

Display the column selection

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_option_area()

Display options area

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::order_callback_wrapper_objects()

Wrapper method to http://www.php.net/usort, which instantiates objects and passed them on to the order callback.

Results::order_callback_wrapper_rows()

Wrapper method to http://www.php.net/usort, which passes the rows to the order callback.

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 ]

Method Summary

DataObjectList2	DataObjectList2()	Constructor
void	&get_by_idx()	Instantiate an object for requested row and cache it:
void	get_filter_title()	Display a global title matching filter params
void	&get_next()	Get next object in list
unknown	move_down()	Move down the element order in database
unknown	move_up()	Move up the element order in database

[ Top ]

Properties

Methods

Constructor DataObjectList2 [line 95]

DataObjectList2 DataObjectList2(
DataObjectCache
&$Cache, [integer
$limit = 20], [string
$param_prefix = ''], [string
$default_order = NULL] 
)

Constructor

If provided, executes SQL query via parent Results object

Parameters:

DataObjectCache	&$Cache:
integer	$limit:	number of lines displayed on one screen
string	$param_prefix:	prefix to differentiate page/order params when multiple Results appear one same page
string	$default_order:	default ordering of columns (special syntax)

[ Top ]

get_by_idx [line 113]

void &get_by_idx(

$idx 
)

Instantiate an object for requested row and cache it:

Parameters:

$idx:

[ Top ]

get_filter_title [line 152]

void get_filter_title(
[string
$prefix = ' '], [string
$suffix = ''], [string
$glue = ' - '], [string
$order = NULL], [string
$format = 'htmlbody'] 
)

Display a global title matching filter params

Parameters:

string	$prefix:	prefix to display if a title is generated
string	$suffix:	suffix to display if a title is generated
string	$glue:	glue to use if multiple title elements are generated
string	$order:	comma separated list of titles inthe order we would like to display them
string	$format:	format to output, default 'htmlbody'

Information Tags:

Todo:

implement $order

[ Top ]

get_next [line 122]

void &get_next(
)

Get next object in list

[ Top ]

move_down [line 227]

unknown move_down(
integer
$id 
)

Move down the element order in database

Parameters:

integer

$id:

id element

[ Top ]

move_up [line 174]

unknown move_up(
integer
$id 
)

Move up the element order in database

Parameters:

integer

$id:

id element

[ Top ]

Multilingual multiuser multiblog engine

Class: DataObjectList2

Class DataObjectList2

Packages

Classes

Files