Public Member Functions |
|
| __construct ($ftpBackupObj, $parent) | |
| __get ($name) | |
| __set ($name, $value) | |
| addListener ($address) | |
| configAccessControl () | |
| fileSystemMount ($mountPoint, $domain=null, $sinceLabel=null, $backupLabel=null, $noremove=false, $folderPath=null, $objectName=null) | |
| fileSystemUnmount ($mountPoint) | |
| getAccessControl () | |
| getFtpBackupObj () | |
| getLogHost () | |
| getLogLevel () | |
| getLogType () | |
| getMaxAuthErrors () | |
| getMaxConnThreads () | |
| getMaxErrors () | |
| getMessagesTarEnabled () | |
| getMinConnThreads () | |
| getSessionObj () | |
| listListeners () | |
| purgeBackupLabels ($domain=null) | |
| removeBackupLabel ($backupLabel, $domain=null) | |
| removeListener ($address) | |
| reset () | |
| save () | |
| setLogHost ($value) | |
| setLogLevel ($value) | |
| setLogType ($value) | |
| setMaxAuthErrors ($value) | |
| setMaxConnThreads ($value) | |
| setMaxErrors ($value) | |
| setMessagesTarEnabled ($value) | |
| setMinConnThreads ($value) | |
| start () | |
| stop () | |
| updateListener ($address) | |
Member Function Documentation
| FtpBackup::__get | ( | $ | name | ) |
Get member.
|
member |
description |
|---|---|
|
maxConnThreads |
the maximum number of threads involved in I/O for the Ftp Backup&Restore service |
|
minConnThreads |
the minimum number of threads involved in I/O for the Ftp Backup&Restore service |
|
maxErrors |
the maximum number of protocol errors after which the connection is terminated |
|
maxAuthErrors |
the maximum number of authentication errors after which the connection is terminated |
|
logLevel |
the log level for the FTP Backup&Restore service |
|
logHost |
the address of the host that offers log services |
|
logType |
the log type for the FTP Backup&Restore service |
|
messagesTarEnabled |
enabled/disabled tar archive on messages |
| FtpBackup::__set | ( | $ | name, | |
| $ | value | |||
| ) |
Get member.
|
member |
description |
|---|---|
|
maxConnThreads |
the maximum number of threads involved in I/O for the Ftp Backup&Restore service |
|
minConnThreads |
the minimum number of threads involved in I/O for the Ftp Backup&Restore service |
|
maxErrors |
the maximum number of protocol errors after which the connection is terminated |
|
maxAuthErrors |
the maximum number of authentication errors after which the connection is terminated |
|
logLevel |
the log level for the FTP Backup&Restore service |
|
logHost |
the address of the host that offers log services |
|
logType |
the log type for the FTP Backup&Restore service |
|
messagesTarEnabled |
enabled/disabled tar archive on messages |
| FtpBackup::addListener | ( | $ | address | ) |
This function adds a listener to this service
- Returns:
- bool
- Parameters:
-
$address string the listener address (ex: 127.0.0.1:21)
| FtpBackup::configAccessControl | ( | ) |
This function returns an access control object for this service
- Returns:
- object AccessControl
| FtpBackup::fileSystemMount | ( | $ | mountPoint, | |
| $ | domain = null, |
|||
| $ | sinceLabel = null, |
|||
| $ | backupLabel =
null, |
|||
| $ | noremove = false, |
|||
| $ | folderPath = null, |
|||
| $ | objectName = null |
|||
| ) |
mount a backup mount point
- Returns:
- bool
- Parameters:
-
$mountPoint string mount point $domain string the domain to mount(optional) $sinceLabel string since backup label(optional) $backupLabel string backupLabel (optional) $noremove bool don't show removed objects (optional, default: false) $folderPath string folderPath - if objectName not set will mount the public folder, if set will mount the object folder (optional) $objectName string object to mount (optional)
| FtpBackup::fileSystemUnmount | ( | $ | mountPoint | ) |
unmount a backup mount point
- Returns:
- bool
- Parameters:
-
$mountPoint string mount point
| FtpBackup::getAccessControl | ( | ) |
This function returns an access control object for this service
- Returns:
- AccessControl
| FtpBackup::listListeners | ( | ) |
This function lists the listeners for this service
- Returns:
- array
| FtpBackup::purgeBackupLabels | ( | $ | domain = null |
) |
purge backuplabels
- Returns:
- bool
- Parameters:
-
$domain string the domain name where backup label are created (optional)
| FtpBackup::removeBackupLabel | ( | $ | backupLabel, | |
| $ | domain = null |
|||
| ) |
remove a backup label
- Returns:
- bool
- Parameters:
-
$backupLabel string the backup label to remove $domain string the domain name where this backup label is created (optional)
| FtpBackup::removeListener | ( | $ | address | ) |
This function removes a listener from this service
- Returns:
- bool
- Parameters:
-
$address string the listener address (ex: 127.0.0.1:21)
| FtpBackup::start | ( | ) |
This function starts the FTP Backup&Restore service
- Returns:
- bool
| FtpBackup::stop | ( | ) |
This function stops the FTP Backup&Restore service
- Returns:
- bool
| FtpBackup::updateListener | ( | $ | address | ) |
This function updates a listener of this service
- Returns:
- object Listener
- Parameters:
-
$address string the listener address (ex: 127.0.0.1:21)