Docs For Class ArchiveList

Class Overview

Archive List Class

Located in /blogs/plugins/_archives.plugin.php [line 284]

Widget
   |
   --Results
      |
      --ArchiveList

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
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 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 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 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 ]

Property Summary

mixed	$archive_mode
mixed	$arc_w_last

[ Top ]

Method Summary

ArchiveList	ArchiveList()	Constructor
void	count_total_rows()	Count the number of rows of the SQL result
void	get_item()	Getting next item in archive list
void	restart()	Rewind resultset

[ Top ]

Properties

mixed $archive_mode [line 286]

[ Top ]

mixed $arc_w_last [line 287]

[ Top ]

Methods

Constructor ArchiveList [line 305]

ArchiveList ArchiveList(
[string
$archive_mode = 'monthly'], [integer
$limit = 100], [boolean
$preserve_context = false], [
$dbtable = 'T_posts'], [
$dbprefix = 'post_'], [
$dbIDname = 'ID'] 
)

Constructor

Note: Weekly archives use MySQL's week numbering and MySQL default if applicable. In MySQL < 4.0.14, WEEK() always uses mode 0: Week starts on Sunday; Value range is 0 to 53; week 1 is the first week that starts in this year.

Parameters:

string	$archive_mode:
integer	$limit:
boolean	$preserve_context:
	$dbtable:
	$dbprefix:
	$dbIDname:

Information Tags:

Link:	http://dev.mysql.com/doc/mysql/en/date-and-time-functions.html
Todo:	categories combined with 'ALL' are not supported (will output too many archives, some of which will resolve to no results). We need subqueries to support this efficiently.

[ Top ]

count_total_rows [line 442]

void count_total_rows(
)

Count the number of rows of the SQL result

These queries are complex enough for us not to have to rewrite them:

Redefinition of:

Results::count_total_rows(): Count the total number of rows of the SQL result (all pages)

[ Top ]

get_item [line 505]

void get_item(

&$arc_year, 
&$arc_month, 
&$arc_dayofmonth, 
&$arc_w, 
&$arc_count, 
&$post_ID, 
&$post_title 
)

Getting next item in archive list

WARNING: these are *NOT* Item objects!

Parameters:

	&$arc_year:
	&$arc_month:
	&$arc_dayofmonth:
	&$arc_w:
	&$arc_count:
	&$post_ID:
	&$post_title:

[ Top ]

restart [line 491]

void restart(
)

Rewind resultset

Redefinition of:

Results::restart(): Rewind resultset

[ Top ]

Multilingual multiuser multiblog engine

Class: ArchiveList

Class ArchiveList

Packages

Classes

Files