more api-documentation and code-formatting
Signed-off-by: Michael Kaufmann <d00p@froxlor.org>
This commit is contained in:
@@ -172,7 +172,7 @@ class Domains extends ApiCommand implements ResourceEntity
|
||||
* @param bool $hsts_preload
|
||||
* optional whether or not to preload HSTS header value
|
||||
* @param bool $ocsp_stapling
|
||||
* optional whether to enable oscp-stapling for this domain. default ß (false), requires SSL
|
||||
* optional whether to enable oscp-stapling for this domain. default 0 (false), requires SSL
|
||||
*
|
||||
* @access admin
|
||||
* @throws Exception
|
||||
@@ -745,7 +745,7 @@ class Domains extends ApiCommand implements ResourceEntity
|
||||
* @param bool $hsts_preload
|
||||
* optional whether or not to preload HSTS header value
|
||||
* @param bool $ocsp_stapling
|
||||
* optional whether to enable oscp-stapling for this domain. default ß (false), requires SSL
|
||||
* optional whether to enable oscp-stapling for this domain. default 0 (false), requires SSL
|
||||
*
|
||||
* @access admin
|
||||
* @throws Exception
|
||||
|
||||
@@ -101,6 +101,26 @@ class FpmDaemons extends ApiCommand implements ResourceEntity
|
||||
/**
|
||||
* create a new fpm-daemon entry
|
||||
*
|
||||
* @param string $description
|
||||
* @param string $reload_cmd
|
||||
* @param string $config_dir
|
||||
* @param string $pm
|
||||
* optional, process-manager, one of 'static', 'dynamic' or 'ondemand', default 'static'
|
||||
* @param int $max_children
|
||||
* optional, default 0
|
||||
* @param int $start_servers
|
||||
* optional, default 0
|
||||
* @param int $min_spare_servers
|
||||
* optional, default 0
|
||||
* @param int $max_spare_servers
|
||||
* optional, default 0
|
||||
* @param int $max_requests
|
||||
* optional, default 0
|
||||
* @param int $idle_timeout
|
||||
* optional, default 0
|
||||
* @param string $limit_extensions
|
||||
* optional, limit execution to the following extensions, default '.php'
|
||||
*
|
||||
* @access admin
|
||||
* @throws Exception
|
||||
* @return array
|
||||
@@ -188,6 +208,29 @@ class FpmDaemons extends ApiCommand implements ResourceEntity
|
||||
* update a fpm-daemon entry by given id
|
||||
*
|
||||
* @param int $id
|
||||
* fpm-daemon id
|
||||
* @param string $description
|
||||
* optional
|
||||
* @param string $reload_cmd
|
||||
* optional
|
||||
* @param string $config_dir
|
||||
* optional
|
||||
* @param string $pm
|
||||
* optional, process-manager, one of 'static', 'dynamic' or 'ondemand', default 'static'
|
||||
* @param int $max_children
|
||||
* optional, default 0
|
||||
* @param int $start_servers
|
||||
* optional, default 0
|
||||
* @param int $min_spare_servers
|
||||
* optional, default 0
|
||||
* @param int $max_spare_servers
|
||||
* optional, default 0
|
||||
* @param int $max_requests
|
||||
* optional, default 0
|
||||
* @param int $idle_timeout
|
||||
* optional, default 0
|
||||
* @param string $limit_extensions
|
||||
* optional, limit execution to the following extensions, default '.php'
|
||||
*
|
||||
* @access admin
|
||||
* @throws Exception
|
||||
|
||||
@@ -93,7 +93,7 @@ class Froxlor extends ApiCommand
|
||||
|
||||
/**
|
||||
*
|
||||
* @todo export settings to file
|
||||
* @todo export settings
|
||||
*
|
||||
* @access admin
|
||||
*/
|
||||
|
||||
@@ -87,6 +87,34 @@ class IpsAndPorts extends ApiCommand implements ResourceEntity
|
||||
/**
|
||||
* create a new ip/port entry
|
||||
*
|
||||
* @param string $ip
|
||||
* @param int $port
|
||||
* optional, default 80
|
||||
* @param bool $listen_statement
|
||||
* optional, default 0 (false)
|
||||
* @param bool $namevirtualhost_statement
|
||||
* optional, default 0 (false)
|
||||
* @param bool $vhostcontainer
|
||||
* optional, default 0 (false)
|
||||
* @param string $specialsettings
|
||||
* optional, default empty
|
||||
* @param bool $vhostcontainer_servername_statement
|
||||
* optional, default 0 (false)
|
||||
* @param string $default_vhostconf_domain
|
||||
* optional, defatul empty
|
||||
* @param string $docroot
|
||||
* optional, default empty (point to froxlor)
|
||||
* @param bool $ssl
|
||||
* optional, default 0 (false)
|
||||
* @param string $ssl_cert_file
|
||||
* optional, requires $ssl = 1, default empty
|
||||
* @param string $ssl_key_file
|
||||
* optional, requires $ssl = 1, default empty
|
||||
* @param string $ssl_ca_file
|
||||
* optional, requires $ssl = 1, default empty
|
||||
* @param string $ssl_cert_chainfile
|
||||
* optional, requires $ssl = 1, default empty
|
||||
*
|
||||
* @access admin
|
||||
* @throws Exception
|
||||
* @return array
|
||||
@@ -227,6 +255,34 @@ class IpsAndPorts extends ApiCommand implements ResourceEntity
|
||||
* update ip/port entry by given id
|
||||
*
|
||||
* @param int $id
|
||||
* @param string $ip
|
||||
* optional
|
||||
* @param int $port
|
||||
* optional, default 80
|
||||
* @param bool $listen_statement
|
||||
* optional, default 0 (false)
|
||||
* @param bool $namevirtualhost_statement
|
||||
* optional, default 0 (false)
|
||||
* @param bool $vhostcontainer
|
||||
* optional, default 0 (false)
|
||||
* @param string $specialsettings
|
||||
* optional, default empty
|
||||
* @param bool $vhostcontainer_servername_statement
|
||||
* optional, default 0 (false)
|
||||
* @param string $default_vhostconf_domain
|
||||
* optional, defatul empty
|
||||
* @param string $docroot
|
||||
* optional, default empty (point to froxlor)
|
||||
* @param bool $ssl
|
||||
* optional, default 0 (false)
|
||||
* @param string $ssl_cert_file
|
||||
* optional, requires $ssl = 1, default empty
|
||||
* @param string $ssl_key_file
|
||||
* optional, requires $ssl = 1, default empty
|
||||
* @param string $ssl_ca_file
|
||||
* optional, requires $ssl = 1, default empty
|
||||
* @param string $ssl_cert_chainfile
|
||||
* optional, requires $ssl = 1, default empty
|
||||
*
|
||||
* @access admin
|
||||
* @throws ErrorException
|
||||
|
||||
Reference in New Issue
Block a user