Class Horde_LoginTasks

The Horde_LoginTasks:: class provides a set of methods for dealing with login tasks to run upon login to Horde applications.

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.php

Methods summary
`public`	# `__construct( Horde_LoginTasks_Backend $backend )` Constructor. Constructor. Parameters `$backend` The backend to use.
`public`	# `shutdown( )` Tasks to run on session shutdown. Tasks to run on session shutdown.
`public mixed`	# `runTasks( array $opts = array() )` Do operations needed for this login. Do operations needed for this login. 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. Parameters `$opts` <p>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.</p> Returns `mixed` Null in case no redirection took place, the return value from the backend redirect() call otherwise.
`public array`	# `displayTasks( )` Generate the list of tasks that need to be displayed. This is the function called from the login tasks page every time it is loaded. Generate the list of tasks that need to be displayed. This is the function called from the login tasks page every time it is loaded. Returns `array` The list of tasks that need to be displayed.
`public string`	# `getLoginTasksUrl( )` Generate the login tasks URL. Generate the login tasks URL. Returns `string` The login tasks URL.
`public static array`	# `getLabels( )` Labels for the class constants. Labels for the class constants. Returns `array` A mapping of constant to gettext string.

Constants summary
`integer`	`YEARLY`	# `1`
`integer`	`MONTHLY`	# `2`
`integer`	`WEEKLY`	# `3`
`integer`	`DAILY`	# `4`
`integer`	`EVERY`	# `5`
`integer`	`FIRST_LOGIN`	# `6`
`integer`	`ONCE`	# `7`
`integer`	`DISPLAY_CONFIRM_NO`	# `1`
`integer`	`DISPLAY_CONFIRM_YES`	# `2`
`integer`	`DISPLAY_AGREE`	# `3`
`integer`	`DISPLAY_NOTICE`	# `4`
`integer`	`DISPLAY_NONE`	# `5`
`integer`	`PRIORITY_HIGH`	# `1`
`integer`	`PRIORITY_NORMAL`	# `2`

Packages

Classes

Class Horde_LoginTasks

Parameters

Parameters

Returns

Returns

Returns

Returns