Documentation

Users
in package
implements Iterator

An application's list of users with backup data.

Each application must extend this class and implement the Iterator methods so that the backup data can be returned on demand.

Tags
author

Jan Schneider jan@horde.org

category

Horde

copyright

2017 Horde LLC

license

http://www.horde.org/licenses/bsd BSD

Interfaces, Classes and Traits

Iterator

Table of Contents

$_getUser  : callable
User creation callback.
$_users  : Iterator
The user list.
__construct()  : mixed
Constructor.
current()  : User
A single user's backup data.
key()  : string
A user name.
next()  : mixed
rewind()  : mixed
valid()  : mixed

Properties

$_getUser

User creation callback.

protected callable $_getUser

$_users

The user list.

protected Iterator $_users

Methods

__construct()

Constructor.

public __construct(Iterator $users, callable $getUser) : mixed
Parameters
$users : Iterator

A user list.

$getUser : callable

Callback to create a \Horde\Backup\User instance.

Return values
mixed

current()

A single user's backup data.

public current() : User
Return values
User

key()

A user name.

public key() : string
Return values
string

next()

public next() : mixed
Return values
mixed

rewind()

public rewind() : mixed
Return values
mixed

valid()

public valid() : mixed
Return values
mixed

Search results