Overview

Packages

  • None
  • Wicked

Classes

  • Text_Wiki_Parse_Heading2
  • Text_Wiki_Parse_Toc2
  • Text_Wiki_Render_Latex_Heading2
  • Text_Wiki_Render_Latex_Toc2
  • Text_Wiki_Render_Plain_Heading2
  • Text_Wiki_Render_Plain_Toc2
  • Text_Wiki_Render_Rst
  • Text_Wiki_Render_Rst_Blockquote
  • Text_Wiki_Render_Rst_Bold
  • Text_Wiki_Render_Rst_Code
  • Text_Wiki_Render_Rst_Deflist
  • Text_Wiki_Render_Rst_Emphasis
  • Text_Wiki_Render_Rst_Freelink
  • Text_Wiki_Render_Rst_Heading2
  • Text_Wiki_Render_Rst_Links
  • Text_Wiki_Render_Rst_List
  • Text_Wiki_Render_Rst_Newline
  • Text_Wiki_Render_Rst_Paragraph
  • Text_Wiki_Render_Rst_Raw
  • Text_Wiki_Render_Rst_Toc2
  • Text_Wiki_Render_Rst_Tt
  • Text_Wiki_Render_Rst_Url
  • Text_Wiki_Render_Xhtml_Attribute
  • Text_Wiki_Render_Xhtml_Code2
  • Text_Wiki_Render_Xhtml_Freelink2
  • Text_Wiki_Render_Xhtml_Heading2
  • Text_Wiki_Render_Xhtml_Image2
  • Text_Wiki_Render_Xhtml_Interwiki
  • Text_Wiki_Render_Xhtml_Registrylink
  • Text_Wiki_Render_Xhtml_Toc2
  • Text_Wiki_Render_Xhtml_Url
  • Text_Wiki_Render_Xhtml_Wickedblock
  • Text_Wiki_Render_Xhtml_Wikilink2
  • Wicked
  • Wicked_Api
  • Wicked_Driver
  • Wicked_Driver_Sql
  • Wicked_Exception
  • Wicked_Factory_Driver
  • Wicked_Page
  • Wicked_Page_AddPage
  • Wicked_Page_AllPages
  • Wicked_Page_AttachedFiles
  • Wicked_Page_BackLinks
  • Wicked_Page_DeletePage
  • Wicked_Page_EditPage
  • Wicked_Page_LeastPopular
  • Wicked_Page_LikePages
  • Wicked_Page_MergeOrRename
  • Wicked_Page_MostPopular
  • Wicked_Page_NewPage
  • Wicked_Page_RecentChanges
  • Wicked_Page_RevertPage
  • Wicked_Page_Search
  • Wicked_Page_StandardHistoryPage
  • Wicked_Page_StandardPage
  • Wicked_Page_SyncDiff
  • Wicked_Page_SyncPages
  • Wicked_Sync
  • Wicked_Sync_Wicked
  • Wicked_Test
  • Overview
  • Package
  • Class
  • Tree

Class Wicked_Page

Wicked Abtract Page Class.

Copyright 2003-2012 Horde LLC (http://www.horde.org/)

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

Direct known subclasses

Wicked_Page_AddPage, Wicked_Page_AllPages, Wicked_Page_NewPage, Wicked_Page_RecentChanges, Wicked_Page_RevertPage, Wicked_Page_Search, Wicked_Page_StandardPage, Wicked_Page_SyncPages, Wicked_Page_AttachedFiles, Wicked_Page_BackLinks, Wicked_Page_DeletePage, Wicked_Page_EditPage, Wicked_Page_LeastPopular, Wicked_Page_LikePages, Wicked_Page_MergeOrRename, Wicked_Page_MostPopular

Indirect known subclasses

Wicked_Page_StandardHistoryPage, Wicked_Page_SyncDiff
Package: Wicked
Author: Tyler Colbert tyler@colberts.us
Located at Page.php
Methods summary
public boolean
# isValid( )

Is this a validly loaded page?

Is this a validly loaded page?

Returns

boolean
True if we've loaded data, false otherwise.
public integer
# getPermissions( mixed $pageName = null )

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

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

Returns

integer
The permissions bitmask.
public boolean
# allows( integer $mode )

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

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

Parameters

$mode
The mode to check for.

Returns

boolean
True if the mode is allowed.

See

mixed
public boolean
# supports( integer $mode )

See if the page supports a particular mode.

See if the page supports a particular mode.

Parameters

$mode
Which mode to check for

Returns

boolean
True or false

See

mixed
public Wicked_Page
# getCurrentPage( )

Returns the page we are currently on.

Returns the page we are currently on.

Returns

Wicked_Page
The current page.

Throws

Wicked_Exception
public static Wicked_Page
# getPage( mixed $pagename, mixed $pagever = null, mixed $referrer = null )

Returns the requested page.

Returns the requested page.

Returns

Wicked_Page
The requested page.

Throws

Wicked_Exception
public
# versionCreated( )
public
# formatVersionCreated( )
public
# author( )
public
# hits( )
public
# version( )
public string
# previousVersion( )

Returns the previous version number for this page.

Returns the previous version number for this page.

Returns

string

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

Throws

Wicked_Exception
public
# isOld( )
public
# display( )

Renders this page in display mode.

Renders this page in display mode.

This must be overridden if the page is to be anything like a real page.

Throws

Wicked_Exception
public
# preDisplay( mixed $mode, mixed $params )

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).

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.

public string
# block( )

Renders this page for displaying in a block.

Renders this page for displaying in a block.

This must be overridden if the page is to be anything like a real page.

Returns

string
The content.

Throws

Wicked_Exception
public
# displayContents( mixed $isBlock )
public
# remove( )

Renders this page in remove mode.

Renders this page in remove mode.

public
# history( )

Renders this page in history mode.

Renders this page in history mode.

public
# diff( )

Renders this page in diff mode.

Renders this page in diff mode.

public &
# getProcessor( mixed $output_format = 'Xhtml' )
public
# render( mixed $mode, mixed $params = null )
public
# isLocked( )
public
# lock( )
public
# unlock( )
public
# updateText( mixed $newtext, mixed $changelog )
public
# getText( )
public
# pageName( )
public
# referrer( )
public
# pageUrl( mixed $linkpage = null, mixed $actionId = null )
public
# pageTitle( )
public
# handleAction( )
Constants summary
integer MATCH_LEFT
# 1
integer MATCH_RIGHT
# 2
integer MATCH_ENDS
# 3
integer MATCH_ANY
# 4
Properties summary
public array $supportedModes

Display modes supported by this page. Possible modes:

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

# array()
API documentation generated by ApiGen