\Horde_LoginTasks_Task

Abstract class to allow for modularization of specific login tasks.

Copyright 2001-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
execute()
describe()
needsDisplay()
joinDisplayWith()
$active
$display
$interval
$priority
No constants found
No protected methods found
No protected properties found
N/A
_isConfirmTask()
No private properties found
N/A

Properties

$active

$active : boolean

Should the task be run?

Type

boolean

$display

$display : integer

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.

Type

integer

$interval

$interval : integer

The interval at which to run the task.

Type

integer

$priority

$priority : integer

The priority of the task.

Type

integer

Methods

execute()

execute() 

Do login task (if it has been confirmed).

describe()

describe() : string

Return description information for the login task.

Returns

string —

Description that will be displayed on the login task confirmation page.

needsDisplay()

needsDisplay() : boolean

Does the task need to be displayed?

Returns

boolean —

True if the task should be displayed.

joinDisplayWith()

joinDisplayWith(\Horde_Login_Task  $previous) : boolean

Indicates if the display of the current task should be joined with the given previous task.

Parameters

\Horde_Login_Task $previous

The previous task to display.

Returns

boolean —

True if both tasks should be displayed together.

_isConfirmTask()

_isConfirmTask(\Horde_Login_Task  $task) : boolean

Is this a confirmation task?

Parameters

\Horde_Login_Task $task

The task to analyze.

Returns

boolean —

True if this is a confirmation task.