maketank/Froxlor
2
0
Fork 0
Code Pull Requests Releases Activity

Merge branch 'annotationsAPI' of https://github.com/foliengriller/Froxlor into foliengriller-annotationsAPI

Browse Source
This commit is contained in:
Michael Kaufmann
2019-04-26 12:23:58 +02:00
parent f93dc5643f 98f6ad183e
commit cb636fe2c9
20 changed files with 90 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
lib/Froxlor/Api/Commands/Admins.php
View File

@@ -27,7 +27,7 @@ class Admins extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -61,7 +61,7 @@ class Admins extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -158,7 +158,7 @@ class Admins extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -415,7 +415,7 @@ class Admins extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -653,7 +653,7 @@ class Admins extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{
@@ -753,7 +753,7 @@ class Admins extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function unlock()
{
@@ -788,7 +788,7 @@ class Admins extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
/**
* increase resource-usage
*
* @param int $customerid
* @param int $adminid
* @param string $resource
* @param string $extra
* optional, default empty
@@ -803,7 +803,7 @@ class Admins extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
/**
* decrease resource-usage
*
* @param int $customerid
* @param int $adminid
* @param string $resource
* @param string $extra
* optional, default empty

10
lib/Froxlor/Api/Commands/Certificates.php
View File

@@ -38,7 +38,7 @@ class Certificates extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resou
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -87,7 +87,7 @@ class Certificates extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resou
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -129,7 +129,7 @@ class Certificates extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resou
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -164,7 +164,7 @@ class Certificates extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resou
*
* @access admin, customer
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -211,8 +211,8 @@ class Certificates extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resou
*
* @param int $id
*
* @return array
* @throws \Exception
* @return string json-encoded array
*/
public function delete()
{

6
lib/Froxlor/Api/Commands/Cronjobs.php
View File

@@ -37,7 +37,7 @@ class Cronjobs extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceE
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -71,7 +71,7 @@ class Cronjobs extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceE
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -129,7 +129,7 @@ class Cronjobs extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceE
*
* @access admin
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{

4
lib/Froxlor/Api/Commands/CustomerBackups.php
View File

@@ -55,8 +55,8 @@ class CustomerBackups extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Re
* required when called as admin, not needed when called as customer
*
* @access admin, customer
* @return array
* @throws \Exception
* @return string json-encoded array
*/
public function add()
{
@@ -140,7 +140,7 @@ class CustomerBackups extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Re
*
* @access admin, customer
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{

14
lib/Froxlor/Api/Commands/Customers.php
View File

@@ -27,7 +27,7 @@ class Customers extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resource
*
* @access admin
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -69,7 +69,7 @@ class Customers extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resource
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -205,7 +205,7 @@ class Customers extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resource
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -820,7 +820,7 @@ class Customers extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resource
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -1337,7 +1337,7 @@ class Customers extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resource
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{
@@ -1561,7 +1561,7 @@ class Customers extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resource
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function unlock()
{
@@ -1606,7 +1606,7 @@ class Customers extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resource
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function move()
{

10
lib/Froxlor/Api/Commands/DirOptions.php
View File

@@ -44,7 +44,7 @@ class DirOptions extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -139,7 +139,7 @@ class DirOptions extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -214,7 +214,7 @@ class DirOptions extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -288,7 +288,7 @@ class DirOptions extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin, customer
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -321,7 +321,7 @@ class DirOptions extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

10
lib/Froxlor/Api/Commands/DirProtections.php
View File

@@ -37,7 +37,7 @@ class DirProtections extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Res
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -124,7 +124,7 @@ class DirProtections extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Res
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -197,7 +197,7 @@ class DirProtections extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Res
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -271,7 +271,7 @@ class DirProtections extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Res
*
* @access admin, customer
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -306,7 +306,7 @@ class DirProtections extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Res
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

4
lib/Froxlor/Api/Commands/DomainZones.php
View File

@@ -42,7 +42,7 @@ class DomainZones extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -306,7 +306,7 @@ class DomainZones extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{

16
lib/Froxlor/Api/Commands/Domains.php
View File

@@ -27,7 +27,7 @@ class Domains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEn
*
* @access admin
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -70,7 +70,7 @@ class Domains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEn
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -184,7 +184,7 @@ class Domains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEn
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -741,7 +741,7 @@ class Domains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEn
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -1482,7 +1482,7 @@ class Domains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEn
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{
@@ -1629,11 +1629,11 @@ class Domains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEn
/**
* validate given ips
*
* @param int|string|array $p_ipsandports
* @param boolean $edit
* default false
* @param int|string|array $p_ipandports
* @param boolean $ssl
* default false
* @param int $edit_id
* default 0
*
* @throws \Exception
* @return array

6
lib/Froxlor/Api/Commands/EmailAccounts.php
View File

@@ -44,7 +44,7 @@ class EmailAccounts extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Reso
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -300,7 +300,7 @@ class EmailAccounts extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Reso
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -412,7 +412,7 @@ class EmailAccounts extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Reso
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

4
lib/Froxlor/Api/Commands/EmailForwarders.php
View File

@@ -38,7 +38,7 @@ class EmailForwarders extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Re
*
* @access admin,customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -150,7 +150,7 @@ class EmailForwarders extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Re
*
* @access admin,customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

10
lib/Froxlor/Api/Commands/Emails.php
View File

@@ -38,7 +38,7 @@ class Emails extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -152,7 +152,7 @@ class Emails extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -195,7 +195,7 @@ class Emails extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -268,7 +268,7 @@ class Emails extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin, customer
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -308,7 +308,7 @@ class Emails extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

10
lib/Froxlor/Api/Commands/FpmDaemons.php
View File

@@ -26,7 +26,7 @@ class FpmDaemons extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -80,7 +80,7 @@ class FpmDaemons extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -126,7 +126,7 @@ class FpmDaemons extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -237,7 +237,7 @@ class FpmDaemons extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -332,7 +332,7 @@ class FpmDaemons extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

8
lib/Froxlor/Api/Commands/Froxlor.php
View File

@@ -27,7 +27,7 @@ class Froxlor extends \Froxlor\Api\ApiCommand
*
* @access admin
* @throws \Exception
* @return string
* @return string json-encoded array
*/
public function checkUpdate()
{
@@ -110,7 +110,7 @@ class Froxlor extends \Froxlor\Api\ApiCommand
*
* @access admin
* @throws \Exception
* @return bool
* @return string json-encoded bool
*/
public function importSettings()
{
@@ -155,7 +155,7 @@ class Froxlor extends \Froxlor\Api\ApiCommand
*
* @access admin
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listSettings()
{
@@ -236,7 +236,7 @@ class Froxlor extends \Froxlor\Api\ApiCommand
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function listFunctions()
{

10
lib/Froxlor/Api/Commands/Ftps.php
View File

@@ -44,7 +44,7 @@ class Ftps extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEntit
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -240,7 +240,7 @@ class Ftps extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEntit
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -311,7 +311,7 @@ class Ftps extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEntit
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -423,7 +423,7 @@ class Ftps extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEntit
*
* @access admin, customer
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -456,7 +456,7 @@ class Ftps extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEntit
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

10
lib/Froxlor/Api/Commands/IpsAndPorts.php
View File

@@ -27,7 +27,7 @@ class IpsAndPorts extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -61,7 +61,7 @@ class IpsAndPorts extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -121,7 +121,7 @@ class IpsAndPorts extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -291,7 +291,7 @@ class IpsAndPorts extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -449,7 +449,7 @@ class IpsAndPorts extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

10
lib/Froxlor/Api/Commands/Mysqls.php
View File

@@ -38,7 +38,7 @@ class Mysqls extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -183,7 +183,7 @@ class Mysqls extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -279,7 +279,7 @@ class Mysqls extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -362,7 +362,7 @@ class Mysqls extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin, customer
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -428,7 +428,7 @@ class Mysqls extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEnt
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

10
lib/Froxlor/Api/Commands/PhpSettings.php
View File

@@ -30,7 +30,7 @@ class PhpSettings extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -123,7 +123,7 @@ class PhpSettings extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -192,7 +192,7 @@ class PhpSettings extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -393,7 +393,7 @@ class PhpSettings extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -548,7 +548,7 @@ class PhpSettings extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resour
*
* @access admin
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

10
lib/Froxlor/Api/Commands/SubDomains.php
View File

@@ -56,7 +56,7 @@ class SubDomains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function add()
{
@@ -331,7 +331,7 @@ class SubDomains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function get()
{
@@ -441,7 +441,7 @@ class SubDomains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function update()
{
@@ -658,7 +658,7 @@ class SubDomains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin, customer
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{
@@ -735,7 +735,7 @@ class SubDomains extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\Resourc
*
* @access admin, customer
* @throws \Exception
* @return array
* @return string json-encoded array
*/
public function delete()
{

2
lib/Froxlor/Api/Commands/Traffic.php
View File

@@ -69,7 +69,7 @@ class Traffic extends \Froxlor\Api\ApiCommand implements \Froxlor\Api\ResourceEn
*
* @access admin, customer
* @throws \Exception
* @return array count|list
* @return string json-encoded array count|list
*/
public function listing()
{