API Documentation
\

\Horde_LoginTasks_Tasklist

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.

Summary

Methods
Properties
Constants
addTask()
ready()
needDisplay()
isDone()
$target
$processed
No constants found
No protected methods found
$_tasks
$_stasks
$_ptr
N/A
No private methods found
No private properties found
N/A

Properties

$target

$target : string

The URL of the web page to load after login tasks are complete.

Type

string

$processed

$processed : boolean

Has this tasklist been processed yet?

Type

boolean

$_tasks

$_tasks : array

The list of tasks to run during this login.

KEY: Task name VALUE: array => ( 'display' => boolean, 'task' => integer )

Type

array

$_stasks

$_stasks : array

The list of system tasks to run during this login.

Type

array

$_ptr

$_ptr : integer

Current task location pointer.

Type

integer

Methods

addTask()

addTask(\Horde_LoginTasks_Task  $task)

Adds a task to the tasklist.

Parameters

\Horde_LoginTasks_Task $task

The task to execute.

ready()

ready(boolean  $advance = false) : array

Returns the list of tasks to perform.

Parameters

boolean $advance

If true, mark ready tasks as completed.

Returns

array —

The list of tasks to perform.

needDisplay()

needDisplay(boolean  $advance = false) : array

Returns the next batch of tasks that need display.

Parameters

boolean $advance

If true, advance the internal pointer.

Returns

array —

The list of tasks to display.

isDone()

isDone() : boolean

Are all tasks complete?

Returns

boolean —

True if all tasks are complete.