Docs For Class ItemList

Class Overview

Item List Class

Located in /blogs/b2evocore/_class_itemlist.php [line 41]

DataObjectList
   |
   --ItemList

Author(s):

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
	Inherited From DataObjectList DataObjectList::DataObjectList() Constructor DataObjectList::display_if_empty() Template function: display message if list is empty DataObjectList::get_next() Get next comment in list DataObjectList::get_num_rows() Get nummber of rows available for display DataObjectList::restart() Rewind resultset

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObjectList

DataObjectList::DataObjectList()

Constructor

DataObjectList::display_if_empty()

Template function: display message if list is empty

DataObjectList::get_next()

Get next comment in list

DataObjectList::get_num_rows()

Get nummber of rows available for display

DataObjectList::restart()

Rewind resultset

[ Top ]

Property Summary

mixed	$blog
mixed	$group_by_cat
mixed	$limitdate_end
mixed	$limitdate_start
mixed	$main_cat
mixed	$max_paged
mixed	$p
mixed	$postIDarray
mixed	$postIDlist
mixed	$preview
mixed	$previous_main_cat
mixed	$result_num_rows
mixed	$row
mixed	$row_num
mixed	$total_num_posts
mixed	$what_to_show

[ Top ]

Method Summary

ItemList	ItemList()	Constructor
void	calc_max()
void	date_if_changed()	Template function: Display the date if it has changed since last call
true	display_if_empty()	Template function: display message if list is empty
void	get_category_group()
void	get_item()
void	get_max_paged()
void	get_postdata()
void	get_total_num_posts()
void	mod_date()	Template function: display last mod date (datetime) of Item
void	preview_request()
void	restart()

[ Top ]

Properties

mixed $blog [line 44]

[ Top ]

mixed $group_by_cat [line 54]

[ Top ]

mixed $limitdate_end [line 57]

[ Top ]

mixed $limitdate_start [line 56]

[ Top ]

mixed $main_cat [line 62]

[ Top ]

mixed $max_paged [line 52]

[ Top ]

mixed $p [line 45]

[ Top ]

mixed $postIDarray [line 49]

[ Top ]

mixed $postIDlist [line 48]

[ Top ]

mixed $preview [line 43]

[ Top ]

mixed $previous_main_cat [line 63]

[ Top ]

mixed $result_num_rows [line 47]

[ Top ]

mixed $row [line 61]

[ Top ]

mixed $row_num [line 60]

[ Top ]

mixed $total_num_posts [line 51]

[ Top ]

mixed $what_to_show [line 46]

[ Top ]

Methods

Constructor ItemList [line 107]

ItemList ItemList(
[integer
$blog = 1], [array
$show_statuses = array()], [mixed
$p = ''], [mixed
$m = ''], [mixed
$w = -1], [mixed
$cat = ''], [array
$catsel = array()], [mixed
$author = ''], [string
$order = ''], [string
$orderby = ''], [mixed
$posts = ''], [mixed
$paged = ''], [mixed
$poststart = ''], [mixed
$postend = ''], [string
$s = ''], [mixed
$sentence = ''], [mixed
$exact = ''], [boolean
$preview = 0], [mixed
$default_posts_per_page = ''], [mixed
$init_what_to_show = ''], [mixed
$timestamp_min = ''], [mixed
$timestamp_max = 'now'], [string
$title = ''] 
)

Constructor

Parameters:

integer	$blog:	Blog ID
array	$show_statuses:	show_statuses
mixed	$p:	Specific post number to display
mixed	$m:	YearMonth(Day) to display
mixed	$w:	Week number. Note: uses mySQL's week numbering and mySQL default if applicable. In mySQL < 4.0, WEEK() uses mode 0: Week starts on Sunday; Value range is 0 to 53; week 1 is the first week that starts in this year
mixed	$cat:	List of cats to restrict to
array	$catsel:	Array of cats to restrict to
mixed	$author:	List of authors to restrict to
string	$order:	sort order can be either ASC or DESC
string	$orderby:	space separated list of fields to order by. Possible list elements are: author issue_date mod_date status locale content title urltitle url ctageory wordcount comments
mixed	$posts:	# of posts to display on the page
mixed	$paged:	List page number in paged display
mixed	$poststart:	Start results at this position
mixed	$postend:	End results at this position
string	$s:	Search string
mixed	$sentence:	Search for sentence or for words
mixed	$exact:	Require exact match of title or contents
boolean	$preview:	Is this preview
mixed	$default_posts_per_page:
mixed	$init_what_to_show:
mixed	$timestamp_min:	Do not show posts before this timestamp, can be 'now'
mixed	$timestamp_max:	Do not show posts after this timestamp, can be 'now'
string	$title:	urltitle of post to display

[ Top ]

calc_max [line 704]

void calc_max(
)

[ Top ]

date_if_changed [line 855]

void date_if_changed(
[string
$before = '<h2>'], [string
$after = '</h2>'], [string
$format = ''] 
)

Template function: Display the date if it has changed since last call

Parameters:

string	$before:	string to display before the date (if changed)
string	$after:	string to display after the date (if changed)
string	$format:	date/time format: leave empty to use locale default time format

[ Top ]

display_if_empty [line 885]

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:

DataObjectList::display_if_empty(): Template function: display message if list is empty

[ Top ]

get_category_group [line 722]

void get_category_group(
)

[ Top ]

get_item [line 756]

void get_item(
)

[ Top ]

get_max_paged [line 649]

void get_max_paged(
)

[ Top ]

get_postdata [line 787]

void get_postdata(
)

Init postdata

[ Top ]

get_total_num_posts [line 691]

void get_total_num_posts(
)

[ Top ]

mod_date [line 668]

void mod_date(
[string
$format = ''], [boolean
$useGM = false] 
)

Template function: display last mod date (datetime) of Item

Parameters:

string	$format:	date/time format: leave empty to use locale default date format
boolean	$useGM:	true if you want GMT

[ Top ]

preview_request [line 562]

void preview_request(
)

[ Top ]

restart [line 633]

void restart(
)

Redefinition of:

DataObjectList::restart(): Rewind resultset

[ Top ]

Multilingual multiuser multiblog engine

Class: ItemList

Class ItemList

Packages

Classes

Files