API Documentation
\
Horde
Backup
Reader
CompressIterator

\Horde\BackupUsers

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.

Summary

Methods
Properties
Constants
__construct()
current()
key()
next()
rewind()
valid()
No public properties found
No constants found
No protected methods found
$_users
$_getUser
N/A
No private methods found
No private properties found
N/A

Properties

$_users

$_users : \Iterator

The user list.

Type

\Iterator

$_getUser

$_getUser : callback

User creation callback.

Type

callback

Methods

__construct()

__construct(\Iterator  $users, callable  $getUser)

Constructor.

Parameters

\Iterator $users

A user list.
callable $getUser

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

current()

current() : \Horde\Backup\User

A single user's backup data.

Returns

\Horde\Backup\User

key()

key() : string

A user name.

Returns

string

next()

next()

rewind()

rewind()

valid()

valid()