Ingo_Basic_Rule
extends Ingo_Basic_Base
in package
Rule page.
Tags
Table of Contents
- INGO_TOKEN = 'ingo_token'
- $output : string
- $title : string
- $vars : Horde_Variables
- __construct() : mixed
- render() : mixed
- status() : mixed
- url() : mixed
- validateMbox() : string
- Validates an IMAP mailbox provided by user input.
- _addToken() : Horde_Url
- Add the ingo action token to a URL.
- _assertCategory() : mixed
- Assert category.
- _checkToken() : string
- Check token.
- _init() : mixed
Constants
INGO_TOKEN
public
mixed
INGO_TOKEN
= 'ingo_token'
Properties
$output
public
string
$output
$title
public
string
$title
$vars
public
Horde_Variables
$vars
Methods
__construct()
public
__construct(Horde_Variables $vars) : mixed
Parameters
- $vars : Horde_Variables
Return values
mixed —render()
public
render() : mixed
Return values
mixed —status()
public
status() : mixed
Return values
mixed —url()
public
static url([array<string|int, mixed> $opts = array() ]) : mixed
Parameters
- $opts : array<string|int, mixed> = array()
Return values
mixed —validateMbox()
Validates an IMAP mailbox provided by user input.
public
validateMbox(string $name) : string
Parameters
- $name : string
-
The form name of the input.
Tags
Return values
string —The IMAP mailbox name.
_addToken()
Add the ingo action token to a URL.
protected
_addToken(Horde_Url $url) : Horde_Url
Parameters
- $url : Horde_Url
-
URL.
Return values
Horde_Url —URL with token added (for chainable calls).
_assertCategory()
Assert category.
protected
_assertCategory(int $type, string $label) : mixed
Parameters
- $type : int
-
Category type.
- $label : string
-
Category label.
Return values
mixed —_checkToken()
Check token.
protected
_checkToken(array<string|int, mixed> $actions) : string
Parameters
- $actions : array<string|int, mixed>
-
The list of actions that require token checking.
Return values
string —The verified action ID.
_init()
protected
_init() : mixed