PHP Class Horde_LoginTasks, horde

Author: Michael Slusarz ([email protected])

Mostra file Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_tasklist	Horde_LoginTasks_Tasklist	The Horde_LoginTasks_Tasklist object for this login.

Public Methods

Method	Description
__construct ( Horde_LoginTasks_Backend $backend )	Constructor.
displayTasks ( ) : array	Generate the list of tasks that need to be displayed.
getLabels ( ) : array	Labels for the class constants.
getLoginTasksUrl ( ) : string	Generate the login tasks URL.
runTasks ( array $opts = [] ) : mixed	Do operations needed for this login.
shutdown ( )	Tasks to run on session shutdown.

Protected Methods

Method	Description
_createTaskList ( )	Creates the list of login tasks that are available for this session (stored in a Horde_LoginTasks_Tasklist object).

Method Details

__construct() public method

Constructor.

public __construct ( Horde_LoginTasks_Backend $backend )
$backend	Horde_LoginTasks_Backend	The backend to use.

_createTaskList() protected method

Creates the list of login tasks that are available for this session (stored in a Horde_LoginTasks_Tasklist object).

protected _createTaskList ( )

displayTasks() public method

This is the function called from the login tasks page every time it is loaded.

public displayTasks ( ) : array
return	array	The list of tasks that need to be displayed.

getLabels() public static method

Labels for the class constants.

public static getLabels ( ) : array
return	array	A mapping of constant to gettext string.

getLoginTasksUrl() public method

Generate the login tasks URL.

public getLoginTasksUrl ( ) : string
return	string	The login tasks URL.

runTasks() public method

This function will generate the list of tasks to perform during this login and will redirect to the login tasks page if necessary. This is the function that should be called from the application upon login.

public runTasks ( array $opts = [] ) : mixed
$opts	array	Options: - confirmed: (array) The list of confirmed tasks. - url: (string) The URL to redirect to when finished. - user_confirmed: (boolean) If true, indicates that any pending actions have been confirmed by the user.
return	mixed	Null in case no redirection took place, the return value from the backend redirect() call otherwise.

shutdown() public method

Tasks to run on session shutdown.

public shutdown ( )

Property Details

$_tasklist protected_oe property

The Horde_LoginTasks_Tasklist object for this login.

protected Horde_LoginTasks_Tasklist $_tasklist
return	Horde_LoginTasks_Tasklist