Merge pull request #88 from bobbrodie/5.0.x

PHPCS Updates
bitpay · Jun 19, 2024 · 2c3f76e · 2c3f76e
2 parents 7ca584b + d345efe
commit 2c3f76e
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 36 deletions.
diff --git a/modules/gateways/bitpaycheckout.php b/modules/gateways/bitpaycheckout.php
@@ -19,8 +19,11 @@
     die("This file cannot be accessed directly");
 }
 
-include_once(__DIR__ . DIRECTORY_SEPARATOR . 'bitpaycheckout' . DIRECTORY_SEPARATOR .  'vendor' . DIRECTORY_SEPARATOR . 'autoload.php');
-use BitPaySDK\PosClient;
+include_once(__DIR__ . DIRECTORY_SEPARATOR . 'bitpaycheckout'
+                     . DIRECTORY_SEPARATOR .  'vendor'
+                     . DIRECTORY_SEPARATOR . 'autoload.php');
+
+                     use BitPaySDK\PosClient;
 use BitPaySDK\Model\Invoice\Invoice;
 use BitPaySDK\Model\Invoice\Buyer;
 use BitPaySDK\Model\Facade;
@@ -80,8 +83,7 @@ function ($table) {
  * @return array
  */
 
-if (!function_exists('bitpaycheckout_config'))
-{
+if (!function_exists('bitpaycheckout_config')) {
     function bitpaycheckout_config()
     {
         return array(
@@ -97,6 +99,7 @@ function bitpaycheckout_config()
                 'Type' => 'text',
                 'Size' => '25',
                 'Default' => '',
+                // @phpcs:ignore Generic.Files.LineLength.TooLong
                 'Description' => 'Your <b>development</b> merchant token.  <a href = "https://test.bitpay.com/dashboard/merchant/api-tokens" target = "_blank">Create one here</a> and <b>uncheck</b> `Require Authentication`.',
             ),
             // a text field type allows for single line text input
@@ -105,21 +108,24 @@ function bitpaycheckout_config()
                 'Type' => 'text',
                 'Size' => '25',
                 'Default' => '',
+                // @phpcs:ignore Generic.Files.LineLength.TooLong
                 'Description' => 'Your <b>production</b> merchant token.  <a href = "https://bitpay.com/dashboard/merchant/api-tokens" target = "_blank">Create one here</a> and <b>uncheck</b> `Require Authentication`.',
             ),
 
                 'bitpay_checkout_endpoint' => array(
                 'FriendlyName' => 'Endpoint',
                 'Type' => 'dropdown',
                 'Options' => 'Test,Production',
+                // @phpcs:ignore Generic.Files.LineLength.TooLong
                 'Description' => 'Select <b>Test</b> for testing the plugin, <b>Production</b> when you are ready to go live.<br>',
             ),
             'bitpay_checkout_mode' => array(
                 'FriendlyName' => 'Payment UX',
                 'Type' => 'dropdown',
                 'Options' => 'Modal,Redirect',
+                // @phpcs:ignore Generic.Files.LineLength.TooLong
                 'Description' => 'Select <b>Modal</b> to keep the user on the invoice page, or  <b>Redirect</b> to have them view the invoice at BitPay.com, and be redirected after payment.<br>',
-            ),            
+            ),
         );
     }
 }
@@ -137,7 +143,9 @@ function bitpaycheckout_link($config_params)
     $curpage = basename($_SERVER["SCRIPT_FILENAME"]);
 
     $curpage = str_replace("/", "", $curpage);
-    if ($curpage != 'viewinvoice.php'): return;endif;
+    if ($curpage != 'viewinvoice.php') {
+        return;
+    }
     ?>
     <script src="https://bitpay.com/bitpay.min.js" type="text/javascript"></script>
     <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
@@ -146,7 +154,7 @@ function bitpaycheckout_link($config_params)
 
     $client = new PosClient($bitpay_checkout_token, $bitpay_checkout_endpoint);
 
-    #check to make sure we don't already have a valid BitPay Invoice active
+    // Check to make sure we don't already have a valid BitPay Invoice active
     $checkDup = Capsule::table('_bitpay_checkout_transactions')
         ->select('transaction_id')
         ->where('order_id', '=', $config_params['invoiceid'])
@@ -178,7 +186,7 @@ function bitpaycheckout_link($config_params)
         $moduleDisplayName = $config_params['name'];
         $moduleName = $config_params['paymentmethod'];
 
-        #BITPAY INVOICE DETAILS
+        // BITPAY INVOICE DETAILS
         $params = new stdClass();
 
         $dir = dirname($_SERVER['REQUEST_URI']);
@@ -187,13 +195,17 @@ function bitpaycheckout_link($config_params)
         }
 
         $params->orderId = trim($invoiceId);
-        $params->notificationURL = $protocol . $_SERVER['SERVER_NAME'] . $dir . '/modules/gateways/bitpaycheckout/callback/bitpaycheckout_ipn.php';
+        // @phpcs:ignore Generic.Files.LineLength.TooLong
+        $params->notificationURL = $protocol . $_SERVER['SERVER_NAME']. $dir . '/modules/gateways/bitpaycheckout/callback/bitpaycheckout_ipn.php';
+        // @phpcs:ignore Generic.Files.LineLength.TooLong
         $params->redirectURL = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on' ? "https" : "http") . "://$_SERVER[HTTP_HOST]$_SERVER[REQUEST_URI]";
         $params->fullNotifications = true;
 
         $protocol = 'https://';
 
+        // @phpcs:ignore Generic.Files.LineLength.TooLong
         $notificationURL = $protocol . $_SERVER['SERVER_NAME'] . $dir . '/modules/gateways/bitpaycheckout/callback/bitpaycheckout_ipn.php';
+        // @phpcs:ignore Generic.Files.LineLength.TooLong
         $redirectURL = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on' ? "https" : "http") . "://$_SERVER[HTTP_HOST]$_SERVER[REQUEST_URI]";
 
         $invoice = new Invoice($amount, $currencyCode);
@@ -230,6 +242,7 @@ function bitpaycheckout_link($config_params)
 
         try {
             $statement = $pdo->prepare(
+                // @phpcs:ignore Generic.Files.LineLength.TooLong
                 'insert into _bitpay_checkout_transactions (order_id, transaction_id, transaction_status,created_at) values (:order_id, :transaction_id, :transaction_status,:created_at)'
             );
 
@@ -249,8 +262,10 @@ function bitpaycheckout_link($config_params)
     }
 
     if ($bitpay_checkout_mode == 'Modal') {
+        // @phpcs:ignore Generic.Files.LineLength.TooLong
         $htmlOutput .= '<button name = "bitpay-payment" class = "btn btn-success btn-sm" onclick = "showModal(\'' . $basicInvoice->getId() . '\');return false;">' . $config_params['langpaynow'] . '</button>';
     } else {
+        // @phpcs:ignore Generic.Files.LineLength.TooLong
         $htmlOutput .= '<button name = "bitpay-payment" class = "btn btn-success btn-sm" onclick = "redirectURL(\'' . $basicInvoice->getUrl(). '\');return false;">' . $config_params['langpaynow'] . '</button>';
     }
     ?>
@@ -272,8 +287,8 @@ function redirectURL($url){
             }
         }, false);
         function showModal(){
-            //show the modal
-            <?php if ($bitpay_checkout_endpoint == 'Test'): ?>
+            // Show the modal
+            <?php if ($bitpay_checkout_endpoint == 'Test') : ?>
                 bitpay.enableTestMode()
             <?php endif;?>
                 bitpay.showInvoice('<?php echo $basicInvoice->getId(); ?>');

diff --git a/modules/gateways/bitpaycheckout/callback/bitpaycheckout_ipn.php b/modules/gateways/bitpaycheckout/callback/bitpaycheckout_ipn.php
@@ -19,19 +19,22 @@
  */
 
 use WHMCS\Database\Capsule;
+
 // Require libraries needed for gateway module functions.
 require_once  '../../../../init.php';
-require_once  '../../../../includes/gatewayfunctions.php';
-require_once  '../../../../includes/invoicefunctions.php';
+require_once ROOTDIR . "/includes/gatewayfunctions.php";
+require_once ROOTDIR . "/includes/invoicefunctions.php";
 
 // Detect module name from filename.
 $gatewayModuleName = 'bitpaycheckout';
+
 // Fetch gateway configuration parameters.
 $gatewayParams = getGatewayVariables($gatewayModuleName);
 define("TEST_URL", 'https://test.bitpay.com/invoices/');
 define("PROD_URL", 'https://bitpay.com/invoices/');
 
-function checkInvoiceStatus($url) {
+function checkInvoiceStatus($url)
+{
     $ch = curl_init();
     curl_setopt($ch, CURLOPT_URL, $url);
     curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
@@ -47,10 +50,10 @@ function checkInvoiceStatus($url) {
 $file = 'bitpay.txt';
 $err = "bitpay_err.txt";
 
-file_put_contents($file,"===========INCOMING IPN=========================",FILE_APPEND);
-file_put_contents($file,date('d.m.Y H:i:s'),FILE_APPEND);
-file_put_contents($file,print_r($response, true),FILE_APPEND);
-file_put_contents($file,"===========END OF IPN===========================",FILE_APPEND);
+file_put_contents($file, "===========INCOMING IPN=========================", FILE_APPEND);
+file_put_contents($file, date('d.m.Y H:i:s'), FILE_APPEND);
+file_put_contents($file, print_r($response, true), FILE_APPEND);
+file_put_contents($file, "===========END OF IPN===========================", FILE_APPEND);
 
 $order_status = $data['status'];
 $order_invoice = $data['id'];
@@ -94,16 +97,16 @@ function checkInvoiceStatus($url) {
                         ['transaction_id', '=', $order_invoice],
                     ])
                     ->update($update);
-            } catch (Exception $e ) {
-                file_put_contents($file,$e,FILE_APPEND);
+            } catch (Exception $e) {
+                file_put_contents($file, $e, FILE_APPEND);
             }
 
             addInvoicePayment(
-            $orderid,
-            $order_invoice,
-            $price,
-            0,
-            'bitpaycheckout'
+                $orderid,
+                $order_invoice,
+                $price,
+                0,
+                'bitpaycheckout'
             );
             break;
 
@@ -119,8 +122,8 @@ function checkInvoiceStatus($url) {
                         ['paymentmethod', '=', 'bitpaycheckout'],
                     ])
                     ->update($update);
-            } catch (Exception $e ) {
-                file_put_contents($file,$e,FILE_APPEND);
+            } catch (Exception $e) {
+                file_put_contents($file, $e, FILE_APPEND);
             }
 
             #update the bitpay_invoice table
@@ -133,8 +136,8 @@ function checkInvoiceStatus($url) {
                         ['transaction_id', '=', $order_invoice],
                     ])
                     ->update($update);
-            } catch (Exception $e ) {
-                file_put_contents($file,$e,FILE_APPEND);
+            } catch (Exception $e) {
+                file_put_contents($file, $e, FILE_APPEND);
             }
             break;
 
@@ -146,8 +149,8 @@ function checkInvoiceStatus($url) {
                 Capsule::table($table)
                     ->where('transaction_id', '=', $order_invoice)
                     ->delete();
-            } catch (Exception $e ) {
-                file_put_contents($file,$e,FILE_APPEND);
+            } catch (Exception $e) {
+                file_put_contents($file, $e, FILE_APPEND);
             }
             break;
 
@@ -164,8 +167,8 @@ function checkInvoiceStatus($url) {
                             ['paymentmethod', '=', 'bitpaycheckout'],
                         ])
                         ->update($update);
-                } catch (Exception $e ) {
-                    file_put_contents($file,$e,FILE_APPEND);
+                } catch (Exception $e) {
+                    file_put_contents($file, $e, FILE_APPEND);
                 }
 
                 #update the bitpay invoice table
@@ -178,11 +181,12 @@ function checkInvoiceStatus($url) {
                             ['transaction_id', '=', $order_invoice],
                         ])
                         ->update($update);
-                } catch (Exception $e ) {
-                    file_put_contents($file,$e,FILE_APPEND);
+                } catch (Exception $e) {
+                    file_put_contents($file, $e, FILE_APPEND);
                 }
                 break;
             }
     }
-http_response_code(200);
+
+    http_response_code(200);
 }
diff --git a/phpcbf.phar b/phpcbf.phar
diff --git a/phpcs.phar b/phpcs.phar
diff --git a/phpcs.xml b/phpcs.xml
@@ -12,4 +12,8 @@
     <file>modules/</file>
     <exclude-pattern>*/vendor/*</exclude-pattern>
 
+    <rule ref="PSR1.Files.SideEffects">
+        <exclude name="PSR1.Files.SideEffects"/>
+    </rule>
+
 </ruleset>