phpDocumentor pond
[ class tree: pond ] [ index: pond ] [ all elements ]

Class: DataObjectList2

Source Location: /qp_inc/_core/model/dataobjects/_dataobjectlist2.class.php

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 /qp_inc/_core/model/dataobjects/_dataobjectlist2.class.php [line 142]

Widget
   |
   --Table
      |
      --Results
         |
         --FilteredResults
            |
            --DataObjectList2
Author(s):
API Tags:
Abstract:  

Information Tags:
Version:  beta

Methods

[ Top ]
Descendants
Child Class Description
ItemListLight Item List Class LIGHT

[ 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::$functions_area
Results::$global_idx
Results::$global_is_first
Results::$global_is_last
Results::$group_by
Results::$group_by_obj_prop
Results::$grp_cols
Results::$ID_col
Results::$limit
Results::$nofollow_pagenav
Results::$order_callbacks
Results::$order_field_list
Results::$order_param
Results::$page
Results::$page_ID_array
Results::$page_ID_list
Results::$page_param
Results::$result_num_rows
Results::$rows
Results::$sql
Results::$total_rows

Inherited From Table

Table::$displayed_cols_count
Table::$displayed_lines_count
Table::$fadeout_array
Table::$fadeout_count
Table::$filter_area
Table::$is_fadeout_line
Table::$nb_cols
Table::$no_results_text
Table::$param_prefix
Table::$total_pages

Inherited From Widget

Widget::$global_icons
Widget::$params
Widget::$title

Inherited From FilteredResults

FilteredResults::dump_active_filters()
Show every active filter that is not the same as the defaults
FilteredResults::get_active_filter()
Get a specific active filter
FilteredResults::get_active_filters()
Get every active filter that is not the same as the defaults
FilteredResults::is_filtered()
Check if the Result set is filtered or not

Inherited From Results

Results::Results()
Constructor
Results::callback_group_by_obj_prop()
Callback, to sort Result::$rows according to Result::$group_by_obj_prop.
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_first()
returns the link to the first page, if necessary
Results::display_functions()
Display the functions
Results::display_if_empty()
T-Tag: Display a message if Results 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_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::mergesort()
Merge sort. This is required to not re-order items when sorting for e.g. grouping at the end.
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()
Returns a scrolling page list under the table
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::reset()
Reset the query -- EXPERIMENTAL
Results::restart()
Rewind resultset

Inherited From Table

Table::Table()
Constructor
Table::display_body_end()
Table::display_body_start()
Table::display_colselect()
Display the column selection
Table::display_col_end()
Table::display_col_headers()
Display column headers
Table::display_col_start()
Table::display_filters()
Display the filtering form
Table::display_head()
Display list/table head.
Table::display_init()
Initialize things in order to be ready for displaying.
Table::display_line_end()
Table::display_line_start()
Table::display_list_end()
Display list/table end.
Table::display_list_start()
Display list/table start.
Table::display_option_area()
Display options area
Table::replace_callback()
Widget callback for template vars.

Inherited From Widget

Widget::Widget()
Constructor
Widget::disp_template_raw()
Display a template param without replacing variables
Widget::disp_template_replaced()
Display a template param with its variables replaced
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
void   &get_row_by_idx()   dummy docblock makes error-free autodocs
unknown   move_down()   Move down the element order in database
unknown   move_up()   Move up the element order in database

[ Top ]
Methods
Constructor DataObjectList2  [line 156]

  DataObjectList2 DataObjectList2( DataObjectCache &$Cache, [integer $limit = null], [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 (null for default [20])
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 183]

  void &get_by_idx( $idx  )

Instantiate an object for requested row and cache it:

Parameters:
   $idx: 


[ Top ]
get_filter_title  [line 220]

  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 192]

  void &get_next( )

Get next object in list



[ Top ]
get_row_by_idx  [line 174]

  void &get_row_by_idx( $idx  )

dummy docblock makes error-free autodocs

Parameters:
   $idx: 


[ Top ]
move_down  [line 295]

  unknown move_down( integer $id  )

Move down the element order in database

Parameters:
integer   $id:  id element


[ Top ]
move_up  [line 242]

  unknown move_up( integer $id  )

Move up the element order in database

Parameters:
integer   $id:  id element


[ Top ]