• Inicio
  • Horde_LoginTasks_Tasklist

PHP Class Horde_LoginTasks_Tasklist, horde

Copyright 2002-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Michael Slusarz ([email protected])
Mostrar archivo Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$processed boolean Has this tasklist been processed yet?
$target string The URL of the web page to load after login tasks are complete.

Protected Properties

Property Type Description
$_ptr integer Current task location pointer.
$_stasks array The list of system tasks to run during this login.
$_tasks array KEY: Task name VALUE: array => ( 'display' => boolean, 'task' => integer )

Public Methods

Method Description
addTask ( Horde_LoginTasks_Task $task ) Adds a task to the tasklist.
isDone ( ) : boolean Are all tasks complete?
needDisplay ( boolean $advance = false ) : array Returns the next batch of tasks that need display.
ready ( boolean $advance = false ) : array Returns the list of tasks to perform.

Method Details

addTask() public method

Adds a task to the tasklist.
public addTask ( Horde_LoginTasks_Task $task )
$task Horde_LoginTasks_Task The task to execute.

isDone() public method

Are all tasks complete?
public isDone ( ) : boolean
return boolean True if all tasks are complete.

needDisplay() public method

Returns the next batch of tasks that need display.
public needDisplay ( boolean $advance = false ) : array
$advance boolean If true, advance the internal pointer.
return array The list of tasks to display.

ready() public method

Returns the list of tasks to perform.
public ready ( boolean $advance = false ) : array
$advance boolean If true, mark ready tasks as completed.
return array The list of tasks to perform.

Property Details

$_ptr protected_oe property

Current task location pointer.
protected int $_ptr
return integer

$_stasks protected_oe property

The list of system tasks to run during this login.
protected array $_stasks
return array

$_tasks protected_oe property

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

$processed public_oe property

Has this tasklist been processed yet?
public bool $processed
return boolean

$target public_oe property

The URL of the web page to load after login tasks are complete.
public string $target
return string