Docs For Class Page

Page

Description

Wicked Abtract Page Class.

$Horde: wicked/lib/Page.php,v 1.106.2.5 2010/02/14 18:16:31 jan Exp $

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

author: Tyler Colbert <tyler@colberts.us>

Located in /lib/Page.php (line 15)

Direct descendents

Class	Description
Search	Wicked SearchAll class.
StandardPage	Wicked Page class for most pages.
AddPage	Wicked AddPage class.
AllPages	Wicked AllPages class.
AttachedFiles	Wicked AttachedFiles class.
BackLinks	Wicked BackLinks class.
DeletePage	Wicked DeletePage class (for confirming deletion).
EditPage	Wicked EditPage class.
LeastPopular	Wicked LeastPopular class.
LikePages	Wicked LikePages class.
MostPopular	Wicked MostPopular class.
NewPage	Wicked NewPage class.
RecentChanges	Wicked RecentChanges class.
RevertPage	Wicked RevertPage class (for confirming reversions).
SyncPages	Wicked SyncPages class.
MergeOrRename	Special page for merging or renaming pages.

Variable Summary

array $supportedModes

array $_page

Text_Wiki $_proc

Method Summary

boolean allows (integer $mode)

void author ()

mixed block ()

mixed diff ()

mixed display ()

void displayContents ( $isBlock)

void formatVersionCreated ()

Returns getCurrentPage ()

mixed getPage ( $pagename, [ $pagever = null], [ $referrer = null])

integer getPermissions ([ $pageName = null])

void &getProcessor ([ $output_format = 'Xhtml'])

void getText ()

void handleAction ()

mixed history ()

void hits ()

void isLocked ()

void isOld ()

boolean isValid ()

void lock ()

void pageName ()

void pageTitle ()

void pageUrl ([ $linkpage = null], [ $actionId = null])

void preDisplay ( $mode, $params)

mixed previousVersion ()

void referrer ()

mixed remove ()

void render ( $mode, [ $params = null])

boolean supports (integer $mode)

void unlock ()

void updateText ( $newtext, $changelog, $minorchange)

void version ()

void versionCreated ()

Variables

array $supportedModes = array() (line 32)

Display modes supported by this page. Possible modes:

WICKED_MODE_CONTENT WICKED_MODE_DISPLAY WICKED_MODE_EDIT WICKED_MODE_REMOVE WICKED_MODE_HISTORY WICKED_MODE_DIFF WICKED_MODE_LOCKING WICKED_MODE_UNLOCKING WICKED_MODE_CREATE

Redefined in descendants as:

Search::$supportedModes : Display modes supported by this page.
StandardPage::$supportedModes : Display modes supported by this page.
StdHistoryPage::$supportedModes : Display modes supported by this page.
AddPage::$supportedModes : Display modes supported by this page.
AllPages::$supportedModes : Display modes supported by this page.
AttachedFiles::$supportedModes : Display modes supported by this page.
BackLinks::$supportedModes : Display modes supported by this page.
DeletePage::$supportedModes : Display modes supported by this page.
EditPage::$supportedModes : Display modes supported by this page.
LeastPopular::$supportedModes : Display modes supported by this page.
LikePages::$supportedModes : Display modes supported by this page.
MostPopular::$supportedModes : Display modes supported by this page.
NewPage::$supportedModes : Display modes supported by this page.
RecentChanges::$supportedModes : Display modes supported by this page.
RevertPage::$supportedModes : Display modes supported by this page.
SyncPages::$supportedModes : Display modes supported by this page.
SyncDiff::$supportedModes : Display modes supported by this page.
MergeOrRename::$supportedModes : Display modes supported by this page.

array $_page (line 46)

The loaded page info.

Text_Wiki $_proc (line 39)

Instance of a Text_Wiki processor.

Methods

allows (line 98)

Returns if the page allows a mode. Access rights and user state are taken into consideration.

return: True if the mode is allowed.
see: Page::$supportedModes

boolean allows (integer $mode)

integer $mode: The mode to check for.

Redefined in descendants as:

StandardPage::allows() : Returns if the page allows a mode. Access rights and user state are taken into consideration.
EditPage::allows() : Returns if the page allows a mode. Access rights and user state are taken into consideration.
MergeOrRename::allows() : Returns if the page allows a mode. Access rights and user state are taken into consideration.

author (line 251)

void author ()

block (line 368)

Render this page for displaying in a block. You really must override this function if your page is to be anything like a real page.

return: Returns true or PEAR_Error.

mixed block ()

diff (line 403)

Render this page in Diff mode.

return: Returns true or PEAR_Error.

mixed diff ()

Redefined in descendants as:

StandardPage::diff()

display (line 338)

Render this page in Display mode. You really must override this function if your page is to be anything like a real page.

return: Returns true or PEAR_Error.

mixed display ()

Redefined in descendants as:

Search::display() : Render this page in Display mode.
AddPage::display() : Render this page in Display mode.
AttachedFiles::display() : Returns this page rendered in Display mode.
DeletePage::display() : Render this page in Display mode.
EditPage::display() : Render this page in Display mode.
NewPage::display() : Render this page in Display mode.
RevertPage::display() : Render this page in Display mode.
MergeOrRename::display() : Render this page in Display mode.

displayContents (line 373)

void displayContents ( $isBlock)

$isBlock

Redefined in descendants as:

StandardPage::displayContents()
AllPages::displayContents() : Render this page in display or block mode.
BackLinks::displayContents() : Render this page in display or block mode.
LeastPopular::displayContents() : Render this page in display or block mode.
LikePages::displayContents() : Render this page in display or block mode.
MostPopular::displayContents() : Render this page in Display mode.
RecentChanges::displayContents() : Render this page in display or block mode.
SyncPages::displayContents() : Render this page in display or block mode.
SyncDiff::displayContents() : Render this page in display or block mode.

formatVersionCreated (line 240)

void formatVersionCreated ()

getCurrentPage (line 186)

Get the page we are currently on.

return: a Page or PEAR_Error.

Returns getCurrentPage ()

getPage (line 198)

Get the page we are currently on.

return: Returns a Page or PEAR_Error.

mixed getPage ( $pagename, [ $pagever = null], [ $referrer = null])

$pagename
$pagever
$referrer

getPermissions (line 65)

Retrieve this user's permissions for this page. If a permissions object does not exist, we assume reasonable defaults.

return: The permissions bitmask.

integer getPermissions ([ $pageName = null])

$pageName

Redefined in descendants as:

AttachedFiles::getPermissions() : Returns the current user's permissions for the referring page.
DeletePage::getPermissions() : Retrieve this user's permissions for the referring page.
EditPage::getPermissions() : Retrieve this user's permissions for the referring page.
NewPage::getPermissions() : Retrieve this user's permissions for the referring page.
RevertPage::getPermissions() : Retrieve this user's permissions for the referring page.
MergeOrRename::getPermissions() : Retrieve this user's permissions for the referring page.

getProcessor (line 408)

void &getProcessor ([ $output_format = 'Xhtml'])

$output_format

getText (line 535)

void getText ()

Redefined in descendants as:

StandardPage::getText()

handleAction (line 575)

void handleAction ()

Redefined in descendants as:

AttachedFiles::handleAction() : Retrieves the form fields and processes the attachment.
DeletePage::handleAction()
EditPage::handleAction()
NewPage::handleAction()
RevertPage::handleAction()
MergeOrRename::handleAction() : Retrieve the form fields and process the merge or rename.

history (line 393)

Render this page in History mode.

return: Returns true or PEAR_Error.

mixed history ()

Redefined in descendants as:

StandardPage::history() : Renders this page in History mode.

hits (line 269)

void hits ()

Redefined in descendants as:

StandardPage::hits()

isLocked (line 515)

void isLocked ()

Redefined in descendants as:

isOld (line 327)

void isOld ()

Redefined in descendants as:

StdHistoryPage::isOld()

isValid (line 53)

Is this a validly loaded page?

return: True if we've loaded data, false otherwise.

boolean isValid ()

lock (line 520)

void lock ()

Redefined in descendants as:

StandardPage::lock()

pageName (line 540)

void pageName ()

Redefined in descendants as:

pageTitle (line 570)

void pageTitle ()

Redefined in descendants as:

pageUrl (line 550)

void pageUrl ([ $linkpage = null], [ $actionId = null])

$linkpage
$actionId

Redefined in descendants as:

StdHistoryPage::pageUrl()

preDisplay (line 358)

Perform any pre-display checks for permissions, searches,

etc. Called before any output is sent so the page can do redirects. If the page wants to take control of flow from here, it can, and is entirely responsible for handling the user (should call exit after redirecting, for example).

$param integer $mode The page render mode. $param array $params Any page parameters.

void preDisplay ( $mode, $params)

$mode
$params

Redefined in descendants as:

Search::preDisplay() : Perform any pre-display checks for permissions, searches,
AddPage::preDisplay() : Bail out if there's no page name.
DeletePage::preDisplay() : Send them back whence they came if they aren't allowed to delete this page.
EditPage::preDisplay() : Send them back whence they came if they aren't allowed to edit this page.
NewPage::preDisplay() : Send them back whence they came if they aren't allowed to edit this page.
RevertPage::preDisplay() : Send them back whence they came if they aren't allowed to edit this page.

previousVersion (line 285)

Retrieve the previous version number for this page

return: A string containing the previous version or null if this is the first version.

mixed previousVersion ()

referrer (line 545)

void referrer ()

Redefined in descendants as:

remove (line 383)

Render this page in Remove mode.

return: Returns true or PEAR_Error.

mixed remove ()

render (line 489)

void render ( $mode, [ $params = null])

$mode
$params

supports (line 176)

See if the page supports a particular mode.

return: True or false
see: Page::$supportedModes

boolean supports (integer $mode)

integer $mode: Which mode to check for

unlock (line 525)

void unlock ()

Redefined in descendants as:

StandardPage::unlock()

updateText (line 530)

void updateText ( $newtext, $changelog, $minorchange)

$newtext
$changelog
$minorchange

Redefined in descendants as:

StandardPage::updateText()

version (line 274)

void version ()

Redefined in descendants as:

StandardPage::version()

versionCreated (line 235)

void versionCreated ()

Redefined in descendants as:

StandardPage::versionCreated()

Documentation generated on Sun, 30 Jan 2011 05:42:56 +0000 by phpDocumentor 1.4.3