Class midcom_helper_itemlist

Description

Itemlist Interface

You have to override the get_sorted_list member, it has to return an array sorted by the constraints you establish.

  • todo: complete documentation

Located in /midcom/helper/itemlist.php (line 21)


	
			
Direct descendents
Class Description
 class midcom_helper_itemlist_topicsfirst Itemlist Subclass: Topics, then articles in component sorting order
 class midcom_helper_itemlist_score Itemlist Interface
 class midcom_helper_itemlist_articlesfirst Itemlist Subclass: Topics, then articles in component sorting order
Variable Summary
Method Summary
 Array get_sorted_list ()
 void _init (midcom_helper_nav &$basicnav, MidgardTopic &$parent_topic)
Variables
mixed $parent_node_id = NULL (line 51)
midcom_helper_nav $_basicnav = null (line 29)

A reference to the NAP instance we belong to.

  • access: protected
Array $_standard_midgard_sortparams = array (
"alpha" => "Sort alphabetically",
"reverse alpha" => "Reverse of alpha",
"name" => "Sort by name (alphabetically",
"reverse name" => "Sort by reverse name",
"score" => "Sort by score",
"reverse score" => "Reverse score",
"created" => "Sort by createddate",
"reverse created" => "Reverse createddate",
"revised" => "Sort by date revised",
"reverse revised" => "reverse date revised"
)
(line 38)

A list of standard Midgard sorting orders.

  • access: protected
  • todo: This has yet to be translated using the l10n service
Methods
get_sorted_list (line 73)

Returns the sorted list for this topic according to our sorting criteria.

It has to be overriden. Call generate_error on any critical failure.

  • return: An array of all objects.
Array get_sorted_list ()

Redefined in descendants as:
_init (line 59)

Initialize the object, used by the factory function.

  • access: private
void _init (midcom_helper_nav &$basicnav, MidgardTopic &$parent_topic)
  • midcom_helper_nav $basicnav: A reference to a NAP object to use.
  • MidgardTopic $parent_topic: A reference to the topic in which we operate.

Documentation generated on Mon, 21 Nov 2005 18:17:38 +0100 by phpDocumentor 1.3.0RC3