From cadb6618ec2b8da2f2a194090e3aa9588defa1c4 Mon Sep 17 00:00:00 2001 From: "Michael Kaufmann (d00p)" Date: Fri, 2 Mar 2018 17:22:47 +0100 Subject: [PATCH] list() is a reserved php keyword, changed ApiCommand::list() to ApiCommand::listing() Signed-off-by: Michael Kaufmann (d00p) --- admin_phpsettings.php | 4 ++-- lib/classes/api/commands/class.Admins.php | 2 +- lib/classes/api/commands/class.Customers.php | 2 +- lib/classes/api/commands/class.Domains.php | 2 +- lib/classes/api/commands/class.FpmDaemons.php | 2 +- lib/classes/api/commands/class.Ftps.php | 6 +++--- lib/classes/api/commands/class.IpsAndPorts.php | 2 +- lib/classes/api/commands/class.Mysqls.php | 6 +++--- lib/classes/api/commands/class.PhpSettings.php | 2 +- lib/classes/api/commands/class.SubDomains.php | 6 +++--- lib/classes/api/interface.ResourceEntity.php | 2 +- phpdox.xml | 4 ++-- tests/Admins/AdminsTest.php | 4 ++-- tests/Customers/CustomersTest.php | 6 +++--- tests/Domains/DomainsTest.php | 4 ++-- tests/Ftps/FtpsTest.php | 8 ++++---- tests/IpsAndPorts/IpsAndPortsTest.php | 6 +++--- tests/SubDomains/SubDomainsTest.php | 6 +++--- 18 files changed, 37 insertions(+), 37 deletions(-) diff --git a/admin_phpsettings.php b/admin_phpsettings.php index 6eee297a..6192fb42 100644 --- a/admin_phpsettings.php +++ b/admin_phpsettings.php @@ -30,7 +30,7 @@ if ($page == 'overview') { if ($action == '') { try { - $json_result = PhpSettings::getLocal($userinfo)->list(); + $json_result = PhpSettings::getLocal($userinfo)->listing(); } catch (Exception $e) { dynamic_error($e->getMessage()); } @@ -173,7 +173,7 @@ if ($page == 'overview') { if ($action == '') { try { - $json_result = FpmDaemons::getLocal($userinfo)->list(); + $json_result = FpmDaemons::getLocal($userinfo)->listing(); } catch (Exception $e) { dynamic_error($e->getMessage()); } diff --git a/lib/classes/api/commands/class.Admins.php b/lib/classes/api/commands/class.Admins.php index 11361603..6a6b8300 100644 --- a/lib/classes/api/commands/class.Admins.php +++ b/lib/classes/api/commands/class.Admins.php @@ -25,7 +25,7 @@ class Admins extends ApiCommand implements ResourceEntity * @throws Exception * @return array count|list */ - public function list() + public function listing() { if ($this->isAdmin() && $this->getUserDetail('change_serversettings') == 1) { $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list admins"); diff --git a/lib/classes/api/commands/class.Customers.php b/lib/classes/api/commands/class.Customers.php index d2a102af..4191a835 100644 --- a/lib/classes/api/commands/class.Customers.php +++ b/lib/classes/api/commands/class.Customers.php @@ -24,7 +24,7 @@ class Customers extends ApiCommand implements ResourceEntity * @access admin * @return array count|list */ - public function list() + public function listing() { if ($this->isAdmin()) { $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list customers"); diff --git a/lib/classes/api/commands/class.Domains.php b/lib/classes/api/commands/class.Domains.php index 89596c96..3ea17c58 100644 --- a/lib/classes/api/commands/class.Domains.php +++ b/lib/classes/api/commands/class.Domains.php @@ -25,7 +25,7 @@ class Domains extends ApiCommand implements ResourceEntity * @throws Exception * @return array count|list */ - public function list() + public function listing() { if ($this->isAdmin()) { $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list domains"); diff --git a/lib/classes/api/commands/class.FpmDaemons.php b/lib/classes/api/commands/class.FpmDaemons.php index fd7b30fa..cd04990d 100644 --- a/lib/classes/api/commands/class.FpmDaemons.php +++ b/lib/classes/api/commands/class.FpmDaemons.php @@ -25,7 +25,7 @@ class FpmDaemons extends ApiCommand implements ResourceEntity * @throws Exception * @return array count|list */ - public function list() + public function listing() { if ($this->isAdmin()) { $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list fpm-daemons"); diff --git a/lib/classes/api/commands/class.Ftps.php b/lib/classes/api/commands/class.Ftps.php index 42cf0705..f2909440 100644 --- a/lib/classes/api/commands/class.Ftps.php +++ b/lib/classes/api/commands/class.Ftps.php @@ -289,7 +289,7 @@ class Ftps extends ApiCommand implements ResourceEntity if ($this->getUserDetail('customers_see_all') == false) { // 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 - $json_result = Customers::getLocal($this->getUserData())->list(); + $json_result = Customers::getLocal($this->getUserData())->listing(); $custom_list_result = json_decode($json_result, true)['data']['list']; $customer_ids = array(); foreach ($custom_list_result as $customer) { @@ -453,7 +453,7 @@ class Ftps extends ApiCommand implements ResourceEntity * @throws Exception * @return array count|list */ - public function list() + public function listing() { if ($this->isAdmin()) { // 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'] ); } 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']; } $customer_ids = array(); diff --git a/lib/classes/api/commands/class.IpsAndPorts.php b/lib/classes/api/commands/class.IpsAndPorts.php index 81976d39..f02ded1c 100644 --- a/lib/classes/api/commands/class.IpsAndPorts.php +++ b/lib/classes/api/commands/class.IpsAndPorts.php @@ -25,7 +25,7 @@ class IpsAndPorts extends ApiCommand implements ResourceEntity * @throws Exception * @return array count|list */ - public function list() + public function listing() { if ($this->isAdmin() && ($this->getUserDetail('change_serversettings') || ! empty($this->getUserDetail('ip')))) { $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list ips and ports"); diff --git a/lib/classes/api/commands/class.Mysqls.php b/lib/classes/api/commands/class.Mysqls.php index 8022562d..f783b34d 100644 --- a/lib/classes/api/commands/class.Mysqls.php +++ b/lib/classes/api/commands/class.Mysqls.php @@ -230,7 +230,7 @@ class Mysqls extends ApiCommand implements ResourceEntity if ($this->getUserDetail('customers_see_all') != 1) { // 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 - $json_result = Customers::getLocal($this->getUserData())->list(); + $json_result = Customers::getLocal($this->getUserData())->listing(); $custom_list_result = json_decode($json_result, true)['data']['list']; $customer_ids = array(); foreach ($custom_list_result as $customer) { @@ -425,7 +425,7 @@ class Mysqls extends ApiCommand implements ResourceEntity * @throws Exception * @return array count|list */ - public function list() + public function listing() { $result = array(); $dbserver = $this->getParam('mysql_server', true, - 1); @@ -444,7 +444,7 @@ class Mysqls extends ApiCommand implements ResourceEntity json_decode($json_result, true)['data'] ); } 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']; } $customer_ids = array(); diff --git a/lib/classes/api/commands/class.PhpSettings.php b/lib/classes/api/commands/class.PhpSettings.php index 6d26a560..cc930714 100644 --- a/lib/classes/api/commands/class.PhpSettings.php +++ b/lib/classes/api/commands/class.PhpSettings.php @@ -25,7 +25,7 @@ class PhpSettings extends ApiCommand implements ResourceEntity * @throws Exception * @return array count|list */ - public function list() + public function listing() { if ($this->isAdmin()) { $this->logger()->logAction(ADM_ACTION, LOG_NOTICE, "[API] list php-configs"); diff --git a/lib/classes/api/commands/class.SubDomains.php b/lib/classes/api/commands/class.SubDomains.php index e5dcbd71..eb1ea0d7 100644 --- a/lib/classes/api/commands/class.SubDomains.php +++ b/lib/classes/api/commands/class.SubDomains.php @@ -367,7 +367,7 @@ class SubDomains extends ApiCommand implements ResourceEntity if ($this->getUserDetail('customers_see_all') != 1) { // 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 - $json_result = Customers::getLocal($this->getUserData())->list(); + $json_result = Customers::getLocal($this->getUserData())->listing(); $custom_list_result = json_decode($json_result, true)['data']['list']; $customer_ids = array(); foreach ($custom_list_result as $customer) { @@ -419,7 +419,7 @@ class SubDomains extends ApiCommand implements ResourceEntity throw new Exception("Not available yet.", 501); } - public function list() + public function listing() { if ($this->isAdmin()) { // 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'] ); } 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']; } $customer_ids = array(); diff --git a/lib/classes/api/interface.ResourceEntity.php b/lib/classes/api/interface.ResourceEntity.php index b10713a8..59d6c398 100644 --- a/lib/classes/api/interface.ResourceEntity.php +++ b/lib/classes/api/interface.ResourceEntity.php @@ -18,7 +18,7 @@ interface ResourceEntity { - public function list(); + public function listing(); public function get(); diff --git a/phpdox.xml b/phpdox.xml index 813dbd4a..a090c9ec 100644 --- a/phpdox.xml +++ b/phpdox.xml @@ -1,6 +1,6 @@ - - + + diff --git a/tests/Admins/AdminsTest.php b/tests/Admins/AdminsTest.php index 15c81e3c..c6a63308 100644 --- a/tests/Admins/AdminsTest.php +++ b/tests/Admins/AdminsTest.php @@ -77,7 +77,7 @@ class AdminsTest extends TestCase { global $admin_userdata; - $json_result = Admins::getLocal($admin_userdata)->list(); + $json_result = Admins::getLocal($admin_userdata)->listing(); $result = json_decode($json_result, true)['data']; $this->assertEquals(2, $result['count']); } @@ -114,7 +114,7 @@ class AdminsTest extends TestCase $this->expectExceptionCode(403); $this->expectExceptionMessage("Not allowed to execute given command."); - Admins::getLocal($reseller_userdata)->list(); + Admins::getLocal($reseller_userdata)->listing(); } public function testAdminAdminsUnlock() diff --git a/tests/Customers/CustomersTest.php b/tests/Customers/CustomersTest.php index b87145d1..3d7592c6 100644 --- a/tests/Customers/CustomersTest.php +++ b/tests/Customers/CustomersTest.php @@ -88,7 +88,7 @@ class CustomersTest extends TestCase { global $admin_userdata; - $json_result = Customers::getLocal($admin_userdata)->list(); + $json_result = Customers::getLocal($admin_userdata)->listing(); $result = json_decode($json_result, true)['data']; $this->assertEquals(1, $result['count']); } @@ -105,7 +105,7 @@ class CustomersTest extends TestCase ))->get(); $reseller_userdata = json_decode($json_result, true)['data']; $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']; $this->assertEquals(0, $result['count']); } @@ -125,7 +125,7 @@ class CustomersTest extends TestCase $this->expectExceptionCode(403); $this->expectExceptionMessage("Not allowed to execute given command."); - $json_result = Customers::getLocal($customer_userdata)->list(); + $json_result = Customers::getLocal($customer_userdata)->listing(); } /** diff --git a/tests/Domains/DomainsTest.php b/tests/Domains/DomainsTest.php index 8cc00c4b..ffdaf42f 100644 --- a/tests/Domains/DomainsTest.php +++ b/tests/Domains/DomainsTest.php @@ -31,7 +31,7 @@ class DomainsTest extends TestCase public function testAdminDomainsList() { global $admin_userdata; - $json_result = Domains::getLocal($admin_userdata)->list(); + $json_result = Domains::getLocal($admin_userdata)->listing(); $result = json_decode($json_result, true)['data']; $this->assertEquals(1, $result['count']); $this->assertEquals('test.local', $result['list'][0]['domain']); @@ -49,7 +49,7 @@ class DomainsTest extends TestCase ))->get(); $reseller_userdata = json_decode($json_result, true)['data']; $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']; $this->assertEquals(0, $result['count']); } diff --git a/tests/Ftps/FtpsTest.php b/tests/Ftps/FtpsTest.php index d9d185a3..f4dc2ed2 100644 --- a/tests/Ftps/FtpsTest.php +++ b/tests/Ftps/FtpsTest.php @@ -77,7 +77,7 @@ class FtpsTest extends TestCase { global $admin_userdata; - $json_result = Ftps::getLocal($admin_userdata)->list(); + $json_result = Ftps::getLocal($admin_userdata)->listing(); $result = json_decode($json_result, true)['data']; $this->assertEquals(1, $result['count']); } @@ -86,7 +86,7 @@ class FtpsTest extends TestCase { 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']; $this->assertEquals(1, $result['count']); $this->assertEquals('test1', $result['list'][0]['username']); @@ -101,7 +101,7 @@ class FtpsTest extends TestCase ))->get(); $reseller_userdata = json_decode($json_result, true)['data']; $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']; $this->assertEquals(1, $result['count']); $this->assertEquals('test1', $result['list'][0]['username']); @@ -115,7 +115,7 @@ class FtpsTest extends TestCase 'loginname' => 'test1' ))->get(); $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']; $this->assertEquals(1, $result['count']); $this->assertEquals('test1', $result['list'][0]['username']); diff --git a/tests/IpsAndPorts/IpsAndPortsTest.php b/tests/IpsAndPorts/IpsAndPortsTest.php index 95590a17..9b3ec579 100644 --- a/tests/IpsAndPorts/IpsAndPortsTest.php +++ b/tests/IpsAndPorts/IpsAndPortsTest.php @@ -11,7 +11,7 @@ class IpsAndPortsTest extends TestCase public function testAdminIpsAndPortsList() { global $admin_userdata; - $json_result = IpsAndPorts::getLocal($admin_userdata)->list(); + $json_result = IpsAndPorts::getLocal($admin_userdata)->listing(); $result = json_decode($json_result, true)['data']; $this->assertEquals(1, $result['count']); $this->assertEquals('82.149.225.46', $result['list'][0]['ip']); @@ -29,7 +29,7 @@ class IpsAndPortsTest extends TestCase $reseller_userdata['adminsession'] = 1; $this->expectExceptionCode(403); $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() @@ -91,7 +91,7 @@ class IpsAndPortsTest extends TestCase ))->update(); $reseller_userdata = json_decode($json_result, true)['data']; $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']; $this->assertEquals(1, $result['count']); $this->assertEquals('82.149.225.47', $result['list'][0]['ip']); diff --git a/tests/SubDomains/SubDomainsTest.php b/tests/SubDomains/SubDomainsTest.php index 26e0a542..1e77e43a 100644 --- a/tests/SubDomains/SubDomainsTest.php +++ b/tests/SubDomains/SubDomainsTest.php @@ -132,7 +132,7 @@ class SubDomainsTest extends TestCase 'loginname' => 'test1' ))->get(); $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']; $this->assertEquals(3, $result['count']); } @@ -146,7 +146,7 @@ class SubDomainsTest extends TestCase ))->get(); $reseller_userdata = json_decode($json_result, true)['data']; $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']; $this->assertEquals(3, $result['count']); } @@ -154,7 +154,7 @@ class SubDomainsTest extends TestCase public function testAdminSubDomainsListWithCustomer() { 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']; $this->assertEquals(3, $result['count']); }