Class Horde_LoginTasks_Task
Abstract class to allow for modularization of specific login tasks.
Copyright 2001-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.
Methods summary
abstract public
|
#
execute( )
Do login task (if it has been confirmed).
Do login task (if it has been confirmed).
|
public
string
|
#
describe( )
Return description information for the login task.
Return description information for the login task.
Returns
stringDescription that will be displayed on the login task
confirmation page.
|
public
boolean
|
#
needsDisplay( )
Does the task need to be displayed?
Does the task need to be displayed?
Returns
boolean
True if the task should be displayed.
|
public
boolean
|
#
joinDisplayWith( Horde_LoginTasks_Task $previous )
Indicates if the display of the current task should be joined with the
given previous task.
Indicates if the display of the current task should be joined with the
given previous task.
Parameters
- $previous
- The previous task to display.
Returns
boolean
True if both tasks should be displayed together.
|
Properties summary
public
boolean
|
$active
|
|
public
integer
|
$display
The style of the page output.
The style of the page output.
[1] Horde_LoginTasks::DISPLAY_CONFIRM_NO Horde_LoginTasks::DISPLAY_CONFIRM_YES Each output from describe() will have a checkbox associated with it. For each checkbox selected, execute() for that task will be run. More than 1 confirmation message can be displayed on the confirmation page at once.
DISPLAY_CONFIRM_YES will be checked by default, DISPLAY_CONFIRM_NO will be unchecked by default.
[2] Horde_LoginTasks::DISPLAY_AGREE The output from describe() should be text asking the user to agree/disagree to specified terms. If 'yes' is selected, the POST variable 'agree' will be set. If 'no' is selected, the POST variable 'not_agree' will be set. In either case, execute() will ALWAYS be run. This style will be displayed on its own confirmation page.
[3] Horde_LoginTasks::DISPLAY_NOTICE The output from describe() should be any non-interactive text desired. There will be a single 'Click to Continue' button below this text. execute() will ALWAYS be run. This style will be displayed on its own confirmation page.
[4] Horde_LoginTasks::DISPLAY_NONE Don't display any confirmation to the user.
|
|
public
integer
|
$interval
The interval at which to run the task.
The interval at which to run the task.
|
|
public
integer
|
$priority
The priority of the task.
The priority of the task.
|
|