Class Maintenance_Tasklist

Description

The Maintenance_Tasklist:: class is used to store the list of maintenance tasks that need to be run during this login.

Copyright 2002-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Maintenance/Maintenance.php (line 551)


	
			
Variable Summary
 boolean $_addFlag
 string $_module
 array $_postdata
 boolean $_processed
 string $_target
 array $_tasks
Method Summary
 Maintenance_Tasklist Maintenance_Tasklist ()
 void addTask (string $key, boolean $confirmed, integer $display)
 array getList ()
 string getModule ()
 array getPostData ()
 string getTarget ()
 boolean inList (string $task)
 boolean processed ([boolean $set = false])
 void removeTask (string $task)
 void setNewPage (string $task, string $flag)
Variables
boolean $_addFlag = false (line 594)

Internal flag for addTask().

string $_module (line 558)

The Horde module running the maintenance tasks.

array $_postdata = array() (line 572)

POST data for the calling script.

boolean $_processed = false (line 601)

Has the tasklist been processed yet?

string $_target (line 565)

The URL of the web page to load after maintenance is complete.

array $_tasks = array() (line 587)

The list of tasks to run during this login.

KEY: Task name VALUE: Array => ( 'confirmed' => boolean, 'display' => integer, 'newpage' => boolean, 'process' => boolean )

Methods
Constructor Maintenance_Tasklist (line 606)

Constructor.

Maintenance_Tasklist Maintenance_Tasklist ()
addTask (line 621)

Adds a task to the tasklist.

void addTask (string $key, boolean $confirmed, integer $display)
  • string $key: The name of the task to perform.
  • boolean $confirmed: Has the task been confirmed?
  • integer $display: The display type of the task.
getList (line 682)

Return the list of tasks.

  • return: The list of tasks that still need to be done.
array getList ()
getModule (line 692)

Return the Horde module the tasks are running under.

  • return: The Horde module name.
string getModule ()
getPostData (line 702)

Return the POST data.

  • return: The POST data from the initial URL.
array getPostData ()
getTarget (line 712)

Return the URL of the web page to load after maintenance is complete.

  • return: The target URL.
string getTarget ()
inList (line 672)

Is this task already in the tasklist?

  • return: Whether the task is already in the tasklist.
boolean inList (string $task)
  • string $task: The name of the task.
processed (line 725)

Sets/displays the flag to show that tasklist has been processed at least once.

  • return: Has the tasklist been processed before?
boolean processed ([boolean $set = false])
  • boolean $set: Set the flag?
removeTask (line 658)

Removes the task from the tasklist.

void removeTask (string $task)
  • string $task: The name of the task to alter.
setNewPage (line 645)

Sets the newpage flag for a task.

void setNewPage (string $task, string $flag)
  • string $task: The name of the task to alter.
  • string $flag: How to set the flag.

Documentation generated on Sun, 30 Jan 2011 05:19:27 +0000 by phpDocumentor 1.4.3