PHP Class Ingo_Basic_Base, horde

Author: Michael Slusarz ([email protected])

Show file Open project: horde/horde

Public Properties

Property	Type	Description
$output	string
$title	string
$vars	Horde_Variables

Public Methods

Method	Description
__construct ( Horde_Variables $vars )
render ( )
status ( )
url ( array $opts = [] )
validateMbox ( string $name ) : string	Validates an IMAP mailbox provided by user input.

Protected Methods

Method	Description
_addToken ( Horde_Url $url ) : Horde_Url	Add the ingo action token to a URL.
_assertCategory ( integer $type, string $label )	Assert category.
_checkToken ( array $actions ) : string	Check token.
_init ( )

Method Details

__construct() public method

public __construct ( Horde_Variables $vars )
$vars	Horde_Variables

_addToken() protected method

Add the ingo action token to a URL.

protected _addToken ( Horde_Url $url ) : Horde_Url
$url	Horde_Url	URL.
return	Horde_Url	URL with token added (for chainable calls).

_assertCategory() protected method

Assert category.

protected _assertCategory ( integer $type, string $label )
$type	integer	Category type.
$label	string	Category label.

_checkToken() protected method

Check token.

protected _checkToken ( array $actions ) : string
$actions	array	The list of actions that require token checking.
return	string	The verified action ID.

_init() abstract protected method

abstract protected _init ( )

render() public method

public render ( )

status() public method

public status ( )

url() public static method

public static url ( array $opts = [] )
$opts	array

validateMbox() public method

Validates an IMAP mailbox provided by user input.

public validateMbox ( string $name ) : string
$name	string	The form name of the input.
return	string	The IMAP mailbox name.

Property Details

$output public property

public string $output
return	string

$title public property

public string $title
return	string

$vars public property

public Horde_Variables $vars
return	Horde_Variables