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

list() is a reserved php keyword, changed ApiCommand::list() to ApiCommand::listing()

Browse Source 
Signed-off-by: Michael Kaufmann (d00p) <d00p@froxlor.org>
This commit is contained in:
Michael Kaufmann (d00p)
2018-03-02 17:22:47 +01:00
parent 594512404f
commit cadb6618ec
18 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
admin_phpsettings.php
View File

@@ -30,7 +30,7 @@ if ($page == 'overview') {
if ($action == '') { if ($action == '') {
try { try {
$json_result = PhpSettings::getLocal($userinfo)->list(); $json_result = PhpSettings::getLocal($userinfo)->listing();
} catch (Exception $e) { } catch (Exception $e) {
dynamic_error($e->getMessage()); dynamic_error($e->getMessage());
} }
@@ -173,7 +173,7 @@ if ($page == 'overview') {
if ($action == '') { if ($action == '') {
try { try {
$json_result = FpmDaemons::getLocal($userinfo)->list(); $json_result = FpmDaemons::getLocal($userinfo)->listing();
} catch (Exception $e) { } catch (Exception $e) {
dynamic_error($e->getMessage()); dynamic_error($e->getMessage());
} }

2
lib/classes/api/commands/class.Admins.php
View File

@@ -25,7 +25,7 @@ class Admins extends ApiCommand implements ResourceEntity
* @throws Exception * @throws Exception
* @return array count|list * @return array count|list
*/ */
public function list() public function listing()
{ {
if ($this->isAdmin() && $this->getUserDetail('change_serversettings') == 1) { if ($this->isAdmin() && $this->getUserDetail('change_serversettings') == 1) {
$this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list admins"); $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list admins");

2
lib/classes/api/commands/class.Customers.php
View File

@@ -24,7 +24,7 @@ class Customers extends ApiCommand implements ResourceEntity
* @access admin * @access admin
* @return array count|list * @return array count|list
*/ */
public function list() public function listing()
{ {
if ($this->isAdmin()) { if ($this->isAdmin()) {
$this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list customers"); $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list customers");

2
lib/classes/api/commands/class.Domains.php
View File

@@ -25,7 +25,7 @@ class Domains extends ApiCommand implements ResourceEntity
* @throws Exception * @throws Exception
* @return array count|list * @return array count|list
*/ */
public function list() public function listing()
{ {
if ($this->isAdmin()) { if ($this->isAdmin()) {
$this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list domains"); $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list domains");

2
lib/classes/api/commands/class.FpmDaemons.php
View File

@@ -25,7 +25,7 @@ class FpmDaemons extends ApiCommand implements ResourceEntity
* @throws Exception * @throws Exception
* @return array count|list * @return array count|list
*/ */
public function list() public function listing()
{ {
if ($this->isAdmin()) { if ($this->isAdmin()) {
$this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list fpm-daemons"); $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list fpm-daemons");

6
lib/classes/api/commands/class.Ftps.php
View File

@@ -289,7 +289,7 @@ class Ftps extends ApiCommand implements ResourceEntity
if ($this->getUserDetail('customers_see_all') == false) { if ($this->getUserDetail('customers_see_all') == false) {
// if it's a reseller or an admin who cannot see all customers, we need to check // if it's a reseller or an admin who cannot see all customers, we need to check
// whether the database belongs to one of his customers // whether the database belongs to one of his customers
$json_result = Customers::getLocal($this->getUserData())->list(); $json_result = Customers::getLocal($this->getUserData())->listing();
$custom_list_result = json_decode($json_result, true)['data']['list']; $custom_list_result = json_decode($json_result, true)['data']['list'];
$customer_ids = array(); $customer_ids = array();
foreach ($custom_list_result as $customer) { foreach ($custom_list_result as $customer) {
@@ -453,7 +453,7 @@ class Ftps extends ApiCommand implements ResourceEntity
* @throws Exception * @throws Exception
* @return array count|list * @return array count|list
*/ */
public function list() public function listing()
{ {
if ($this->isAdmin()) { if ($this->isAdmin()) {
// if we're an admin, list all ftp-users of all the admins customers // if we're an admin, list all ftp-users of all the admins customers
@@ -470,7 +470,7 @@ class Ftps extends ApiCommand implements ResourceEntity
json_decode($json_result, true)['data'] json_decode($json_result, true)['data']
); );
} else { } else {
$json_result = Customers::getLocal($this->getUserData())->list(); $json_result = Customers::getLocal($this->getUserData())->listing();
$custom_list_result = json_decode($json_result, true)['data']['list']; $custom_list_result = json_decode($json_result, true)['data']['list'];
} }
$customer_ids = array(); $customer_ids = array();

2
lib/classes/api/commands/class.IpsAndPorts.php
View File

@@ -25,7 +25,7 @@ class IpsAndPorts extends ApiCommand implements ResourceEntity
* @throws Exception * @throws Exception
* @return array count|list * @return array count|list
*/ */
public function list() public function listing()
{ {
if ($this->isAdmin() && ($this->getUserDetail('change_serversettings') || ! empty($this->getUserDetail('ip')))) { if ($this->isAdmin() && ($this->getUserDetail('change_serversettings') || ! empty($this->getUserDetail('ip')))) {
$this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list ips and ports"); $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list ips and ports");

6
lib/classes/api/commands/class.Mysqls.php
View File

@@ -230,7 +230,7 @@ class Mysqls extends ApiCommand implements ResourceEntity
if ($this->getUserDetail('customers_see_all') != 1) { if ($this->getUserDetail('customers_see_all') != 1) {
// if it's a reseller or an admin who cannot see all customers, we need to check // if it's a reseller or an admin who cannot see all customers, we need to check
// whether the database belongs to one of his customers // whether the database belongs to one of his customers
$json_result = Customers::getLocal($this->getUserData())->list(); $json_result = Customers::getLocal($this->getUserData())->listing();
$custom_list_result = json_decode($json_result, true)['data']['list']; $custom_list_result = json_decode($json_result, true)['data']['list'];
$customer_ids = array(); $customer_ids = array();
foreach ($custom_list_result as $customer) { foreach ($custom_list_result as $customer) {
@@ -425,7 +425,7 @@ class Mysqls extends ApiCommand implements ResourceEntity
* @throws Exception * @throws Exception
* @return array count|list * @return array count|list
*/ */
public function list() public function listing()
{ {
$result = array(); $result = array();
$dbserver = $this->getParam('mysql_server', true, - 1); $dbserver = $this->getParam('mysql_server', true, - 1);
@@ -444,7 +444,7 @@ class Mysqls extends ApiCommand implements ResourceEntity
json_decode($json_result, true)['data'] json_decode($json_result, true)['data']
); );
} else { } else {
$json_result = Customers::getLocal($this->getUserData())->list(); $json_result = Customers::getLocal($this->getUserData())->listing();
$custom_list_result = json_decode($json_result, true)['data']['list']; $custom_list_result = json_decode($json_result, true)['data']['list'];
} }
$customer_ids = array(); $customer_ids = array();

2
lib/classes/api/commands/class.PhpSettings.php
View File

@@ -25,7 +25,7 @@ class PhpSettings extends ApiCommand implements ResourceEntity
* @throws Exception * @throws Exception
* @return array count|list * @return array count|list
*/ */
public function list() public function listing()
{ {
if ($this->isAdmin()) { if ($this->isAdmin()) {
$this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list php-configs"); $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list php-configs");

6
lib/classes/api/commands/class.SubDomains.php
View File

@@ -367,7 +367,7 @@ class SubDomains extends ApiCommand implements ResourceEntity
if ($this->getUserDetail('customers_see_all') != 1) { if ($this->getUserDetail('customers_see_all') != 1) {
// if it's a reseller or an admin who cannot see all customers, we need to check // if it's a reseller or an admin who cannot see all customers, we need to check
// whether the database belongs to one of his customers // whether the database belongs to one of his customers
$json_result = Customers::getLocal($this->getUserData())->list(); $json_result = Customers::getLocal($this->getUserData())->listing();
$custom_list_result = json_decode($json_result, true)['data']['list']; $custom_list_result = json_decode($json_result, true)['data']['list'];
$customer_ids = array(); $customer_ids = array();
foreach ($custom_list_result as $customer) { foreach ($custom_list_result as $customer) {
@@ -419,7 +419,7 @@ class SubDomains extends ApiCommand implements ResourceEntity
throw new Exception("Not available yet.", 501); throw new Exception("Not available yet.", 501);
} }
public function list() public function listing()
{ {
if ($this->isAdmin()) { if ($this->isAdmin()) {
// if we're an admin, list all databases of all the admins customers // if we're an admin, list all databases of all the admins customers
@@ -436,7 +436,7 @@ class SubDomains extends ApiCommand implements ResourceEntity
json_decode($json_result, true)['data'] json_decode($json_result, true)['data']
); );
} else { } else {
$json_result = Customers::getLocal($this->getUserData())->list(); $json_result = Customers::getLocal($this->getUserData())->listing();
$custom_list_result = json_decode($json_result, true)['data']['list']; $custom_list_result = json_decode($json_result, true)['data']['list'];
} }
$customer_ids = array(); $customer_ids = array();

2
lib/classes/api/interface.ResourceEntity.php
View File

@@ -18,7 +18,7 @@
interface ResourceEntity interface ResourceEntity
{ {
public function list(); public function listing();
public function get(); public function get();

4
phpdox.xml
View File

@@ -1,6 +1,6 @@
<phpdox xmlns="http://xml.phpdox.net/config"> <phpdox xmlns="http://xml.phpdox.net/config">
<project name="froxlor" source="api" workdir="build/phpdox"> <project name="froxlor" source="." workdir="build/phpdox">
<collector publiconly="false"> <collector publiconly="true">
<include mask="*.php" /> <include mask="*.php" />
</collector> </collector>

4
tests/Admins/AdminsTest.php
View File

@@ -77,7 +77,7 @@ class AdminsTest extends TestCase
{ {
global $admin_userdata; global $admin_userdata;
$json_result = Admins::getLocal($admin_userdata)->list(); $json_result = Admins::getLocal($admin_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(2, $result['count']); $this->assertEquals(2, $result['count']);
} }
@@ -114,7 +114,7 @@ class AdminsTest extends TestCase
$this->expectExceptionCode(403); $this->expectExceptionCode(403);
$this->expectExceptionMessage("Not allowed to execute given command."); $this->expectExceptionMessage("Not allowed to execute given command.");
Admins::getLocal($reseller_userdata)->list(); Admins::getLocal($reseller_userdata)->listing();
} }
public function testAdminAdminsUnlock() public function testAdminAdminsUnlock()

6
tests/Customers/CustomersTest.php
View File

@@ -88,7 +88,7 @@ class CustomersTest extends TestCase
{ {
global $admin_userdata; global $admin_userdata;
$json_result = Customers::getLocal($admin_userdata)->list(); $json_result = Customers::getLocal($admin_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(1, $result['count']); $this->assertEquals(1, $result['count']);
} }
@@ -105,7 +105,7 @@ class CustomersTest extends TestCase
))->get(); ))->get();
$reseller_userdata = json_decode($json_result, true)['data']; $reseller_userdata = json_decode($json_result, true)['data'];
$reseller_userdata['adminsession'] = 1; $reseller_userdata['adminsession'] = 1;
$json_result = Customers::getLocal($reseller_userdata)->list(); $json_result = Customers::getLocal($reseller_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(0, $result['count']); $this->assertEquals(0, $result['count']);
} }
@@ -125,7 +125,7 @@ class CustomersTest extends TestCase
$this->expectExceptionCode(403); $this->expectExceptionCode(403);
$this->expectExceptionMessage("Not allowed to execute given command."); $this->expectExceptionMessage("Not allowed to execute given command.");
$json_result = Customers::getLocal($customer_userdata)->list(); $json_result = Customers::getLocal($customer_userdata)->listing();
} }
/** /**

4
tests/Domains/DomainsTest.php
View File

@@ -31,7 +31,7 @@ class DomainsTest extends TestCase
public function testAdminDomainsList() public function testAdminDomainsList()
{ {
global $admin_userdata; global $admin_userdata;
$json_result = Domains::getLocal($admin_userdata)->list(); $json_result = Domains::getLocal($admin_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(1, $result['count']); $this->assertEquals(1, $result['count']);
$this->assertEquals('test.local', $result['list'][0]['domain']); $this->assertEquals('test.local', $result['list'][0]['domain']);
@@ -49,7 +49,7 @@ class DomainsTest extends TestCase
))->get(); ))->get();
$reseller_userdata = json_decode($json_result, true)['data']; $reseller_userdata = json_decode($json_result, true)['data'];
$reseller_userdata['adminsession'] = 1; $reseller_userdata['adminsession'] = 1;
$json_result = Domains::getLocal($reseller_userdata)->list(); $json_result = Domains::getLocal($reseller_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(0, $result['count']); $this->assertEquals(0, $result['count']);
} }

8
tests/Ftps/FtpsTest.php
View File

@@ -77,7 +77,7 @@ class FtpsTest extends TestCase
{ {
global $admin_userdata; global $admin_userdata;
$json_result = Ftps::getLocal($admin_userdata)->list(); $json_result = Ftps::getLocal($admin_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(1, $result['count']); $this->assertEquals(1, $result['count']);
} }
@@ -86,7 +86,7 @@ class FtpsTest extends TestCase
{ {
global $admin_userdata; global $admin_userdata;
$json_result = Ftps::getLocal($admin_userdata, array('loginname' => 'test1'))->list(); $json_result = Ftps::getLocal($admin_userdata, array('loginname' => 'test1'))->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(1, $result['count']); $this->assertEquals(1, $result['count']);
$this->assertEquals('test1', $result['list'][0]['username']); $this->assertEquals('test1', $result['list'][0]['username']);
@@ -101,7 +101,7 @@ class FtpsTest extends TestCase
))->get(); ))->get();
$reseller_userdata = json_decode($json_result, true)['data']; $reseller_userdata = json_decode($json_result, true)['data'];
$reseller_userdata['adminsession'] = 1; $reseller_userdata['adminsession'] = 1;
$json_result = Ftps::getLocal($reseller_userdata)->list(); $json_result = Ftps::getLocal($reseller_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(1, $result['count']); $this->assertEquals(1, $result['count']);
$this->assertEquals('test1', $result['list'][0]['username']); $this->assertEquals('test1', $result['list'][0]['username']);
@@ -115,7 +115,7 @@ class FtpsTest extends TestCase
'loginname' => 'test1' 'loginname' => 'test1'
))->get(); ))->get();
$customer_userdata = json_decode($json_result, true)['data']; $customer_userdata = json_decode($json_result, true)['data'];
$json_result = Ftps::getLocal($customer_userdata)->list(); $json_result = Ftps::getLocal($customer_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(1, $result['count']); $this->assertEquals(1, $result['count']);
$this->assertEquals('test1', $result['list'][0]['username']); $this->assertEquals('test1', $result['list'][0]['username']);

6
tests/IpsAndPorts/IpsAndPortsTest.php
View File

@@ -11,7 +11,7 @@ class IpsAndPortsTest extends TestCase
public function testAdminIpsAndPortsList() public function testAdminIpsAndPortsList()
{ {
global $admin_userdata; global $admin_userdata;
$json_result = IpsAndPorts::getLocal($admin_userdata)->list(); $json_result = IpsAndPorts::getLocal($admin_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(1, $result['count']); $this->assertEquals(1, $result['count']);
$this->assertEquals('82.149.225.46', $result['list'][0]['ip']); $this->assertEquals('82.149.225.46', $result['list'][0]['ip']);
@@ -29,7 +29,7 @@ class IpsAndPortsTest extends TestCase
$reseller_userdata['adminsession'] = 1; $reseller_userdata['adminsession'] = 1;
$this->expectExceptionCode(403); $this->expectExceptionCode(403);
$this->expectExceptionMessage("Not allowed to execute given command."); $this->expectExceptionMessage("Not allowed to execute given command.");
$json_result = IpsAndPorts::getLocal($reseller_userdata)->list(); $json_result = IpsAndPorts::getLocal($reseller_userdata)->listing();
} }
public function testAdminIpsAndPortsAdd() public function testAdminIpsAndPortsAdd()
@@ -91,7 +91,7 @@ class IpsAndPortsTest extends TestCase
))->update(); ))->update();
$reseller_userdata = json_decode($json_result, true)['data']; $reseller_userdata = json_decode($json_result, true)['data'];
$reseller_userdata['adminsession'] = 1; $reseller_userdata['adminsession'] = 1;
$json_result = IpsAndPorts::getLocal($reseller_userdata)->list(); $json_result = IpsAndPorts::getLocal($reseller_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(1, $result['count']); $this->assertEquals(1, $result['count']);
$this->assertEquals('82.149.225.47', $result['list'][0]['ip']); $this->assertEquals('82.149.225.47', $result['list'][0]['ip']);

6
tests/SubDomains/SubDomainsTest.php
View File

@@ -132,7 +132,7 @@ class SubDomainsTest extends TestCase
'loginname' => 'test1' 'loginname' => 'test1'
))->get(); ))->get();
$customer_userdata = json_decode($json_result, true)['data']; $customer_userdata = json_decode($json_result, true)['data'];
$json_result = SubDomains::getLocal($customer_userdata)->list(); $json_result = SubDomains::getLocal($customer_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(3, $result['count']); $this->assertEquals(3, $result['count']);
} }
@@ -146,7 +146,7 @@ class SubDomainsTest extends TestCase
))->get(); ))->get();
$reseller_userdata = json_decode($json_result, true)['data']; $reseller_userdata = json_decode($json_result, true)['data'];
$reseller_userdata['adminsession'] = 1; $reseller_userdata['adminsession'] = 1;
$json_result = SubDomains::getLocal($reseller_userdata)->list(); $json_result = SubDomains::getLocal($reseller_userdata)->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(3, $result['count']); $this->assertEquals(3, $result['count']);
} }
@@ -154,7 +154,7 @@ class SubDomainsTest extends TestCase
public function testAdminSubDomainsListWithCustomer() public function testAdminSubDomainsListWithCustomer()
{ {
global $admin_userdata; global $admin_userdata;
$json_result = SubDomains::getLocal($admin_userdata, ['loginname' => 'test1'])->list(); $json_result = SubDomains::getLocal($admin_userdata, ['loginname' => 'test1'])->listing();
$result = json_decode($json_result, true)['data']; $result = json_decode($json_result, true)['data'];
$this->assertEquals(3, $result['count']); $this->assertEquals(3, $result['count']);
} }