Class Page

Description

A Page object defines everything that is a Page on the website

Located in /core/page.class.inc (line 19)


	
			
Variable Summary
Method Summary
Page Page (Context $_context)
void attachments ()
void Execute ()
void InitFromDatabase (mixed $_parentPageID, mixed $_name)
bool InitFromDatabaseByID (int $_pageID)
bool InitPageParts ()
void loadFromDBRow (mixed $row)
void SaveToDatabase ()
void subPages ()
string URL ([mixed $asFolder = true])
Variables
Context $context (line 54)
  • var: the current context
  • access: public
string $displayname (line 29)
  • var: the human readable title
  • access: public
string $GUID (line 37)
  • var: the Page ID for this page
  • access: public
string $name (line 25)
  • var: the URL name (ie the filename)
  • access: public
array $pageParts (line 50)
  • var: array of PagePart objects that belong to this page.
  • access: public
int $parentPageID (line 63)
  • var: the PageGUID of the parent page
  • access: public
pipelineBase $pipeline (line 41)
  • var: the pipeline object associated with this page
  • access: public
string $pipeline_name (line 45)
  • var: the name of the pipeline associated with this page
  • access: public
int $sortordinal (line 33)
  • var: the sort position of this item
  • access: public
string $templateName (line 58)
  • var: the name of the current template
  • access: public
Methods
Constructor Page (line 79)

creates a new Page object

  • access: public
Page Page (Context $_context)
  • Context $_context: The current context object
attachments (line 408)
  • access: public
void attachments ()
Execute (line 273)

Executes (ie displays) the current Page

  • access: public
void Execute ()
InitFromDatabase (line 98)
  • access: public
void InitFromDatabase (mixed $_parentPageID, mixed $_name)
InitFromDatabaseByID (line 136)

Initializes this page from the database based on the page's GUID

  • return: returns TRUE if initialized successfully, FALSE if not
  • access: public
bool InitFromDatabaseByID (int $_pageID)
  • int $_pageID: the unique identifier for the page to load
InitPageParts (line 189)

Loads up the PageParts associated with this page.

  • return: returns TRUE if all PageParts loaded successfully, FALSE for any errors.
  • access: public
bool InitPageParts ()
loadFromDBRow (line 163)
  • access: public
void loadFromDBRow (mixed $row)
parentPage (line 257)

gets the parent page of this current page.

  • return: returns the parent page, or NULL if none exists.
  • access: public
Page parentPage ()
SaveToDatabase (line 291)

Saves the current Page's data to the database by either inserting it, or updating it

note: the Page's GUID must be set and valid

  • access: public
void SaveToDatabase ()
subPages (line 354)

Returns an array of Page objects that are children to the current Page

  • access: public
void subPages ()
URL (line 224)

gets the URL for this page

  • return: the URL for this page
  • access: public
string URL ([mixed $asFolder = true])

Documentation generated on Tue, 4 Oct 2005 21:59:21 -0700 by phpDocumentor 1.3.0RC3