PHP Класс Horde_LoginTasks_Tasklist, horde

Copyright 2002-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Автор: Michael Slusarz ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$processed boolean Has this tasklist been processed yet?
$target string The URL of the web page to load after login tasks are complete.

Защищенные свойства (Protected)

Свойство Тип Описание
$_ptr integer Current task location pointer.
$_stasks array The list of system tasks to run during this login.
$_tasks array KEY: Task name VALUE: array => ( 'display' => boolean, 'task' => integer )

Открытые методы

Метод Описание
addTask ( Horde_LoginTasks_Task $task ) Adds a task to the tasklist.
isDone ( ) : boolean Are all tasks complete?
needDisplay ( boolean $advance = false ) : array Returns the next batch of tasks that need display.
ready ( boolean $advance = false ) : array Returns the list of tasks to perform.

Описание методов

addTask() публичный Метод

Adds a task to the tasklist.
public addTask ( Horde_LoginTasks_Task $task )
$task Horde_LoginTasks_Task The task to execute.

isDone() публичный Метод

Are all tasks complete?
public isDone ( ) : boolean
Результат boolean True if all tasks are complete.

needDisplay() публичный Метод

Returns the next batch of tasks that need display.
public needDisplay ( boolean $advance = false ) : array
$advance boolean If true, advance the internal pointer.
Результат array The list of tasks to display.

ready() публичный Метод

Returns the list of tasks to perform.
public ready ( boolean $advance = false ) : array
$advance boolean If true, mark ready tasks as completed.
Результат array The list of tasks to perform.

Описание свойств

$_ptr защищенное свойство

Current task location pointer.
protected int $_ptr
Результат integer

$_stasks защищенное свойство

The list of system tasks to run during this login.
protected array $_stasks
Результат array

$_tasks защищенное свойство

KEY: Task name VALUE: array => ( 'display' => boolean, 'task' => integer )
protected array $_tasks
Результат array

$processed публичное свойство

Has this tasklist been processed yet?
public bool $processed
Результат boolean

$target публичное свойство

The URL of the web page to load after login tasks are complete.
public string $target
Результат string