b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (CVS HEAD) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Class: ItemList2

Source Location: /blogs/inc/items/model/_itemlist.class.php

Class ItemList2

Class Overview

Item List Class 2

This SECOND implementation will deprecate the first one when finished.

Located in /blogs/inc/items/model/_itemlist.class.php [line 43]

Widget
   |
   --Table
      |
      --Results
         |
         --FilteredResults
            |
            --DataObjectList2
               |
               --ItemListLight
                  |
                  --ItemList2
Author(s):
Information Tags:
Version:  beta

Properties

Methods

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

Inherited From ItemListLight

ItemListLight::$advertised_stop_date
ItemListLight::$Blog
ItemListLight::$getting_adv_start_date
ItemListLight::$getting_adv_stop_date
ItemListLight::$group_by_cat
ItemListLight::$ItemQuery
ItemListLight::$last_displayed_date
ItemListLight::$single_post
ItemListLight::$unit

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 ItemListLight

ItemListLight::ItemListLight()
Constructor
ItemListLight::activate_preset_filters()
Activate preset default filters if necessary
ItemListLight::dates_to_end()
Template function: display potentially remaining empty days until the end of the filter interval
ItemListLight::date_if_changed()
Template tag: Display the date if it has changed since last call
ItemListLight::get_advertised_start_date()
Get the adverstised start date (does not include timestamp_min)
ItemListLight::get_advertised_stop_date()
Get the adverstised stop date (does not include timestamp_max)
ItemListLight::get_category_group()
If the list is sorted by category...
ItemListLight::get_filter_titles()
Generate a title for the current list, depending on its filtering params
ItemListLight::get_item()
If the list is sorted by category...
ItemListLight::get_lastpostdate()
Get datetime of the last post/item
ItemListLight::get_total_num_posts()
Return total number of posts
ItemListLight::load_from_Request()
Init filter params from Request params
ItemListLight::page_links()
Template tag
ItemListLight::query()
Run Query: GET DATA ROWS *** LIGHT ***
ItemListLight::query_init()
ItemListLight::reset()
Reset the query -- EXPERIMENTAL
ItemListLight::restore_filterset()
Load previously saved filterset from session.
ItemListLight::save_filterset()
Save current filterset to session.
ItemListLight::set_default_filters()
Set default filter values we always want to use if not individually specified otherwise:
ItemListLight::set_filters()
Set/Activate filterset
ItemListLight::set_start_date()
Make sure date displaying starts at the beginning of the current filter interval

Inherited From DataObjectList2

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

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()
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_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()
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()
Start a column (data).
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
ItemList2   ItemList2()   Constructor
array   get_all_tags()   Get all tags used in current ItemList
array   get_col_sort_values()   Returns values needed to make sort links for a given column
void   &get_item()   If the list is sorted by category...
void   &get_prevnext_Item()   Skip to previous/next Item
void   next_item_link()   Skip to next
void   preview_from_request()   We want to preview a single post, we are going to fake a lot of things...
void   prevnext_item_links()   Link to previous and next link in collection
void   prev_item_link()   Skip to previous
void   query()   Run Query: GET DATA ROWS *** HEAVY ***

[ Top ]
Properties
array   $prevnext_Item = array() [line 48]

[ Top ]
Methods
Constructor ItemList2  [line 64]

  ItemList2 ItemList2( Blog &$Blog, [mixed $timestamp_min = NULL], [mixed $timestamp_max = NULL], [integer|NULL $limit = 20], [string $cache_name = 'ItemCache'], [string $param_prefix = ''], [string $filterset_name = ''], array 7  )

Constructor

Parameters:
array   7:  restrictions for itemlist (position, contact, firm, ...) key: restriction name, value: ID of the restriction
Blog   &$Blog: 
mixed   $timestamp_min:  Default filter set: Do not show posts before this timestamp, can be 'now'
mixed   $timestamp_max:  Default filter set: Do not show posts after this timestamp, can be 'now'
integer|NULL   $limit:  Limit
string   $cache_name:  name of cache to be used
string   $param_prefix:  prefix to differentiate page/order params when multiple Results appear one same page
string   $filterset_name:  Name to be used when saving the filterset (leave empty to use default for collection)

Information Tags:
Todo:  add param for saved session filter set

[ Top ]
get_all_tags  [line 333]

  array get_all_tags( )

Get all tags used in current ItemList


Information Tags:
Todo:  caching in case of multiple calls

[ Top ]
get_col_sort_values  [line 367]

  array get_col_sort_values( integer $col_idx  )

Returns values needed to make sort links for a given column

Returns an array containing the following values:

  • current_order : 'ASC', 'DESC' or ''
  • order_asc : url needed to order in ascending order
  • order_desc
  • order_toggle : url needed to toggle sort order

Parameters:
integer   $col_idx:  column to sort


Redefinition of:
Results::get_col_sort_values()
Returns values needed to make sort links for a given column

[ Top ]
get_item  [line 302]

  void &get_item( )

If the list is sorted by category...

This is basically just a stub for backward compatibility



Redefinition of:
ItemListLight::get_item()
If the list is sorted by category...

[ Top ]
get_prevnext_Item  [line 508]

  void &get_prevnext_Item( [string $direction = 'next']  )

Skip to previous/next Item

If several items share the same spot (like same issue datetime) then they'll get all skipped at once.

Parameters:
string   $direction:  prev | next (relative to the current sort order)


[ Top ]
next_item_link  [line 479]

  void next_item_link( [ $before = ''], [ $after = ''], [ $text = '$title$ »'], [ $no_item = ''], [ $display = true]  )

Skip to next

Parameters:
   $before: 
   $after: 
   $text: 
   $no_item: 
   $display: 


[ Top ]
preview_from_request  [line 84]

  void preview_from_request( )

We want to preview a single post, we are going to fake a lot of things...



[ Top ]
prevnext_item_links  [line 422]

  void prevnext_item_links( $params  )

Link to previous and next link in collection

Parameters:
   $params: 


[ Top ]
prev_item_link  [line 454]

  void prev_item_link( [ $before = ''], [ $after = ''], [ $text = '« $title$'], [ $no_item = ''], [ $display = true]  )

Skip to previous

Parameters:
   $before: 
   $after: 
   $text: 
   $no_item: 
   $display: 


[ Top ]
query  [line 239]

  void query( )

Run Query: GET DATA ROWS *** HEAVY ***



Redefinition of:
ItemListLight::query()
Run Query: GET DATA ROWS *** LIGHT ***

[ Top ]

Documentation generated on Sat, 06 Mar 2010 04:15:50 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).