PHP 8+ Union types

bavix · May 2, 2022 · 0be5309 · 0be5309
1 parent 725715a
commit 0be5309
Show file tree

Hide file tree

Showing 18 changed files with 100 additions and 177 deletions.
diff --git a/rector.php b/rector.php
@@ -18,10 +18,6 @@
         __DIR__ . '/tests',
     ]);
 
-    $parameters->set(Option::SKIP, [
-        UnionTypesRector::class
-    ]);
-
     // Define what rule sets will be applied
     $containerConfigurator->import(PHPUnitSetList::PHPUNIT_91);
     $containerConfigurator->import(LaravelSetList::LARAVEL_80);

diff --git a/src/Interfaces/Discount.php b/src/Interfaces/Discount.php
@@ -6,8 +6,5 @@
 
 interface Discount
 {
-    /**
-     * @return float|int
-     */
-    public function getPersonalDiscount(Customer $customer);
+    public function getPersonalDiscount(Customer $customer): float|int;
 }
diff --git a/src/Interfaces/Exchangeable.php b/src/Interfaces/Exchangeable.php
@@ -17,8 +17,6 @@
 interface Exchangeable
 {
     /**
-     * @param int|string $amount
-     *
      * @throws BalanceIsEmpty
      * @throws InsufficientFunds
      * @throws LockProviderNotFoundException
@@ -27,21 +25,16 @@ interface Exchangeable
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function exchange(Wallet $to, $amount, ExtraDtoInterface|array|null $meta = null): Transfer;
+    public function exchange(Wallet $to, int|string $amount, ExtraDtoInterface|array|null $meta = null): Transfer;
 
-    /**
-     * @param int|string $amount
-     */
-    public function safeExchange(Wallet $to, $amount, ExtraDtoInterface|array|null $meta = null): ?Transfer;
+    public function safeExchange(Wallet $to, int|string $amount, ExtraDtoInterface|array|null $meta = null): ?Transfer;
 
     /**
-     * @param int|string $amount
-     *
      * @throws LockProviderNotFoundException
      * @throws RecordNotFoundException
      * @throws RecordsNotFoundException
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function forceExchange(Wallet $to, $amount, ExtraDtoInterface|array|null $meta = null): Transfer;
+    public function forceExchange(Wallet $to, int|string $amount, ExtraDtoInterface|array|null $meta = null): Transfer;
 }
diff --git a/src/Interfaces/MaximalTaxable.php b/src/Interfaces/MaximalTaxable.php
@@ -6,8 +6,5 @@
 
 interface MaximalTaxable extends Taxable
 {
-    /**
-     * @return float|int
-     */
-    public function getMaximalFee();
+    public function getMaximalFee(): float|int;
 }
diff --git a/src/Interfaces/MinimalTaxable.php b/src/Interfaces/MinimalTaxable.php
@@ -6,8 +6,5 @@
 
 interface MinimalTaxable extends Taxable
 {
-    /**
-     * @return float|int
-     */
-    public function getMinimalFee();
+    public function getMinimalFee(): float|int;
 }
diff --git a/src/Interfaces/ProductInterface.php b/src/Interfaces/ProductInterface.php
@@ -6,10 +6,7 @@
 
 interface ProductInterface extends Wallet
 {
-    /**
-     * @return float|int|string
-     */
-    public function getAmountProduct(Customer $customer);
+    public function getAmountProduct(Customer $customer): float|int|string;
 
     public function getMetaProduct(): ?array;
 }
diff --git a/src/Interfaces/Taxable.php b/src/Interfaces/Taxable.php
@@ -10,8 +10,6 @@ interface Taxable
      * Specify the percentage of the amount. For example, the product costs $100, the equivalent of 15%. That's $115.
      *
      * Minimum 0; Maximum 100 Example: return 7.5; // 7.5%
-     *
-     * @return float|int
      */
-    public function getFeePercent();
+    public function getFeePercent(): float|int;
 }
diff --git a/src/Interfaces/Wallet.php b/src/Interfaces/Wallet.php
@@ -20,19 +20,15 @@
 interface Wallet
 {
     /**
-     * @param int|string $amount
-     *
      * @throws AmountInvalid
      * @throws LockProviderNotFoundException
      * @throws RecordsNotFoundException
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function deposit($amount, ?array $meta = null, bool $confirmed = true): Transaction;
+    public function deposit(int|string $amount, ?array $meta = null, bool $confirmed = true): Transaction;
 
     /**
-     * @param int|string $amount
-     *
      * @throws AmountInvalid
      * @throws BalanceIsEmpty
      * @throws InsufficientFunds
@@ -41,22 +37,18 @@ public function deposit($amount, ?array $meta = null, bool $confirmed = true): T
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function withdraw($amount, ?array $meta = null, bool $confirmed = true): Transaction;
+    public function withdraw(int|string $amount, ?array $meta = null, bool $confirmed = true): Transaction;
 
     /**
-     * @param int|string $amount
-     *
      * @throws AmountInvalid
      * @throws LockProviderNotFoundException
      * @throws RecordsNotFoundException
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function forceWithdraw($amount, ?array $meta = null, bool $confirmed = true): Transaction;
+    public function forceWithdraw(int|string $amount, ?array $meta = null, bool $confirmed = true): Transaction;
 
     /**
-     * @param int|string $amount
-     *
      * @throws AmountInvalid
      * @throws BalanceIsEmpty
      * @throws InsufficientFunds
@@ -65,33 +57,30 @@ public function forceWithdraw($amount, ?array $meta = null, bool $confirmed = tr
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function transfer(self $wallet, $amount, ExtraDtoInterface|array|null $meta = null): Transfer;
+    public function transfer(self $wallet, int|string $amount, ExtraDtoInterface|array|null $meta = null): Transfer;
 
-    /**
-     * @param int|string $amount
-     */
-    public function safeTransfer(self $wallet, $amount, ExtraDtoInterface|array|null $meta = null): ?Transfer;
+    public function safeTransfer(
+        self $wallet,
+        int|string $amount,
+        ExtraDtoInterface|array|null $meta = null
+    ): ?Transfer;
 
     /**
-     * @param int|string $amount
-     *
      * @throws AmountInvalid
      * @throws LockProviderNotFoundException
      * @throws RecordsNotFoundException
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function forceTransfer(self $wallet, $amount, ExtraDtoInterface|array|null $meta = null): Transfer;
+    public function forceTransfer(
+        self $wallet,
+        int|string $amount,
+        ExtraDtoInterface|array|null $meta = null
+    ): Transfer;
 
-    /**
-     * @param int|string $amount
-     */
-    public function canWithdraw($amount, bool $allowZero = false): bool;
+    public function canWithdraw(int|string $amount, bool $allowZero = false): bool;
 
-    /**
-     * @return float|int
-     */
-    public function getBalanceAttribute();
+    public function getBalanceAttribute(): string;
 
     public function getBalanceIntAttribute(): int;
 

diff --git a/src/Interfaces/WalletFloat.php b/src/Interfaces/WalletFloat.php
@@ -18,19 +18,15 @@
 interface WalletFloat
 {
     /**
-     * @param float|string $amount
-     *
      * @throws AmountInvalid
      * @throws LockProviderNotFoundException
      * @throws RecordsNotFoundException
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function depositFloat($amount, ?array $meta = null, bool $confirmed = true): Transaction;
+    public function depositFloat(float|int|string $amount, ?array $meta = null, bool $confirmed = true): Transaction;
 
     /**
-     * @param float|string $amount
-     *
      * @throws AmountInvalid
      * @throws BalanceIsEmpty
      * @throws InsufficientFunds
@@ -39,22 +35,22 @@ public function depositFloat($amount, ?array $meta = null, bool $confirmed = tru
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function withdrawFloat($amount, ?array $meta = null, bool $confirmed = true): Transaction;
+    public function withdrawFloat(float|int|string $amount, ?array $meta = null, bool $confirmed = true): Transaction;
 
     /**
-     * @param float|string $amount
-     *
      * @throws AmountInvalid
      * @throws LockProviderNotFoundException
      * @throws RecordsNotFoundException
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function forceWithdrawFloat($amount, ?array $meta = null, bool $confirmed = true): Transaction;
+    public function forceWithdrawFloat(
+        float|int|string $amount,
+        ?array $meta = null,
+        bool $confirmed = true
+    ): Transaction;
 
     /**
-     * @param float|string $amount
-     *
      * @throws AmountInvalid
      * @throws BalanceIsEmpty
      * @throws InsufficientFunds
@@ -63,31 +59,35 @@ public function forceWithdrawFloat($amount, ?array $meta = null, bool $confirmed
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function transferFloat(Wallet $wallet, $amount, ExtraDtoInterface|array|null $meta = null): Transfer;
+    public function transferFloat(
+        Wallet $wallet,
+        float|int|string $amount,
+        ExtraDtoInterface|array|null $meta = null
+    ): Transfer;
 
-    /**
-     * @param float|string $amount
-     */
-    public function safeTransferFloat(Wallet $wallet, $amount, ExtraDtoInterface|array|null $meta = null): ?Transfer;
+    public function safeTransferFloat(
+        Wallet $wallet,
+        float|int|string $amount,
+        ExtraDtoInterface|array|null $meta = null
+    ): ?Transfer;
 
     /**
-     * @param float|string $amount
-     *
      * @throws AmountInvalid
      * @throws LockProviderNotFoundException
      * @throws RecordsNotFoundException
      * @throws TransactionFailedException
      * @throws ExceptionInterface
      */
-    public function forceTransferFloat(Wallet $wallet, $amount, ExtraDtoInterface|array|null $meta = null): Transfer;
+    public function forceTransferFloat(
+        Wallet $wallet,
+        float|int|string $amount,
+        ExtraDtoInterface|array|null $meta = null
+    ): Transfer;
 
-    /**
-     * @param float|string $amount
-     */
-    public function canWithdrawFloat($amount): bool;
+    public function canWithdrawFloat(float|int|string $amount): bool;
 
     /**
-     * @return float|int|string
+     * @return string
      */
     public function getBalanceFloatAttribute();
 }
diff --git a/src/Models/Transaction.php b/src/Models/Transaction.php
@@ -92,10 +92,7 @@ public function getAmountFloatAttribute(): string
         return $math->div($this->amount, $decimalPlaces);
     }
 
-    /**
-     * @param float|int|string $amount
-     */
-    public function setAmountFloatAttribute($amount): void
+    public function setAmountFloatAttribute(float|int|string $amount): void
     {
         $math = app(MathServiceInterface::class);
         $decimalPlacesValue = app(CastServiceInterface::class)

diff --git a/src/Models/Wallet.php b/src/Models/Wallet.php
@@ -124,10 +124,7 @@ public function getOriginalBalanceAttribute(): string
         return (string) $this->getRawOriginal('balance', 0);
     }
 
-    /**
-     * @return float|int|string
-     */
-    public function getAvailableBalanceAttribute()
+    public function getAvailableBalanceAttribute(): float|int|string
     {
         return $this->walletTransactions()
             ->where('confirmed', true)

diff --git a/src/Services/CommonServiceLegacy.php b/src/Services/CommonServiceLegacy.php
@@ -33,8 +33,6 @@ public function __construct(
     }
 
     /**
-     * @param int|string $amount
-     *
      * @throws LockProviderNotFoundException
      * @throws RecordNotFoundException
      * @throws RecordsNotFoundException
@@ -44,7 +42,7 @@ public function __construct(
     public function forceTransfer(
         Wallet $from,
         Wallet $to,
-        $amount,
+        int|string $amount,
         ExtraDtoInterface|array|null $meta = null,
         string $status = Transfer::STATUS_TRANSFER
     ): Transfer {
@@ -119,15 +117,13 @@ public function applyTransfers(array $objects): array
     }
 
     /**
-     * @param float|int|string $amount
-     *
      * @throws LockProviderNotFoundException
      * @throws RecordNotFoundException
      */
     public function makeTransaction(
         Wallet $wallet,
         string $type,
-        $amount,
+        float|int|string $amount,
         ?array $meta,
         bool $confirmed = true
     ): Transaction {

diff --git a/src/Services/ConsistencyServiceInterface.php b/src/Services/ConsistencyServiceInterface.php
@@ -13,25 +13,17 @@
 interface ConsistencyServiceInterface
 {
     /**
-     * @param float|int|string $amount
-     *
      * @throws AmountInvalid
      */
-    public function checkPositive($amount): void;
+    public function checkPositive(float|int|string $amount): void;
 
     /**
-     * @param float|int|string $amount
-     *
      * @throws BalanceIsEmpty
      * @throws InsufficientFunds
      */
-    public function checkPotential(Wallet $object, $amount, bool $allowZero = false): void;
+    public function checkPotential(Wallet $object, float|int|string $amount, bool $allowZero = false): void;
 
-    /**
-     * @param float|int|string $balance
-     * @param float|int|string $amount
-     */
-    public function canWithdraw($balance, $amount, bool $allowZero = false): bool;
+    public function canWithdraw(int|string $balance, int|string $amount, bool $allowZero = false): bool;
 
     /**
      * @param TransferLazyDtoInterface[] $objects