Horde_LoginTasks_Tasklist
in package
The Horde_LoginTasks_Tasklist:: class is used to store the list of login tasks that need to be run during this login.
Copyright 2002-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
- $processed : bool
- Has this tasklist been processed yet?
- $target : string
- The URL of the web page to load after login tasks are complete.
- $_ptr : int
- Current task location pointer.
- $_stasks : array<string|int, mixed>
- The list of system tasks to run during this login.
- $_tasks : array<string|int, mixed>
- The list of tasks to run during this login.
- addTask() : mixed
- Adds a task to the tasklist.
- isDone() : bool
- Are all tasks complete?
- needDisplay() : array<string|int, mixed>
- Returns the next batch of tasks that need display.
- ready() : array<string|int, mixed>
- Returns the list of tasks to perform.
Properties
$processed
Has this tasklist been processed yet?
public
bool
$processed
= \false
$target
The URL of the web page to load after login tasks are complete.
public
string
$target
$_ptr
Current task location pointer.
protected
int
$_ptr
= 0
$_stasks
The list of system tasks to run during this login.
protected
array<string|int, mixed>
$_stasks
= array()
Tags
$_tasks
The list of tasks to run during this login.
protected
array<string|int, mixed>
$_tasks
= array()
KEY: Task name VALUE: array => ( 'display' => boolean, 'task' => integer )
Methods
addTask()
Adds a task to the tasklist.
public
addTask(Horde_LoginTasks_Task $task) : mixed
Parameters
- $task : Horde_LoginTasks_Task
-
The task to execute.
Return values
mixed —isDone()
Are all tasks complete?
public
isDone() : bool
Return values
bool —True if all tasks are complete.
needDisplay()
Returns the next batch of tasks that need display.
public
needDisplay([bool $advance = false ]) : array<string|int, mixed>
Parameters
- $advance : bool = false
-
If true, advance the internal pointer.
Return values
array<string|int, mixed> —The list of tasks to display.
ready()
Returns the list of tasks to perform.
public
ready([bool $advance = false ]) : array<string|int, mixed>
Parameters
- $advance : bool = false
-
If true, mark ready tasks as completed.
Return values
array<string|int, mixed> —The list of tasks to perform.