PHP Class Wicked_Page_StandardPage, horde

Author: Jan Schneider ([email protected])
Author: Tyler Colbert ([email protected])
Inheritance: extends Wicked_Page
Mostra file Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$supportedModes array Display modes supported by this page.

Protected Properties

Property Type Description
$_lock array Lock information if this page is currently locked.
$_locks Horde_Lock A Horde_Locks instance for un-/locking this page.

Public Methods

Method Description
__construct ( string $pagename ) Constructs a standard page class to represent a wiki page.
allows ( integer $mode ) : boolean Returns if the page allows a mode. Access rights and user state are taken into consideration.
changeLog ( )
diff ( string $version ) Renders this page in diff mode.
displayContents ( $isBlock )
getDiff ( string $version, string $renderer = 'unified' ) Produces a diff for this page.
getLockRequestor ( )
getLockTime ( )
getText ( )
history ( ) : string Renders this page in History mode.
hits ( )
isLocked ( $owner = null )
lock ( )
pageID ( )
pageName ( )
unlock ( )
updateText ( $newtext, $changelog )
version ( )
versionCreated ( )

Protected Methods

Method Description
_setViewProperties ( $view, $page )

Method Details

__construct() public method

Constructs a standard page class to represent a wiki page.
public __construct ( string $pagename )
$pagename string The name of the page to represent.

_setViewProperties() protected method

protected _setViewProperties ( $view, $page )

allows() public method

Returns if the page allows a mode. Access rights and user state are taken into consideration.
public allows ( integer $mode ) : boolean
$mode integer The mode to check for.
return boolean True if the mode is allowed.

changeLog() public method

public changeLog ( )

diff() public method

Renders this page in diff mode.
public diff ( string $version )
$version string The version to diff this page against.

displayContents() public method

public displayContents ( $isBlock )

getDiff() public method

Produces a diff for this page.
public getDiff ( string $version, string $renderer = 'unified' )
$version string Previous version, or null if diffing with `before the beginning' (empty).
$renderer string The diff renderer.

getLockRequestor() public method

public getLockRequestor ( )

getLockTime() public method

public getLockTime ( )

getText() public method

public getText ( )

history() public method

Renders this page in History mode.
public history ( ) : string
return string The content.

hits() public method

public hits ( )

isLocked() public method

public isLocked ( $owner = null )

lock() public method

public lock ( )

pageID() public method

public pageID ( )

pageName() public method

public pageName ( )

unlock() public method

public unlock ( )

updateText() public method

public updateText ( $newtext, $changelog )

version() public method

public version ( )

versionCreated() public method

public versionCreated ( )

Property Details

$_lock protected_oe property

Lock information if this page is currently locked.
protected array $_lock
return array

$_locks protected_oe property

A Horde_Locks instance for un-/locking this page.
protected Horde_Lock $_locks
return Horde_Lock

$supportedModes public_oe property

Display modes supported by this page.
public array $supportedModes
return array