Overview

Packages

  • LoginTasks

Classes

  • Horde_LoginTasks
  • Horde_LoginTasks_Backend
  • Horde_LoginTasks_SystemTask
  • Horde_LoginTasks_Task
  • Horde_LoginTasks_Tasklist
  • Horde_LoginTasks_Translation
  • Overview
  • Package
  • Class
  • Tree

Class 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-2012 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.

Package: LoginTasks
Category: Horde
License: LGPL 2.1
Author: Michael Slusarz slusarz@horde.org
Located at Horde/LoginTasks/Tasklist.php
Methods summary
public
# addTask( Horde_LoginTasks_Task $task )

Adds a task to the tasklist.

Adds a task to the tasklist.

Parameters

$task
The task to execute.
public array
# ready( boolean $advance = false )

Returns the list of tasks to perform.

Returns the list of tasks to perform.

Parameters

$advance
If true, mark ready tasks as completed.

Returns

array
The list of tasks to perform.
public array
# needDisplay( boolean $advance = false )

Returns the next batch of tasks that need display.

Returns the next batch of tasks that need display.

Parameters

$advance
If true, advance the internal pointer.

Returns

array
The list of tasks to display.
public boolean
# isDone( )

Are all tasks complete?

Are all tasks complete?

Returns

boolean
True if all tasks are complete.
Properties summary
public string $target

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

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

#
public boolean $processed

Has this tasklist been processed yet?

Has this tasklist been processed yet?

# false
API documentation generated by ApiGen