PHP Class Wicked, horde

Author: Tyler Colbert ([email protected])
Show file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
addFeedLink ( )
getCAPTCHA ( boolean $new = false ) : string Generate a CAPTCHA string.
lockUser ( ) : string Returns the user name that is used for locking, either the current user or the current IP address.
mail ( string $message, array $headers = [] ) Mails a notification message after encoding the headers and adding the standard username/time line.
setTopbar ( ) Sets the topbar up.
url ( string $page, boolean $full = false, integer $append_session ) : Horde_Url Puts together the URL to a Wicked page. Uses mod_rewrite or GET style URLs depending on configuration.

Method Details

getCAPTCHA() public static method

Generate a CAPTCHA string.
public static getCAPTCHA ( boolean $new = false ) : string
$new boolean If true, a new CAPTCHA is created and returned. The current, to-be-confirmed string otherwise.
return string A CAPTCHA string.

lockUser() public static method

Returns the user name that is used for locking, either the current user or the current IP address.
public static lockUser ( ) : string
return string The user name used for locking.

mail() public static method

Mails a notification message after encoding the headers and adding the standard username/time line.
public static mail ( string $message, array $headers = [] )
$message string The message text to send out.
$headers array Additional headers to add to the email.

setTopbar() public static method

Sets the topbar up.
public static setTopbar ( )

url() public static method

Puts together the URL to a Wicked page. Uses mod_rewrite or GET style URLs depending on configuration.
public static url ( string $page, boolean $full = false, integer $append_session ) : Horde_Url
$page string The name of the page to target.
$full boolean @see Horde::url()
$append_session integer @see Horde::url()
return Horde_Url The URL of $page.