Class Module_search

Description

Located in /site/pages/modules/search.php (line 16)


	
			
Method Summary
tempcode form ()
?array get_entry_points ()
?array get_page_links ([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])
?array info ()
void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
tempcode my ()
array results (ID_TEXT $id, string $author, ?AUTO_LINK $author_id, integer $days, ID_TEXT $sort, ID_TEXT $direction, boolean $only_titles, ID_TEXT $search_under)
tempcode run ()
void uninstall ()
tempcode _delete ()
Methods
form (line 232)

The UI to do a search.

  • return: The UI
tempcode form ()
get_entry_points (line 78)

Standard modular entry-point finder function.

  • return: A map of entry points (type-code=>language-code) (NULL: disabled).
?array get_entry_points ()
get_page_links (line 92)

Standard modular page-link finder function (does not return the main entry-points that are not inside the tree).

  • return: A tuple: 1) full tree structure [made up of (pagelink, permission-module, permissions-id, title, children, ?entry point for the children, ?children permission module, ?whether there are children) OR a list of maps from a get_* function] 2) permissions-page 3) optional base entry-point for the tree 4) optional permission-module 5) optional permissions-id (NULL: disabled).
?array get_page_links ([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])
  • ?integer $max_depth: The number of tree levels to computer (NULL: no limit)
  • boolean $require_permission_support: Whether to not return stuff that does not support permissions (unless it is underneath something that does).
  • ?string $start_at: Position to start at in the tree. Does not need to be respected. (NULL: from root)
  • boolean $dont_care_about_categories: Whether to avoid returning categories.
info (line 24)

Standard modular info function.

  • return: Map of module info (NULL: module is disabled).
?array info ()
install (line 52)

Standard modular install function.

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
  • ?integer $upgrade_from: What version we're upgrading from (NULL: new install)
  • ?integer $upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)
my (line 165)

The UI to choose a saved search.

  • return: The UI
tempcode my ()
results (line 358)

The actualiser of a search.

  • return: A pair: The results, results browser
array results (ID_TEXT $id, string $author, ?AUTO_LINK $author_id, integer $days, ID_TEXT $sort, ID_TEXT $direction, boolean $only_titles, ID_TEXT $search_under)
  • ID_TEXT $id: Codename for what's being searched (blank: mixed search)
  • string $author: Author name
  • ?AUTO_LINK $author_id: Author ID (NULL: none given)
  • integer $days: Days to search
  • ID_TEXT $sort: Sort key
  • ID_TEXT $direction: Sort direction
  • boolean $only_titles: Whether to only search titles
  • ID_TEXT $search_under: Category to search under
run (line 146)

Standard modular run function.

  • return: The result of execution.
tempcode run ()
uninstall (line 40)

Standard modular uninstall function.

void uninstall ()
_delete (line 215)

The actualiser to delete a saved search.

  • return: The UI
tempcode _delete ()

Documentation generated on Thu, 07 Aug 2008 14:09:29 +0100 by phpDocumentor 1.4.1