refactoring for v1.0

Author: mostafa6765

src/Sslcommerz.php

@@ -4,24 +4,36 @@
 
 use GuzzleHttp\Client;
 
-class Sslcommerz{
+/**
+ * Sslcommerz class
+ * @author code4mk <[email protected]>
+ * @version 1.0.0
+ */
+
+class Sslcommerz
+{
 
     private $amount;
     private $tnx;
-    private $airTicket = [];
-    private $emi = false;
     private $sslHost;
 
     private $customerData = [
         'cus_name'     => 'kamal',
         'cus_email'    => '[email protected]',
-        'cus_phone'    => '01000000000',
+        'cus_phone'    => '00000000000',
         'cus_add1'     => 'dhaka',
         'cus_city'     => 'Dhaka',
         'cus_postcode' => '1210',
         'cus_country'  => 'Bangladesh',
     ];
 
+    private $emi = [
+      'emi_option' => 0,
+      'emi_max_inst_option' => 3,
+      'emi_selected_inst' => 2,
+      'emi_allow_only' => 0,
+    ];
+
     public function __construct()
     {
         if (config('sslcommerz.sandbox_mode') === 'sandbox') {
@@ -32,33 +44,68 @@ public function __construct()
 
     }
 
+    /**
+     * Set transaction id.
+     *
+     * @param int|string $id
+     * @author code4mk <[email protected]>
+     * @since v1.0.0
+     * @version 1.0.0
+     */
     public function tnx($id)
     {
         $this->tnx = $id;
         return $this;
     }
 
+    /**
+     * Set amount.
+     *
+     * @param int|float $amount
+     * @author code4mk <[email protected]>
+     * @since v1.0.0
+     * @version 1.0.0
+     */
     public function amount($amount)
     {
         $this->amount = $amount;
         return $this;
     }
 
-    public function airlineTickets($data)
-    {
-        array_push($this->airTicket,$data);
-        return $this;
-
-    }
 
-    public function emi($month,$selectedMonth)
+    /**
+     * Set emi option.
+     *
+     * @param int $max_inst emi_max_inst_option
+     * @param int $selected_inst emi_selected_inst
+     * @param int $allow_only emi_allow_only(0,1)*
+     * @author code4mk <[email protected]>
+     * @since v1.0.0
+     * @version 1.0.0
+     */
+    public function emi($max_inst = '',$selected_inst = '',$allow_only = '')
     {
-        $this->emi = true;
-        $this->month = $month;
-        $this->selectedMonth = $selectedMonth;
+        $this->emi['emi_option'] = 1;
+        $this->emi['emi_max_inst_option'] = $max_inst == '' ? 3 : $max_inst;
+        $this->emi['emi_selected_inst'] = $selected_inst == '' ? 3 : $selected_inst;
+        $this->emi['emi_allow_only'] = $allow_only == '' ? 0 : $allow_only;
         return $this;
     }
 
+    /**
+     * Set customer information.
+     *
+     * @param string $name
+     * @param string $email
+     * @param string $phone
+     * @param string $add1
+     * @param string $city
+     * @param string $post_code
+     * @param string $country
+     * @author code4mk <[email protected]>
+     * @since v1.0.0
+     * @version 1.0.0
+     */
     public function customer($name = '', $email = '', $phone = '', $add1 = '', $city = '', $post_code = '', $country = ''){
         $this->customerData['cus_name'] = $name == '' ? $this->customerData['cus_name'] : $name;
         $this->customerData['cus_email'] = $email == '' ? $this->customerData['cus_email'] : $email;
@@ -70,6 +117,14 @@ public function customer($name = '', $email = '', $phone = '', $add1 = '', $city
         return $this;
     }
 
+    /**
+     * Get response where you can get GatewayPageURL
+     *
+     * @return object
+     * @author code4mk <[email protected]>
+     * @since v1.0.0
+     * @version 1.0.0
+     */
     public function getRedirectUrl()
     {
         $data = [
@@ -94,18 +149,16 @@ public function getRedirectUrl()
             'product_profile' => 'general',
             'shipping_method' => 'NO',
             'multi_card_name'=>'mastercard,visacard,amexcard',
+            'emi_option' => $this->emi['emi_option'],
+            'emi_selected_inst' => $this->emi['emi_selected_inst'],
+            'emi_max_inst_option' => $this->emi['emi_max_inst_option'] ,
+            'emi_allow_only' => $this->emi['emi_allow_only'],
             'value_a'=>'ref001_A',
             'value_b'=>'ref002_B',
             'value_c'=>'ref003_C',
             'value_d'=>'ref004_D',
         ];
 
-        if($this->emi){
-            $data['emi'] = 1;
-            $data['emi_max_inst_option'] = (int) $this->month;
-            $data['emi_selected_inst'] = (int) $this->selectedMonth;
-        }
-
         $http = new Client([
             'base_uri' => $this->sslHost,
         ]);
@@ -117,9 +170,16 @@ public function getRedirectUrl()
         $body = json_decode($response->getBody());
         // return $body->redirectGatewayURL;
         return $body;
-
     }
 
+    /**
+     * Verify the transaction.
+     *
+     * @return object
+     * @author code4mk <[email protected]>
+     * @since v1.0.0
+     * @version 1.0.0
+     */
     public function verify($request)
     {
         $http = new Client([

src/SslcommerzServiceProvider.php

@@ -2,10 +2,14 @@
 
 namespace Code4mk\Sslcommerz;
 
-
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Foundation\AliasLoader;
 
+/**
+ * Service Provider class
+ * @author code4mk <[email protected]>
+ */
+ 
 class SslcommerzServiceProvider extends ServiceProvider
 {
   /**