Horde_Core_LoginTasks_Backend_Horde
extends Horde_LoginTasks_Backend
in package
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.
Tags
Table of Contents
Properties
- $_app : string
- The Horde application that is currently active.
Methods
- __construct() : mixed
- Constructor.
- getLastRun() : array<string|int, mixed>
- 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.
- getLoginTasksUrl() : string
- Return the URL of the login tasks view.
- getTasklistFromCache() : Horde_LoginTasks_Tasklist|bool
- Retrieve a cached tasklist if it exists.
- getTasks() : array<string|int, mixed>
- Get the class names of the task classes that need to be performed.
- markLastRun() : mixed
- Mark the current time as time the login tasks were run for the last time.
- redirect() : mixed
- Redirect to the given URL.
- setLastRun() : mixed
- Store the information about the last time the tasks were run.
- storeTasklistInCache() : mixed
- Store a login tasklist in the cache.
Properties
$_app
The Horde application that is currently active.
private
string
$_app
Methods
__construct()
Constructor.
public
__construct(string $app) : mixed
Parameters
- $app : string
-
The currently active Horde application.
getLastRun()
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.
public
getLastRun() : array<string|int, mixed>
Return values
array<string|int, mixed> —The information about the last time the tasks were run.
getLoginTasksUrl()
Return the URL of the login tasks view.
public
getLoginTasksUrl() : string
Return values
string —The URL of the login tasks view.
getTasklistFromCache()
Retrieve a cached tasklist if it exists.
public
getTasklistFromCache() : Horde_LoginTasks_Tasklist|bool
Return values
Horde_LoginTasks_Tasklist|bool —The cached task list or false if no task list was cached.
getTasks()
Get the class names of the task classes that need to be performed.
public
getTasks() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of class names.
markLastRun()
Mark the current time as time the login tasks were run for the last time.
public
markLastRun() : mixed
redirect()
Redirect to the given URL.
public
redirect(Horde_Url|string $url) : mixed
Parameters
- $url : Horde_Url|string
-
The URL to redirect to.
setLastRun()
Store the information about the last time the tasks were run.
public
setLastRun(array<string|int, mixed> $last) : mixed
Parameters
- $last : array<string|int, mixed>
-
The information about the last time the tasks were run.
storeTasklistInCache()
Store a login tasklist in the cache.
public
storeTasklistInCache(Horde_LoginTasks_Tasklist|bool $tasklist) : mixed
Parameters
- $tasklist : Horde_LoginTasks_Tasklist|bool
-
The tasklist to be stored.