hotifx comparing float prices (#1)

* add type hints to all classes

* add calculated total test

Author: mhdcodes

readme.md

@@ -34,7 +34,8 @@ Get client ID and client secret by going to [https://developer.paypal.com/develo
 
 Inorder to communicate with paypal platform we need to setup a client first :
 
-- Create a client with sandbox environment
+- Create a client with sandbox environment : 
+  
 ```php
 // import namespace
 use PayPal\Checkout\Environment\SandboxEnvironment;
@@ -51,27 +52,26 @@ $environment = new SandboxEnvironment($clientId, $clientSecret);
 $client = new PayPalClient($environment);
 ```
 
-- Create a client with production environment
+- Create a client with production environment :
+  
 ```php
 // import namespace
-use PayPal\Checkout\Environment\Production;
+use PayPal\Checkout\Environment\ProductionEnvironment;
 use PayPal\Checkout\Http\PayPalClient;
 
 // client id and client secret retrieved from paypal
 $clientId = "<<PAYPAL-CLIENT-ID>>";
 $clientSecret = "<<PAYPAL-CLIENT-SECRET>>";
 
 // create a new sandbox environment
-$environment = new Production($clientId, $clientSecret);
+$environment = new ProductionEnvironment($clientId, $clientSecret);
 
 // create a new client
 $client = new PayPalClient($environment);
 ```
 
-
 ### Create a new Order
 
-
 ```php
 // import namespace
 use PayPal\Checkout\Http\OrderCreateRequest;
@@ -99,7 +99,6 @@ $result = json_decode((string) $response->getBody());
 echo $result->id; // id of the created order
 ```
 
-
 ## Change log
 
 Please see the [changelog](changelog.md) for more information on what has changed recently.

src/Http/AccessToken.php

@@ -32,7 +32,7 @@ class AccessToken
      */
     protected $created_at;
 
-    public function __construct($token, $token_type, $expires_in)
+    public function __construct(string $token, string $token_type, int $expires_in)
     {
         $this->token = $token;
         $this->token_type = $token_type;
@@ -43,23 +43,23 @@ public function __construct($token, $token_type, $expires_in)
     /**
      * gets the token.
      */
-    public function getToken()
+    public function getToken(): ?string
     {
         return $this->token;
     }
 
     /**
      * gets the token.
      */
-    public function getTokenType(): string
+    public function getTokenType(): ?string
     {
         return $this->token_type;
     }
 
     /**
      * returns authorization string.
      */
-    public function authorizationString(): string
+    public function authorizationString(): ?string
     {
         return $this->token_type.' '.$this->token;
     }

src/Orders/Amount.php

@@ -32,69 +32,58 @@ class Amount implements Arrayable, Jsonable
     protected $value;
 
     /**
-     * Create a new collection.
-     *
-     * @param string $currency_code
-     * @param float  $value
-     *
-     * @return void
+     * create a new amount instance.
      */
-    public function __construct($currency_code, $value)
+    public function __construct(string $currency_code, float $value)
     {
         $this->currency_code = $currency_code;
         $this->value = $value;
     }
 
     /**
-     * gets Amount value.
+     * gets amount value.
      */
-    public function getValue()
+    public function getValue(): float
     {
-        return $this->value;
+        return (float) $this->value;
     }
 
     /**
-     * gets Amount's currency code.
+     * return amount's currency code.
      */
-    public function getCurrencyCode()
+    public function getCurrencyCode(): string
     {
         return $this->currency_code;
     }
 
     /**
-     * sets Amount value.
-     *
-     * @param float $value
+     * sets amount value.
      */
-    public function setValue($value)
+    public function setValue(float $value): self
     {
         $this->value = $value;
 
         return $this;
     }
 
     /**
-     * sets Amount's currency code.
-     *
-     * @param string $currency_code
+     * sets amount's currency code.
      */
-    public function setCurrencyCode($currency_code)
+    public function setCurrencyCode(string $currency_code): self
     {
         $this->currency_code = $currency_code;
 
         return $this;
     }
 
     /**
-     * Get the instance as an array.
-     *
-     * @return array
+     * convert amount to an array.
      */
-    public function toArray()
+    public function toArray(): array
     {
         return [
-            'currency_code' => $this->currency_code,
-            'value' => $this->value,
+            'currency_code' => $this->getCurrencyCode(),
+            'value' => $this->getValue(),
         ];
     }
 }

src/Orders/AmountBreakdown.php

@@ -9,18 +9,16 @@ class AmountBreakdown extends Amount
 {
     /**
      * Get the instance as an array.
-     *
-     * @return array
      */
-    public function toArray()
+    public function toArray(): array
     {
         return [
-            'currency_code' => $this->currency_code,
-            'value' => $this->value,
+            'currency_code' => $this->getCurrencyCode(),
+            'value' => $this->getValue(),
             'breakdown' => [
                 'item_total' => [
-                    'currency_code' => $this->currency_code,
-                    'value' => $this->value,
+                    'currency_code' => $this->getCurrencyCode(),
+                    'value' => $this->getValue(),
                 ],
             ],
         ];

src/Orders/ApplicationContext.php

@@ -125,15 +125,15 @@ public function __construct(
     /**
      * gets brand_name.
      */
-    public function getBrandName()
+    public function getBrandName(): ?string
     {
         return $this->brand_name;
     }
 
     /**
      * sets the brand_name.
      */
-    public function setBrandName($brand_name)
+    public function setBrandName($brand_name): self
     {
         $this->brand_name = $brand_name;
 
@@ -143,15 +143,15 @@ public function setBrandName($brand_name)
     /**
      * gets brand_name.
      */
-    public function getLocale()
+    public function getLocale(): string
     {
         return $this->locale;
     }
 
     /**
      * sets the locale.
      */
-    public function setLocale($locale)
+    public function setLocale($locale): self
     {
         $this->locale = $locale;
 
@@ -161,15 +161,15 @@ public function setLocale($locale)
     /**
      * gets landing_page.
      */
-    public function getLandingPage()
+    public function getLandingPage(): string
     {
         return $this->landing_page;
     }
 
     /**
      * sets the landing_page.
      */
-    public function setLandingPage($landing_page)
+    public function setLandingPage($landing_page): self
     {
         $validOptions = [LOGIN, BILLING, NO_PREFERENCE];
         if (!in_array($landing_page, $validOptions)) {
@@ -184,15 +184,15 @@ public function setLandingPage($landing_page)
     /**
      * gets shipping_preference.
      */
-    public function getShippingPreference()
+    public function getShippingPreference(): string
     {
         return $this->shipping_preference;
     }
 
     /**
      * sets the shipping_preference.
      */
-    public function setShippingPreference($shipping_preference)
+    public function setShippingPreference($shipping_preference): self
     {
         $validOptions = [GET_FROM_FILE, NO_SHIPPING, SET_PROVIDED_ADDRESS];
         if (!in_array($shipping_preference, $validOptions)) {
@@ -207,15 +207,15 @@ public function setShippingPreference($shipping_preference)
     /**
      * gets return_url.
      */
-    public function getReturnUrl()
+    public function getReturnUrl(): ?string
     {
         return $this->return_url;
     }
 
     /**
      * sets the return_url.
      */
-    public function setReturnUrl($return_url)
+    public function setReturnUrl($return_url): self
     {
         $this->return_url = $return_url;
 
@@ -225,15 +225,15 @@ public function setReturnUrl($return_url)
     /**
      * gets cancel_url.
      */
-    public function getCancelUrl()
+    public function getCancelUrl(): ?string
     {
         return $this->cancel_url;
     }
 
     /**
      * sets the cancel_url.
      */
-    public function setCancelUrl($cancel_url)
+    public function setCancelUrl($cancel_url): self
     {
         $this->cancel_url = $cancel_url;
 
@@ -243,15 +243,15 @@ public function setCancelUrl($cancel_url)
     /**
      * gets user_action.
      */
-    public function getUserAction()
+    public function getUserAction(): string
     {
         return $this->user_action;
     }
 
     /**
      * sets the user_action.
      */
-    public function setUserAction($user_action)
+    public function setUserAction($user_action): self
     {
         $validOptions = [ACTION_CONTINUE, ACTION_PAY_NOW];
         if (!in_array($user_action, $validOptions)) {
@@ -264,19 +264,17 @@ public function setUserAction($user_action)
 
     /**
      * Get the instance as an array.
-     *
-     * @return array
      */
-    public function toArray()
+    public function toArray(): array
     {
         $arrayable = [
-            'brand_name' => $this->brand_name ?? null,
-            'locale' => $this->locale ?? null,
-            'shipping_preference' => $this->shipping_preference ?? null,
-            'landing_page' => $this->landing_page ?? null,
-            'user_action' => $this->user_action ?? null,
-            'return_url' => $this->return_url ?? null,
-            'cancel_url' => $this->cancel_url ?? null,
+            'brand_name' => $this->getBrandName() ?? null,
+            'locale' => $this->getLocale() ?? null,
+            'shipping_preference' => $this->getShippingPreference() ?? null,
+            'landing_page' => $this->getLandingPage() ?? null,
+            'user_action' => $this->getUserAction() ?? null,
+            'return_url' => $this->getReturnUrl() ?? null,
+            'cancel_url' => $this->getCancelUrl() ?? null,
         ];
 
         return array_filter(