Class Wicked

Wicked Base 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.

Package: Wicked
Author: Tyler Colbert tyler@colberts.us
Located at Wicked.php

Methods summary
`public static Horde_Url`	# `url( string $page, boolean $full = false, integer $append_session = 0 )` Puts together the URL to a Wicked page. Uses mod_rewrite or GET style URLs depending on configuration. Puts together the URL to a Wicked page. Uses mod_rewrite or GET style URLs depending on configuration. Parameters `$page` The name of the page to target. `$full` @see Horde::url() `$append_session` @see Horde::url() Returns `Horde_Url` The URL of $page.
`public static`	# `getMenu( mixed $returnType = 'object' )` Build Wicked's list of menu items. Build Wicked's list of menu items.
`public static`	# `mail( string $message, array $headers = array() )` Mails a notification message after encoding the headers and adding the standard username/time line. Mails a notification message after encoding the headers and adding the standard username/time line. Parameters `$message` The message text to send out. `$headers` Additional headers to add to the email.
`public static string`	# `getCAPTCHA( boolean $new = false )` Generate a CAPTCHA string. Generate a CAPTCHA string. Parameters `$new` <p>If true, a new CAPTCHA is created and returned. The current, to-be-confirmed string otherwise.</p> Returns `string` A CAPTCHA string.
`public static string`	# `lockUser( )` Returns the user name that is used for locking, either the current user or the current IP address. Returns the user name that is used for locking, either the current user or the current IP address. Returns `string` The user name used for locking.

Constants summary
`integer`	`MODE_DISPLAY` Display mode. Display mode.	# `0`
`integer`	`MODE_EDIT` The edit screen. The edit screen.	# `1`
`integer`	`MODE_REMOVE` Page can be removed. Page can be removed.	# `2`
`integer`	`MODE_HISTORY` Display the page history. Display the page history.	# `3`
`integer`	`MODE_DIFF` Diff two versions of the page. Diff two versions of the page.	# `4`
`integer`	`MODE_LOCKING` Page can be locked. Page can be locked.	# `7`
`integer`	`MODE_UNLOCKING` Page can be unlocked. Page can be unlocked.	# `8`
`integer`	`MODE_CREATE` The ability to add a page. The ability to add a page.	# `9`
`integer`	`MODE_CONTENT` Raw content mode. Raw content mode.	# `10`
`integer`	`MODE_BLOCK` Like display, but for a block. Like display, but for a block.	# `11`
`string`	`REGEXP_WIKIWORD` Our wiki word regexp (needed many places). "(!?" . // START WikiPage pattern (1) "[A-Z\xc0-\xde]" . // 1 upper "[A-Za-z0-9\xc0-\xfe]" . // 0+ alpha or digit "[a-z0-9\xdf-\xfe]+" . // 1+ lower or digit "\/?" . // 0/1 slash "[A-Z\xc0-\xde]" . // 1 upper "[A-Za-z0-9\xc0-\xfe\/]" . // 0+ or more alpha or digit or slash ")" . // END WikiPage pattern (/1) "((#" . // START Anchor pattern (2)(3) "[A-Za-z0-9\xc0-\xfe]" . // 1 alpha "(" . // start sub pattern (4) "[-_A-Za-z0-9\xc0-\xfe:.]" . // 0+ dash, alpha, digit, underscore, // colon, dot "[-_A-Za-z0-9\xc0-\xfe]" . // 1 dash, alpha, digit, or underscore ")?)?)"); // end subpatterns (/4)(/3)(/2) Our wiki word regexp (needed many places). "(!?" . // START WikiPage pattern (1) "[A-Z\xc0-\xde]" . // 1 upper "[A-Za-z0-9\xc0-\xfe]" . // 0+ alpha or digit "[a-z0-9\xdf-\xfe]+" . // 1+ lower or digit "\/?" . // 0/1 slash "[A-Z\xc0-\xde]" . // 1 upper "[A-Za-z0-9\xc0-\xfe\/]" . // 0+ or more alpha or digit or slash ")" . // END WikiPage pattern (/1) "((#" . // START Anchor pattern (2)(3) "[A-Za-z0-9\xc0-\xfe]" . // 1 alpha "(" . // start sub pattern (4) "[-_A-Za-z0-9\xc0-\xfe:.]" . // 0+ dash, alpha, digit, underscore, // colon, dot "[-_A-Za-z0-9\xc0-\xfe]" . // 1 dash, alpha, digit, or underscore ")?)?)"); // end subpatterns (/4)(/3)(/2)	# `"(!?[A-Z\xc0-\xde][A-Za-z0-9\xc0-\xfe][a-z0-9\xdf-\xfe]+\/?[A-Z\xc0-\xde][A-Za-z0-9\xc0-\xfe\/])((\#[A-Za-z0-9\xc0-\xfe]([-_A-Za-z0-9\xc0-\xfe:.]*[-_A-Za-z0-9\xc0-\xfe])?)?)"`
`string`	`VFS_ATTACH_PATH` Where we store our attachments in VFS. Where we store our attachments in VFS.	# `'.horde/wicked/attachments'`