Add typed properties to Resource handling

Author: zaporylie

phpstan.neon

@@ -4,6 +4,12 @@ parameters:
         - src
         - test
     ignoreErrors:
+        # Ignore Call to an undefined static method zaporylie\Vipps\Resource\HttpMethod::POST().
+        - '#Call to an undefined static method zaporylie\\Vipps\\Resource\\HttpMethod::POST\(\)#'
+        - '#Call to an undefined static method zaporylie\\Vipps\\Resource\\HttpMethod::PUT\(\)#'
+        - '#Call to an undefined static method zaporylie\\Vipps\\Resource\\HttpMethod::PATCH\(\)#'
+        - '#Call to an undefined static method zaporylie\\Vipps\\Resource\\HttpMethod::DELETE\(\)#'
+        - '#Call to an undefined static method zaporylie\\Vipps\\Resource\\HttpMethod::GET\(\)#'
 
 includes:
 	- phpstan-baseline.neon

src/Resource/Authorization/GetToken.php

@@ -15,15 +15,10 @@
 class GetToken extends ResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod;
-     */
-    protected $method = HttpMethod::POST;
-
     /**
      * @var string
      */
-    protected $path = '/accessToken/get';
+    protected string $path = '/accessToken/get';
 
     /**
      * GetToken constructor.
@@ -34,6 +29,7 @@ class GetToken extends ResourceBase
      */
     public function __construct(VippsInterface $vipps, $subscription_key, $client_secret)
     {
+        $this->method = HttpMethod::POST();
         parent::__construct($vipps, $subscription_key);
         // Authorization module requires client_id to be set on "client_id"
         // header.

src/Resource/IdempotencyKeyFactory.php

@@ -15,7 +15,7 @@ abstract class IdempotencyKeyFactory
      *
      * @return string
      */
-    public static function generate()
+    public static function generate(): string
     {
         return uniqid('', true);
     }

src/Resource/Payment/CancelPayment.php

@@ -15,15 +15,10 @@
 class CancelPayment extends PaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::PUT;
-
     /**
      * @var string
      */
-    protected $path = '/ecomm/v2/payments/{id}/cancel';
+    protected string $path = '/ecomm/v2/payments/{id}/cancel';
 
     /**
      * InitiatePayment constructor.
@@ -40,6 +35,7 @@ public function __construct(
         RequestCancelPayment $requestObject
     ) {
         parent::__construct($vipps, $subscription_key);
+        $this->method = HttpMethod::PUT();
         $this->body = $this
             ->getSerializer()
             ->serialize(

src/Resource/Payment/CapturePayment.php

@@ -15,15 +15,10 @@
 class CapturePayment extends PaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::POST;
-
     /**
      * @var string
      */
-    protected $path = '/ecomm/v2/payments/{id}/capture';
+    protected string $path = '/ecomm/v2/payments/{id}/capture';
 
     /**
      * InitiatePayment constructor.
@@ -39,6 +34,7 @@ public function __construct(
         $order_id,
         RequestCapturePayment $requestObject
     ) {
+        $this->method = HttpMethod::POST();
         parent::__construct($vipps, $subscription_key);
         $this->body = $this
             ->getSerializer()

src/Resource/Payment/GetOrderStatus.php

@@ -17,15 +17,10 @@
 class GetOrderStatus extends PaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::GET;
-
     /**
      * @var string
      */
-    protected $path = '/ecomm/v2/payments/{id}/status';
+    protected string $path = '/ecomm/v2/payments/{id}/status';
 
     /**
      * InitiatePayment constructor.
@@ -36,6 +31,7 @@ class GetOrderStatus extends PaymentResourceBase
      */
     public function __construct(VippsInterface $vipps, $subscription_key, $order_id)
     {
+        $this->method = HttpMethod::GET();
         parent::__construct($vipps, $subscription_key);
         $this->id = $order_id;
     }

src/Resource/Payment/GetPaymentDetails.php

@@ -9,15 +9,10 @@
 class GetPaymentDetails extends PaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::GET;
-
     /**
      * @var string
      */
-    protected $path = '/ecomm/v2/payments/{id}/details';
+    protected string $path = '/ecomm/v2/payments/{id}/details';
 
     /**
      * InitiatePayment constructor.
@@ -28,6 +23,7 @@ class GetPaymentDetails extends PaymentResourceBase
      */
     public function __construct(VippsInterface $vipps, $subscription_key, $order_id)
     {
+        $this->method = HttpMethod::GET();
         parent::__construct($vipps, $subscription_key);
         $this->id = $order_id;
     }

src/Resource/Payment/InitiatePayment.php

@@ -15,15 +15,10 @@
 class InitiatePayment extends PaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::POST;
-
     /**
      * @var string
      */
-    protected $path = '/ecomm/v2/payments';
+    protected string $path = '/ecomm/v2/payments';
 
     /**
      * InitiatePayment constructor.
@@ -34,6 +29,7 @@ class InitiatePayment extends PaymentResourceBase
      */
     public function __construct(VippsInterface $vipps, $subscription_key, RequestInitiatePayment $requestObject)
     {
+        $this->method = HttpMethod::POST();
         parent::__construct($vipps, $subscription_key);
         $this->body = $this
             ->getSerializer()

src/Resource/Payment/RefundPayment.php

@@ -15,15 +15,10 @@
 class RefundPayment extends PaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::POST;
-
     /**
      * @var string
      */
-    protected $path = '/ecomm/v2/payments/{id}/refund';
+    protected string $path = '/ecomm/v2/payments/{id}/refund';
 
     /**
      * InitiatePayment constructor.
@@ -39,6 +34,7 @@ public function __construct(
         $order_id,
         RequestRefundPayment $requestObject
     ) {
+        $this->method = HttpMethod::POST();
         parent::__construct($vipps, $subscription_key);
         $this->body = $this
             ->getSerializer()

src/Resource/PaymentsInterface.php

@@ -21,7 +21,7 @@ interface PaymentsInterface extends ResourceInterface
      * @param string $orderID
      * @return $this
      */
-    public function setOrderID($orderID);
+    public function setOrderID(string $orderID): self;
 
     /**
      * Create new payment.
@@ -36,19 +36,19 @@ public function setOrderID($orderID);
      *   Callback absolute Url.
      * @param string $fallback
      *   Fallback absolute Url.
-     * @param null $refOrderID
+     * @param string|null $refOrderID
      *   (optional) Reference to previous order.
      * @return $this
      */
-    public function create($mobileNumber, $amount, $text, $callback, $fallback, $refOrderID = null);
+    public function create(int $mobileNumber, int $amount, string $text, string $callback, string $fallback, string $refOrderID = null): self;
 
     /**
      * Cancel payment.
      *
      * @param string $text
      * @return $this
      */
-    public function cancel($text);
+    public function cancel(string $text): self;
 
     /**
      * Capture payment.
@@ -59,7 +59,7 @@ public function cancel($text);
      *   (optional) Amount in øre.
      * @return $this
      */
-    public function capture($text, $amount = 0);
+    public function capture(string $text, int $amount = 0): self;
 
     /**
      * Refund payment.
@@ -70,7 +70,7 @@ public function capture($text, $amount = 0);
      *   (optional) Amount in øre.
      * @return $this
      */
-    public function refund($text, $amount = 0);
+    public function refund(string $text, int $amount = 0): self;
 
     /**
      * Get payment status.

src/Resource/RecurringPayment/CancelCharge.php

@@ -18,15 +18,10 @@
 class CancelCharge extends RecurringPaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::DELETE;
-
     /**
      * @var string
      */
-    protected $path = '/recurring/v2/agreements/{id}/charges/{charge_id}';
+    protected string $path = '/recurring/v2/agreements/{id}/charges/{charge_id}';
 
     /**
      * CancelCharge constructor.
@@ -45,6 +40,7 @@ public function __construct(
         $this->id = $agreement_id;
         $this->charge_id = $charge_id;
         parent::__construct($vipps, $subscription_key);
+        $this->method = HttpMethod::DELETE();
     }
 
     /**

src/Resource/RecurringPayment/CaptureCharge.php

@@ -18,15 +18,10 @@
 class CaptureCharge extends RecurringPaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::POST;
-
     /**
      * @var string
      */
-    protected $path = '/recurring/v2/agreements/{id}/charges/{charge_id}/capture';
+    protected string $path = '/recurring/v2/agreements/{id}/charges/{charge_id}/capture';
 
     /**
      * InitiatePayment constructor.
@@ -47,6 +42,7 @@ public function __construct(
         // By default RequestID is different for each Resource object.
         $this->headers['Idempotency-Key'] = IdempotencyKeyFactory::generate();
         parent::__construct($vipps, $subscription_key);
+        $this->method = HttpMethod::POST();
     }
 
     /**

src/Resource/RecurringPayment/CreateAgreement.php

@@ -15,15 +15,10 @@
 class CreateAgreement extends RecurringPaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::POST;
-
     /**
      * @var string
      */
-    protected $path = '/recurring/v2/agreements';
+    protected string $path = '/recurring/v2/agreements';
 
     /**
      * InitiatePayment constructor.
@@ -35,6 +30,7 @@ class CreateAgreement extends RecurringPaymentResourceBase
     public function __construct(VippsInterface $vipps, $subscription_key, RequestCreateAgreement $requestObject)
     {
         parent::__construct($vipps, $subscription_key);
+        $this->method = HttpMethod::POST();
         $this->body = $this
             ->getSerializer()
             ->serialize(

src/Resource/RecurringPayment/CreateCharge.php

@@ -17,15 +17,10 @@
 class CreateCharge extends RecurringPaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::POST;
-
     /**
      * @var string
      */
-    protected $path = '/recurring/v2/agreements/{id}/charges';
+    protected string $path = '/recurring/v2/agreements/{id}/charges';
 
     /**
      * InitiatePayment constructor.
@@ -45,6 +40,7 @@ public function __construct(
         // By default RequestID is different for each Resource object.
         $this->headers['Idempotency-Key'] = IdempotencyKeyFactory::generate();
         parent::__construct($vipps, $subscription_key);
+        $this->method = HttpMethod::POST();
         $this->body = $this
             ->getSerializer()
             ->serialize(

src/Resource/RecurringPayment/GetAgreement.php

@@ -14,15 +14,10 @@
 class GetAgreement extends RecurringPaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::GET;
-
     /**
      * @var string
      */
-    protected $path = '/recurring/v2/agreements/{id}';
+    protected string $path = '/recurring/v2/agreements/{id}';
 
     /**
      * InitiatePayment constructor.

src/Resource/RecurringPayment/GetAgreements.php

@@ -4,6 +4,7 @@
 
 use zaporylie\Vipps\Model\RecurringPayment\ResponseGetAgreement;
 use zaporylie\Vipps\Resource\HttpMethod;
+use zaporylie\Vipps\VippsInterface;
 
 /**
  * Class GetAgreements
@@ -13,15 +14,10 @@
 class GetAgreements extends RecurringPaymentResourceBase
 {
 
-    /**
-     * @var \zaporylie\Vipps\Resource\HttpMethod
-     */
-    protected $method = HttpMethod::GET;
-
     /**
      * @var string
      */
-    protected $path = '/recurring/v2/agreements';
+    protected string $path = '/recurring/v2/agreements';
 
     /**
      * @return \zaporylie\Vipps\Model\RecurringPayment\ResponseGetAgreement[]