Alternc
latest
Alternc logiel libre pour l'hébergement
|
Ftp Api of AlternC, used by alternc-api package. More...
Public Member Functions | |
__construct ($service) | |
add ($options) | |
API Method from legacy class method ftp->add_ftp() More... | |
update ($options) | |
API Method from legacy class method ftp->put_ftp_details() More... | |
del ($options) | |
API Method from legacy class method ftp->del_ftp() More... | |
find ($options) | |
API Method from legacy class method ftp->get_list() More... | |
isFtp ($options) | |
API Method from legacy class method ftp->is_ftp() More... | |
Public Attributes | |
const | ERR_INVALID_ARGUMENT = 111201 |
const | ERR_ALTERNC_FUNCTION = 111202 |
const | ERR_NOT_FOUND = 111203 |
Protected Member Functions | |
alterncLegacyErrorManager () | |
return a proper Alternc_Api_Response from an error class and error string from AlternC legacy class More... | |
offsetAndCount ($options, $max) | |
ensure that offset & count are set properly from $options. More... | |
Protected Attributes | |
$ftp | |
$admin | |
$cuid | |
$isAdmin | |
$db | |
Alternc_Api_Object_Ftp::__construct | ( | $service | ) |
Reimplemented from Alternc_Api_Legacyobject.
Definition at line 10 of file Ftp.php.
References $ftp.
Alternc_Api_Object_Ftp::add | ( | $options | ) |
API Method from legacy class method ftp->add_ftp()
$options | a hash with parameters transmitted to legacy call mandatory parameters: prefix, login, pass, dir |
Definition at line 21 of file Ftp.php.
References $key, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().
|
protectedinherited |
return a proper Alternc_Api_Response from an error class and error string from AlternC legacy class
Definition at line 38 of file Legacyobject.php.
References $err.
Referenced by Alternc_Api_Object_Mail\account(), Alternc_Api_Object_Account\add(), Alternc_Api_Object_Domain\add(), add(), Alternc_Api_Object_Mysql\add(), Alternc_Api_Object_Ssl\aliasAdd(), Alternc_Api_Object_Ssl\aliasDel(), Alternc_Api_Object_Policy\check(), Alternc_Api_Object_Mail\create(), Alternc_Api_Object_Account\del(), Alternc_Api_Object_Domain\del(), del(), Alternc_Api_Object_Mysql\del(), Alternc_Api_Object_Mail\delete(), Alternc_Api_Object_Mail\disable(), Alternc_Api_Object_Mail\enable(), Alternc_Api_Object_Ssl\finalize(), Alternc_Api_Object_Account\find(), find(), Alternc_Api_Object_Mysql\find(), Alternc_Api_Object_Policy\find(), Alternc_Api_Object_Domain\get(), Alternc_Api_Object_Mail\get(), Alternc_Api_Object_Subdomain\get(), Alternc_Api_Object_Mail\getAll(), Alternc_Api_Object_Ssl\getCertificate(), Alternc_Api_Object_Ssl\importCert(), Alternc_Api_Object_Mail\isAvailable(), isFtp(), Alternc_Api_Object_Mail\listDomains(), Alternc_Api_Object_Account\lock(), Alternc_Api_Object_Mysql\lock(), Alternc_Api_Object_Ssl\newCsr(), Alternc_Api_Object_Mail\passwd(), Alternc_Api_Object_Subdomain\set(), Alternc_Api_Object_Account\setAdmin(), Alternc_Api_Object_Mysql\setAdmin(), Alternc_Api_Object_Ssl\share(), Alternc_Api_Object_Mail\undelete(), Alternc_Api_Object_Account\unlock(), Alternc_Api_Object_Mysql\unlock(), Alternc_Api_Object_Account\unsetAdmin(), Alternc_Api_Object_Mysql\unsetAdmin(), Alternc_Api_Object_Account\update(), Alternc_Api_Object_Domain\update(), update(), Alternc_Api_Object_Mail\update(), Alternc_Api_Object_Mysql\update(), and Alternc_Api_Object_Policy\update().
Alternc_Api_Object_Ftp::del | ( | $options | ) |
API Method from legacy class method ftp->del_ftp()
$options | a hash with parameters transmitted to legacy call mandatory parameters: id |
Definition at line 76 of file Ftp.php.
References Alternc_Api_Legacyobject\alterncLegacyErrorManager().
Alternc_Api_Object_Ftp::find | ( | $options | ) |
API Method from legacy class method ftp->get_list()
$options | a hash with parameters transmitted to legacy call non-mandatory parameters: Any of: offset(int=0), count(int=+inf) |
Definition at line 94 of file Ftp.php.
References Alternc_Api_Legacyobject\alterncLegacyErrorManager(), and Alternc_Api_Legacyobject\offsetAndCount().
Alternc_Api_Object_Ftp::isFtp | ( | $options | ) |
API Method from legacy class method ftp->is_ftp()
$options | a hash with parameters transmitted to legacy call mandatory parameters: DIR |
Definition at line 112 of file Ftp.php.
References Alternc_Api_Legacyobject\alterncLegacyErrorManager().
|
protectedinherited |
ensure that offset & count are set properly from $options.
Definition at line 45 of file Legacyobject.php.
Referenced by Alternc_Api_Object_Account\find(), Alternc_Api_Object_Domain\find(), find(), and Alternc_Api_Object_Mysql\find().
Alternc_Api_Object_Ftp::update | ( | $options | ) |
API Method from legacy class method ftp->put_ftp_details()
$options | a hash with parameters transmitted to legacy call mandatory parameters: id non-mandatory: prefix, login, pass, dir |
Definition at line 46 of file Ftp.php.
References $id, $key, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().
|
protectedinherited |
Definition at line 11 of file Legacyobject.php.
Referenced by Alternc_Api_Legacyobject\__construct().
|
protectedinherited |
Definition at line 12 of file Legacyobject.php.
Referenced by Alternc_Api_Legacyobject\__construct(), Alternc_Api_Object_Domain\find(), Alternc_Api_Object_Domain\get(), Alternc_Api_Object_Subdomain\get(), Alternc_Api_Object_Mail\listDomains(), Alternc_Api_Object_Mail\login(), and Alternc_Api_Object_Subdomain\set().
|
protectedinherited |
Definition at line 14 of file Legacyobject.php.
|
protected |
Definition at line 8 of file Ftp.php.
Referenced by __construct().
|
protectedinherited |
Definition at line 13 of file Legacyobject.php.
Referenced by Alternc_Api_Legacyobject\__construct().
|
inherited |
Definition at line 17 of file Legacyobject.php.
|
inherited |
Definition at line 16 of file Legacyobject.php.
|
inherited |
Definition at line 18 of file Legacyobject.php.