Phenotype API Documentation

Class PhenotypeNavigationHelperStandard

Description
Description | Descendents | Methods (details)

Located in /class/PhenotypeNavigationHelper.class.php (line 25)

Direct descendents
Description | Descendents | Methods (details)
Class Description
PhenotypeNavigationHelper
Method Summary
Description | Descendents | Methods (details)
PhenotypeNavigationHelperStandard __construct ()
void __destruct ()
Array getPagesWithinPath (int $pag_id)
int getParentPage (int $pag_id)
Array getSubPages (int $pag_id, [boolean $status = true], [ $grp_id = 0])
Array getTree (int $pag_id_top, [Array $_expand = array()], [int $maxdepth = 999], [ $grp_id = 0])
void insertPagesAfter ( $_currentpages,  $_newpages)
void insertPagesBefore ( $_currentpages,  $_newpages)
Methods
Description | Descendents | Methods (details)
Constructor __construct (line 38)
  • access: public
PhenotypeNavigationHelperStandard __construct ()
Destructor __destruct (line 43)
  • access: public
void __destruct ()
getPagesWithinPath (line 109)

shows the path from the given page to the top of the tree

gets recursively all parent pages of a given page until the top node

  • return: contains ids of all pages from top to the given page. element 0 is the top page.
  • access: public
Array getPagesWithinPath (int $pag_id)
  • int $pag_id: id of the page to find the path for
getParentPage (line 135)

gets the parent of a given page

  • return: id of the parent page. 0 if there is no parent
  • access: public
int getParentPage (int $pag_id)
  • int $pag_id: id of the page to find the parent for
getSubPages (line 60)

finds all direct subPages of a page

  • return: contains ids of all child pages ordered by pag_pos
  • access: public
Array getSubPages (int $pag_id, [boolean $status = true], [ $grp_id = 0])
  • int $pag_id: id of the page of which the subpages should be found
  • boolean $status: defines if all pages are shown or only those with status online
  • $grp_id
getTree (line 161)

finds recursively all pages below a given page

  • return: flat array. keys are the pag_ids of the pages, associated values show the level of the page
  • access: public
Array getTree (int $pag_id_top, [Array $_expand = array()], [int $maxdepth = 999], [ $grp_id = 0])
  • int $pag_id_top: pag_id of start node for the tree
  • Array $_expand: :TODO: what is this?
  • int $maxdepth: maximum depths of the tree, recursion stops at this level
  • $grp_id
insertPagesAfter (line 224)
  • access: public
void insertPagesAfter ( $_currentpages,  $_newpages)
  • $_currentpages
  • $_newpages
insertPagesBefore (line 210)
  • access: public
void insertPagesBefore ( $_currentpages,  $_newpages)
  • $_currentpages
  • $_newpages

Documentation generated on Fri, 17 Jul 2009 16:43:22 +0200 by phpDocumentor 1.4.2

Bookmark and Share