detain / cpanel-licensing

src/Cpanel.php

Spacing +31 added lines, -31 removed lines

@@ -7,26 +7,26 @@ 
 	public $curl;
 	public $opts;
 
-    public function __construct ($user, $pass) {
+    public function __construct($user, $pass) {
         if (!function_exists('curl_init')) {
             die("cPanelLicensing requires that curl+ssl support is compiled into the PHP interpreter");
         }
 		$this->opts = [];
         $this->format = "simplexml";
         $this->setCredentials($user, $pass);
-        $this->setopt(CURLOPT_RETURNTRANSFER,1);
-        $this->setopt(CURLOPT_USERAGENT, 'cPanel Licensing Agent (php) 3.5' );
+        $this->setopt(CURLOPT_RETURNTRANSFER, 1);
+        $this->setopt(CURLOPT_USERAGENT, 'cPanel Licensing Agent (php) 3.5');
     }
 
 	public function setopt($option, $value) {
 		$this->opts[$option] = $value;
 	}
 
-    public function setCredentials ($user, $pass) {
+    public function setCredentials($user, $pass) {
         $this->setopt(CURLOPT_USERPWD, $user . ":" . $pass);
     }
 
-    public function set_format ($format) {
+    public function set_format($format) {
         if ($format != "xml" && $format != "json" && $format != "yaml" && $format != "simplexml") {
             error_log("set_format requires that the format is xml, json, yaml or simplexml");
             return;
@@ -36,7 +36,7 @@ 
         }
     }
 
-    private function get ($function, $args = array()) {
+    private function get($function, $args = array()) {
         if (!$function) {
             error_log("cPanelLicensing::get requires that a function is defined");
             return;
@@ -83,7 +83,7 @@ 
 		return $result;
 	}
 
-    private function validateID ($id) {
+    private function validateID($id) {
         if (preg_match("/^(L|P|G)?\d*$/", $id)) {
             return 1;
         }
@@ -92,11 +92,11 @@ 
         }
     }
 
-    private function validateIP ($ip) {
+    private function validateIP($ip) {
         return preg_match("/^\d*\.\d*\.\d*\.\d*$/", $ip);
     }
 
-    public function reactivateLicense ($args) {
+    public function reactivateLicense($args) {
         if (!array_key_exists('liscid', $args)) {
             error_log("cpanelLicensing::reactivateLicense requires that the argument array contains element liscid");
             return;
@@ -108,7 +108,7 @@ 
         return $this->get("XMLlicenseReActivate.cgi", $args);
     }
 
-    public function expireLicense ($args) {
+    public function expireLicense($args) {
         if (!array_key_exists("liscid", $args)) {
             error_log("cPanelLicensing::expireLicense requires that liscid elements exists in the array passed to it");
             return;
@@ -120,7 +120,7 @@ 
         return $this->get("XMLlicenseExpire.cgi", $args);
     }
 
-    public function extendOnetimeUpdates ($args) {
+    public function extendOnetimeUpdates($args) {
         if (!array_key_exists("ip", $args)) {
             error_log("cpanelLicensing::extendOnetimeUpdates requires that the element ip exists in the array is passed to it");
             return;
@@ -129,10 +129,10 @@ 
             error_log("cpanelLicensing::extendOnetimeUpdates was passed an invalid ip");
             return;
         }
-        return $this->get( "XMLonetimeext.cgi", $args );
+        return $this->get("XMLonetimeext.cgi", $args);
     }
 
-    public function changeip ($args) {
+    public function changeip($args) {
         if (!array_key_exists("oldip", $args) || !array_key_exists("newip", $args)) {
             error_log("cpanelLicensing::changeip requires that oldip and newip elements exist in the array passed to it");
             return;
@@ -144,8 +144,8 @@ 
         return $this->get("XMLtransfer.cgi", $args);
     }
 
-    public function requestTransfer ($args) {
-        if (!array_key_exists("ip", $args) || !array_key_exists("groupid", $args ) || !array_key_exists("packagegroup", $args)) {
+    public function requestTransfer($args) {
+        if (!array_key_exists("ip", $args) || !array_key_exists("groupid", $args) || !array_key_exists("packagegroup", $args)) {
             error_log("cpanelLicensing::requestTransfer requires that ip, groupid and packageid elements exist in the array passed to it");
             return;
         }
@@ -153,7 +153,7 @@ 
             error_log("The groupid passed to cpanelLicensing::requestTransfer is invalid");
             return;
         }
-        if (!$this->validateID( $args["packageid"])) {
+        if (!$this->validateID($args["packageid"])) {
             error_log("The package id passed to cpanelLicensing::requestTransfer is invalid");
             return;
         }
@@ -164,7 +164,7 @@ 
         return $this->get("XMLtransferRequest.cgi", $args);
     }
 
-    public function activateLicense ($args) {
+    public function activateLicense($args) {
         if (!array_key_exists("ip", $args) || !array_key_exists("groupid", $args) || !array_key_exists("packageid", $args)) {
             error_log("cpanelLicensing::activateLicense requires that ip, groupid and packageid elements exist in the array passed to it");
             return;
@@ -185,7 +185,7 @@ 
         return $this->get("XMLlicenseAdd.cgi", $args);
     }
 
-    public function addPickupPass ($args) {
+    public function addPickupPass($args) {
         if (!array_key_exists("pickup", $args)) {
             error_log("cPanelLicensing::addPickupPass requires a pickup param");
             return;
@@ -193,7 +193,7 @@ 
         return $this->get("XMLaddPickupPass.cgi", $args);
     }
 
-    public function registerAuth ($args) {
+    public function registerAuth($args) {
         if (!array_key_exists("user", $args)) {
             error_log("cPanelLicensing::registerAuth requires a user param");
             return;
@@ -213,11 +213,11 @@ 
         return $response;
     }
 
-    public function fetchGroups () {
+    public function fetchGroups() {
         return $this->get("XMLgroupInfo.cgi");
     }
 
-    public function fetchLicenseRiskData ($args) {
+    public function fetchLicenseRiskData($args) {
         if (!array_key_exists("ip", $args)) {
             error_log("cpanelLicensing::fetchLicenseRiskData requires that ip exists as an element in the array is passed to it");
             return;
@@ -229,7 +229,7 @@ 
         return $this->get("XMLsecverify.cgi", $args);
     }
 
-    public function fetchLicenseRaw ($args) {
+    public function fetchLicenseRaw($args) {
         $args = array_merge(array("all" => 1), $args);
         if (!array_key_exists("ip", $args)) {
             error_log("cpanelLicesning::fetchLicenseRaw requires that ip exists as an element in the array is passed to it");
@@ -242,7 +242,7 @@ 
         return $this->get("XMLRawlookup.cgi", $args);
     }
 
-    public function fetchLicenseId ($args) {
+    public function fetchLicenseId($args) {
         $args = array_merge(array("all" => 1), $args);
         if (!array_key_exists('ip', $args)) {
             error_log("cpanelLicensing::getLicenseId requires that an IP is passed to it");
@@ -255,20 +255,20 @@ 
         return $this->get("XMLlookup.cgi", $args);
     }
 
-    public function fetchPackages () {
+    public function fetchPackages() {
         return $this->get("XMLpackageInfo.cgi");
     }
 
-    public function fetchLicenses () {
+    public function fetchLicenses() {
         return $this->get("XMLlicenseInfo.cgi");
     }
 
-    public function fetchExpiredLicenses () {
+    public function fetchExpiredLicenses() {
         return $this->get("XMLlicenseInfo.cgi", array("expired" => '1'));
     }
 
-    public function findKey ($search, $xml_obj) {
-        $xml_obj = (array) $xml_obj;
+    public function findKey($search, $xml_obj) {
+        $xml_obj = (array)$xml_obj;
         if (array_key_exists("packages", $xml_obj)) {
             $type = "packages";
         }
@@ -279,9 +279,9 @@ 
             error_log("cPanelLicensing::findKey with an object that is not groups or packages");
             return;
         }
-        foreach ((array) $xml_obj[$type] as $element) {
-            foreach ((array) $element as $key => $value) {
-                if ((string) $value == $search) {
+        foreach ((array)$xml_obj[$type] as $element) {
+            foreach ((array)$element as $key => $value) {
+                if ((string)$value == $search) {
                     return (string)$key;
                 }
             }

Braces +5 added lines, -10 removed lines

@@ -30,8 +30,7 @@ 
         if ($format != "xml" && $format != "json" && $format != "yaml" && $format != "simplexml") {
             error_log("set_format requires that the format is xml, json, yaml or simplexml");
             return;
-        }
-        else {
+        } else {
             $this->format = $format;
         }
     }
@@ -62,8 +61,7 @@ 
 			$result = $result[str_replace('.cgi', '', $function)];
 			$result = $this->format_result($result);			
 			return $result;
-        }
-        else {
+        } else {
             return $result;
         }
     }
@@ -86,8 +84,7 @@ 
     private function validateID ($id) {
         if (preg_match("/^(L|P|G)?\d*$/", $id)) {
             return 1;
-        }
-        else {
+        } else {
             return 0;
         }
     }
@@ -271,11 +268,9 @@ 
         $xml_obj = (array) $xml_obj;
         if (array_key_exists("packages", $xml_obj)) {
             $type = "packages";
-        }
-        else if (array_key_exists("groups", $xml_obj)) {
+        } else if (array_key_exists("groups", $xml_obj)) {
             $type = "groups";
-        }
-        else {
+        } else {
             error_log("cPanelLicensing::findKey with an object that is not groups or packages");
             return;
         }

bin/list_expired_licenses.php

Spacing +2 added lines, -2 removed lines

@@ -2,11 +2,11 @@
 
 include("../cpl.inc.php");
 
-$cpl = new \Detain\Cpanel\Cpanel($_SERVER['argv'][1],$_SERVER['argv'][2]);
+$cpl = new \Detain\Cpanel\Cpanel($_SERVER['argv'][1], $_SERVER['argv'][2]);
 
 $licenses = $cpl->fetchExpiredLicenses();
 
-foreach ( $licenses->licenses as $lisc ) {
+foreach ($licenses->licenses as $lisc) {
     $lisc = (array)$lisc;
     print "\nLicense IP: " . $lisc['@attributes']['ip'] . "\n";
     print "        ID: " . $lisc['@attributes']['name'] . "\n";

bin/reactivate_license.php

Spacing +3 added lines, -3 removed lines

@@ -4,12 +4,12 @@
 
 $ip = "__IP__";
 
-$lisc = (array)$cpl->fetchLicenseID( array("ip" => $ip) );
+$lisc = (array)$cpl->fetchLicenseID(array("ip" => $ip));
 
 $id = $lisc['@attributes']['licenseid'];
 
-if ( $id > 0 ) {
-    $result = (array)$cpl->reactivateLicense( array( 'liscid' => $id, reactivateok => 1 ) );
+if ($id > 0) {
+    $result = (array)$cpl->reactivateLicense(array('liscid' => $id, reactivateok => 1));
 } else {
     print "no expired license exists for $ip\n";
 }

bin/list_licenses.php

Spacing +1 added lines, -1 removed lines

@@ -3,7 +3,7 @@
 function_requirements('xml2array');
 include("../cpl.inc.php");
 
-$cpl = new \Detain\Cpanel\Cpanel($_SERVER['argv'][1],$_SERVER['argv'][2]);
+$cpl = new \Detain\Cpanel\Cpanel($_SERVER['argv'][1], $_SERVER['argv'][2]);
 
 $licenses = $cpl->fetchLicenses();
 print_r($licenses);

bin/lookup_license_id_by_ip.php

Spacing +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 include("../cpl.inc.php");
 $cpl = new \Detain\Cpanel\Cpanel($_SERVER['argv'][1], $_SERVER['argv'][2]);
 $ip = "__IP__";
-$lisc = (array) $cpl->fetchLicenseId(array("ip" => $ip));
+$lisc = (array)$cpl->fetchLicenseId(array("ip" => $ip));
 print_r($lisc);
 $id = $lisc['licenseid'];
 $id = is_array($id) ? $id[0] : $id;

bin/request_transfer.php

Spacing +3 added lines, -3 removed lines

@@ -4,10 +4,10 @@
 
 $ip = "__IP_TO_TRANSFER__";
 
-$group = $cpl->findKey("__GROUP_NAME__", $cpl->fetchGroups() );
-$package = $cpl->findKey("__PACKAGE_NAME__", $cpl->fetchPackages() );
+$group = $cpl->findKey("__GROUP_NAME__", $cpl->fetchGroups());
+$package = $cpl->findKey("__PACKAGE_NAME__", $cpl->fetchPackages());
 
-$result = (array)$cpl->requestTransfer( array(
+$result = (array)$cpl->requestTransfer(array(
     "ip" => $ip,
     "groupid" => $group,
     "packageid" => $package

bin/add_new_license.php

Spacing +4 added lines, -4 removed lines

@@ -2,12 +2,12 @@ 
 
 include("../cpl.inc.php");
 
-$cpl = new \Detain\Cpanel\Cpanel( $_SERVER['argv'][1], $_SERVER['argv'][2] );
+$cpl = new \Detain\Cpanel\Cpanel($_SERVER['argv'][1], $_SERVER['argv'][2]);
 
 $ip = "__IP__";
 
-$groupid = $cpl->findKey("__GROUPNAME__", $cpl->fetchGroups() );
-$packageid = $cpl->findKey("__PACKAGENAME__", $cpl->fetchPackages() );
+$groupid = $cpl->findKey("__GROUPNAME__", $cpl->fetchGroups());
+$packageid = $cpl->findKey("__PACKAGENAME__", $cpl->fetchPackages());
 
 $lisc = (array)$cpl->activateLicense(array(
         "ip" => $ip,
@@ -21,7 +21,7 @@ 
 );
 
 if ($lisc['@attributes']['status'] > 0) {
-    print "license added with id: ". $lisc['@attributes']['licenseid'] . "\n";
+    print "license added with id: " . $lisc['@attributes']['licenseid'] . "\n";
 } else {
     print "License add failed: " . $lisc['@attributes']['reason'] . "\n";
 }

bin/expire_license.php

Spacing +2 added lines, -2 removed lines

@@ -4,10 +4,10 @@
 
 $ip = "__IP__";
 
-$lisc = (array)$cpl->fetchLicenseId( array( "ip" => $ip ) );
+$lisc = (array)$cpl->fetchLicenseId(array("ip" => $ip));
 $liscid = $lisc["@attributes"]["licenseid"];
 
-if ( $liscid > 0 ) {
+if ($liscid > 0) {
     $expire = (array)$cpl->expireLicense(array(
         liscid => $liscid,
         reason => "Automagic Expiration",

tests/CpanelTest.php

Braces +22 added lines, -44 removed lines

@@ -2,8 +2,7 @@ 
 /**
  * Generated by PHPUnit_SkeletonGenerator on 2017-06-16 at 14:19:40.
  */
-class CpanelTest extends PHPUnit_Framework_TestCase
-{
+class CpanelTest extends PHPUnit_Framework_TestCase {
     /**
      * @var Cpanel
      */
@@ -13,8 +12,7 @@ 
      * Sets up the fixture, for example, opens a network connection.
      * This method is called before a test is executed.
      */
-    protected function setUp()
-    {
+    protected function setUp() {
         $this->object = new Cpanel;
     }
 
@@ -22,16 +20,14 @@ 
      * Tears down the fixture, for example, closes a network connection.
      * This method is called after a test is executed.
      */
-    protected function tearDown()
-    {
+    protected function tearDown() {
     }
 
     /**
      * @covers Detain\Cpanel\Cpanel::setopt
      * @todo   Implement testSetopt().
      */
-    public function testSetopt()
-    {
+    public function testSetopt() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -42,8 +38,7 @@ 
      * @covers Detain\Cpanel\Cpanel::setCredentials
      * @todo   Implement testSetCredentials().
      */
-    public function testSetCredentials()
-    {
+    public function testSetCredentials() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -54,8 +49,7 @@ 
      * @covers Detain\Cpanel\Cpanel::set_format
      * @todo   Implement testSet_format().
      */
-    public function testSet_format()
-    {
+    public function testSet_format() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -66,8 +60,7 @@ 
      * @covers Detain\Cpanel\Cpanel::reactivateLicense
      * @todo   Implement testReactivateLicense().
      */
-    public function testReactivateLicense()
-    {
+    public function testReactivateLicense() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -78,8 +71,7 @@ 
      * @covers Detain\Cpanel\Cpanel::expireLicense
      * @todo   Implement testExpireLicense().
      */
-    public function testExpireLicense()
-    {
+    public function testExpireLicense() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -90,8 +82,7 @@ 
      * @covers Detain\Cpanel\Cpanel::extendOnetimeUpdates
      * @todo   Implement testExtendOnetimeUpdates().
      */
-    public function testExtendOnetimeUpdates()
-    {
+    public function testExtendOnetimeUpdates() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -102,8 +93,7 @@ 
      * @covers Detain\Cpanel\Cpanel::changeip
      * @todo   Implement testChangeip().
      */
-    public function testChangeip()
-    {
+    public function testChangeip() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -114,8 +104,7 @@ 
      * @covers Detain\Cpanel\Cpanel::requestTransfer
      * @todo   Implement testRequestTransfer().
      */
-    public function testRequestTransfer()
-    {
+    public function testRequestTransfer() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -126,8 +115,7 @@ 
      * @covers Detain\Cpanel\Cpanel::activateLicense
      * @todo   Implement testActivateLicense().
      */
-    public function testActivateLicense()
-    {
+    public function testActivateLicense() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -138,8 +126,7 @@ 
      * @covers Detain\Cpanel\Cpanel::addPickupPass
      * @todo   Implement testAddPickupPass().
      */
-    public function testAddPickupPass()
-    {
+    public function testAddPickupPass() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -150,8 +137,7 @@ 
      * @covers Detain\Cpanel\Cpanel::registerAuth
      * @todo   Implement testRegisterAuth().
      */
-    public function testRegisterAuth()
-    {
+    public function testRegisterAuth() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -162,8 +148,7 @@ 
      * @covers Detain\Cpanel\Cpanel::fetchGroups
      * @todo   Implement testFetchGroups().
      */
-    public function testFetchGroups()
-    {
+    public function testFetchGroups() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -174,8 +159,7 @@ 
      * @covers Detain\Cpanel\Cpanel::fetchLicenseRiskData
      * @todo   Implement testFetchLicenseRiskData().
      */
-    public function testFetchLicenseRiskData()
-    {
+    public function testFetchLicenseRiskData() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -186,8 +170,7 @@ 
      * @covers Detain\Cpanel\Cpanel::fetchLicenseRaw
      * @todo   Implement testFetchLicenseRaw().
      */
-    public function testFetchLicenseRaw()
-    {
+    public function testFetchLicenseRaw() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -198,8 +181,7 @@ 
      * @covers Detain\Cpanel\Cpanel::fetchLicenseId
      * @todo   Implement testFetchLicenseId().
      */
-    public function testFetchLicenseId()
-    {
+    public function testFetchLicenseId() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -210,8 +192,7 @@ 
      * @covers Detain\Cpanel\Cpanel::fetchPackages
      * @todo   Implement testFetchPackages().
      */
-    public function testFetchPackages()
-    {
+    public function testFetchPackages() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -222,8 +203,7 @@ 
      * @covers Detain\Cpanel\Cpanel::fetchLicenses
      * @todo   Implement testFetchLicenses().
      */
-    public function testFetchLicenses()
-    {
+    public function testFetchLicenses() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -234,8 +214,7 @@ 
      * @covers Detain\Cpanel\Cpanel::fetchExpiredLicenses
      * @todo   Implement testFetchExpiredLicenses().
      */
-    public function testFetchExpiredLicenses()
-    {
+    public function testFetchExpiredLicenses() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'
@@ -246,8 +225,7 @@ 
      * @covers Detain\Cpanel\Cpanel::findKey
      * @todo   Implement testFindKey().
      */
-    public function testFindKey()
-    {
+    public function testFindKey() {
         // Remove the following lines when you implement this test.
         $this->markTestIncomplete(
             'This test has not been implemented yet.'