PHP Класс Wicked_Page, horde

Автор: Tyler Colbert ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$supportedModes array 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

Защищенные свойства (Protected)

Свойство Тип Описание
$_page array The loaded page info.
$_proc Text_Wiki Instance of a Text_Wiki processor.

Открытые методы

Метод Описание
allows ( integer $mode ) : boolean Returns if the page allows a mode. Access rights and user state are taken into consideration.
author ( )
block ( ) : string Renders this page for displaying in a block.
changeLog ( )
diff ( string $version ) Renders this page in diff mode.
display ( ) Renders this page in display mode.
displayContents ( $isBlock )
formatVersionCreated ( )
getCurrentPage ( ) : Wicked_Page Returns the page we are currently on.
getPage ( $pagename, $pagever = null, $referrer = null ) : Wicked_Page Returns the requested page.
getPermissions ( $pageName = null ) : integer Retrieve this user's permissions for this page. If a permissions object does not exist, we assume reasonable defaults.
getProcessor ( $output_format = 'Xhtml' )
getText ( )
handleAction ( )
history ( ) Renders this page in history mode.
hits ( )
isLocked ( )
isOld ( )
isValid ( ) : boolean Is this a validly loaded page?
lock ( )
pageName ( )
pageTitle ( )
pageUrl ( $linkpage = null, $actionId = null )
preDisplay ( $mode, $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).
previousVersion ( ) : string Returns the previous version number for this page.
referrer ( )
remove ( ) Renders this page in remove mode.
render ( $mode, $params = null )
supports ( integer $mode ) : boolean See if the page supports a particular mode.
toView ( ) : object Returns an object with Horde_View properties.
unlock ( )
updateText ( $newtext, $changelog )
version ( )
versionCreated ( )

Защищенные методы

Метод Описание
_getLinkConf ( boolean $full = false ) : array Returns a link configuration for Text_Wiki.

Описание методов

_getLinkConf() защищенный Метод

Returns a link configuration for Text_Wiki.
protected _getLinkConf ( boolean $full = false ) : array
$full boolean @see Wicked::url()
Результат array A link configuration for Wiklink and Freelink rules.

allows() публичный Метод

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.
Результат boolean True if the mode is allowed.

author() публичный Метод

public author ( )

block() публичный Метод

This must be overridden if the page is to be anything like a real page.
public block ( ) : string
Результат string The content.

changeLog() публичный Метод

public changeLog ( )

diff() публичный Метод

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

display() публичный Метод

This must be overridden if the page is to be anything like a real page.
public display ( )

displayContents() публичный Метод

public displayContents ( $isBlock )

formatVersionCreated() публичный Метод

getCurrentPage() публичный статический Метод

Returns the page we are currently on.
public static getCurrentPage ( ) : Wicked_Page
Результат Wicked_Page The current page.

getPage() публичный статический Метод

Returns the requested page.
public static getPage ( $pagename, $pagever = null, $referrer = null ) : Wicked_Page
Результат Wicked_Page The requested page.

getPermissions() публичный Метод

Retrieve this user's permissions for this page. If a permissions object does not exist, we assume reasonable defaults.
public getPermissions ( $pageName = null ) : integer
Результат integer The permissions bitmask.

getProcessor() публичный Метод

public getProcessor ( $output_format = 'Xhtml' )

getText() публичный Метод

public getText ( )

handleAction() публичный Метод

public handleAction ( )

history() публичный Метод

Renders this page in history mode.
public history ( )

hits() публичный Метод

public hits ( )

isLocked() публичный Метод

public isLocked ( )

isOld() публичный Метод

public isOld ( )

isValid() публичный Метод

Is this a validly loaded page?
public isValid ( ) : boolean
Результат boolean True if we've loaded data, false otherwise.

lock() публичный Метод

public lock ( )

pageName() публичный Метод

public pageName ( )

pageTitle() публичный Метод

public pageTitle ( )

pageUrl() публичный Метод

public pageUrl ( $linkpage = null, $actionId = null )

preDisplay() публичный Метод

$param integer $mode The page render mode. $param array $params Any page parameters.
public preDisplay ( $mode, $params )

previousVersion() публичный Метод

Returns the previous version number for this page.
public previousVersion ( ) : string
Результат string A string containing the previous version or null if this is the first version.

referrer() публичный Метод

public referrer ( )

remove() публичный Метод

Renders this page in remove mode.
public remove ( )

render() публичный Метод

public render ( $mode, $params = null )

supports() публичный Метод

See if the page supports a particular mode.
public supports ( integer $mode ) : boolean
$mode integer Which mode to check for
Результат boolean True or false

toView() публичный Метод

The returned object is supposed to be used with the _page.html.php partial.
public toView ( ) : object
Результат object A simple object.

unlock() публичный Метод

public unlock ( )

updateText() публичный Метод

public updateText ( $newtext, $changelog )

version() публичный Метод

public version ( )

versionCreated() публичный Метод

public versionCreated ( )

Описание свойств

$_page защищенное свойство

The loaded page info.
protected array $_page
Результат array

$_proc защищенное свойство

Instance of a Text_Wiki processor.
protected Text_Wiki $_proc
Результат Text_Wiki

$supportedModes публичное свойство

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
public array $supportedModes
Результат array