Documentation

Writer
in package

The backup writer class that writes backups to the backup directory.

Tags
author

Jan Schneider jan@horde.org

category

Horde

copyright

2017 Horde LLC

license

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

Table of Contents

$_backups  : array<string|int, mixed>
Handles for backup data.
$_dir  : string
Backup directory.
__construct()  : mixed
Constructor.
backup()  : mixed
Adds backups of user data.
save()  : int
Saves the backups.

Properties

$_backups

Handles for backup data.

protected array<string|int, mixed> $_backups = array()

$_dir

Backup directory.

protected string $_dir

Methods

__construct()

Constructor.

public __construct(string $directory) : mixed
Parameters
$directory : string

Backup directory.

Return values
mixed

backup()

Adds backups of user data.

public backup(string $application, Users $users) : mixed
Parameters
$application : string

Application name.

$users : Users

User(s) (and their data) to backup.

Return values
mixed

save()

Saves the backups.

public save([int $format = Backup::FORMAT_ZIP ]) : int
Parameters
$format : int = Backup::FORMAT_ZIP

The backup format, one of the Backup::FORMAT_* constants.

Return values
int

Number of processed items.

Search results