API Documentation
\

\Horde_Core_LoginTasks_Backend_Horde

This class provides the Horde specific implementation of the LoginTasks backend.

Copyright 2010-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
__construct()
getTasklistFromCache()
storeTasklistInCache()
getTasks()
getLastRun()
setLastRun()
markLastRun()
redirect()
getLoginTasksUrl()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_app
N/A

Properties

$_app

$_app : string

The Horde application that is currently active.

Type

string

Methods

__construct()

__construct(string  $app)

Constructor.

Parameters

string $app

The currently active Horde application.

getTasklistFromCache()

getTasklistFromCache() : \Horde_LoginTasks_Tasklist|boolean

Retrieve a cached tasklist if it exists.

Returns

\Horde_LoginTasks_Tasklist|boolean —

The cached task list or false if no task list was cached.

storeTasklistInCache()

storeTasklistInCache(\Horde_LoginTasks_Tasklist|boolean  $tasklist)

Store a login tasklist in the cache.

Parameters

\Horde_LoginTasks_Tasklist|boolean $tasklist

The tasklist to be stored.

getTasks()

getTasks() : array

Get the class names of the task classes that need to be performed.

Returns

array —

An array of class names.

getLastRun()

getLastRun() : array

Get the information about the last time the tasks were run. Array keys are app names, values are last run timestamps. Special key '_once' contains list of ONCE tasks previously run.

Returns

array —

The information about the last time the tasks were run.

setLastRun()

setLastRun(array  $last)

Store the information about the last time the tasks were run.

Parameters

array $last

The information about the last time the tasks were run.

markLastRun()

markLastRun()

Mark the current time as time the login tasks were run for the last time.

redirect()

redirect(\Horde_Url|string  $url)

Redirect to the given URL.

Parameters

\Horde_Url|string $url

The URL to redirect to.

getLoginTasksUrl()

getLoginTasksUrl() : string

Return the URL of the login tasks view.

Returns

string —

The URL of the login tasks view.