Merge pull request #313 from bavix/phpdoc

Making the documentation more readable

Author: rez1dent3

src/Commands/RefreshBalance.php

@@ -27,6 +27,7 @@ class RefreshBalance extends Command
 
     /**
      * @return void
+     *
      * @throws
      */
     public function handle(): void

src/Interfaces/Confirmable.php

@@ -2,25 +2,56 @@
 
 namespace Bavix\Wallet\Interfaces;
 
+use Bavix\Wallet\Exceptions\BalanceIsEmpty;
+use Bavix\Wallet\Exceptions\ConfirmedInvalid;
+use Bavix\Wallet\Exceptions\InsufficientFunds;
+use Bavix\Wallet\Exceptions\WalletOwnerInvalid;
 use Bavix\Wallet\Models\Transaction;
 
 interface Confirmable
 {
     /**
      * @param Transaction $transaction
+     *
      * @return bool
+     *
+     * @throws BalanceIsEmpty
+     * @throws InsufficientFunds
+     * @throws ConfirmedInvalid
+     * @throws WalletOwnerInvalid
      */
     public function confirm(Transaction $transaction): bool;
 
     /**
      * @param Transaction $transaction
+     *
      * @return bool
      */
     public function safeConfirm(Transaction $transaction): bool;
 
     /**
      * @param Transaction $transaction
+     *
      * @return bool
+     *
+     * @throws ConfirmedInvalid
+     */
+    public function resetConfirm(Transaction $transaction): bool;
+
+    /**
+     * @param Transaction $transaction
+     *
+     * @return bool
+     */
+    public function safeResetConfirm(Transaction $transaction): bool;
+
+    /**
+     * @param Transaction $transaction
+     *
+     * @return bool
+     *
+     * @throws ConfirmedInvalid
+     * @throws WalletOwnerInvalid
      */
     public function forceConfirm(Transaction $transaction): bool;
 }

src/Interfaces/Customer.php

@@ -10,29 +10,35 @@ interface Customer extends Wallet
     /**
      * @param Product $product
      * @param bool $force
+     *
      * @return Transfer
+     *
      * @throws
      */
     public function pay(Product $product, bool $force = null): Transfer;
 
     /**
      * @param Product $product
      * @param bool $force
-     * @return null|Transfer
+     *
+     * @return Transfer|null
+     *
      * @throws
      */
     public function safePay(Product $product, bool $force = null): ?Transfer;
 
     /**
      * @param Product $product
      * @return Transfer
+     *
      * @throws
      */
     public function forcePay(Product $product): Transfer;
 
     /**
      * @param Product $product
      * @param bool $gifts
+     *
      * @return null|Transfer
      */
     public function paid(Product $product, bool $gifts = null): ?Transfer;
@@ -41,7 +47,9 @@ public function paid(Product $product, bool $gifts = null): ?Transfer;
      * @param Product $product
      * @param bool $force
      * @param bool $gifts
+     *
      * @return bool
+     *
      * @throws
      */
     public function refund(Product $product, bool $force = null, bool $gifts = null): bool;
@@ -50,36 +58,44 @@ public function refund(Product $product, bool $force = null, bool $gifts = null)
      * @param Product $product
      * @param bool $force
      * @param bool $gifts
+     *
      * @return bool
      */
     public function safeRefund(Product $product, bool $force = null, bool $gifts = null): bool;
 
     /**
      * @param Product $product
      * @param bool $gifts
+     *
      * @return bool
      */
     public function forceRefund(Product $product, bool $gifts = null): bool;
 
     /**
      * @param Cart $cart
      * @param bool $force
+     *
      * @return Transfer[]
+     *
      * @throws
      */
     public function payCart(Cart $cart, bool $force = null): array;
 
     /**
      * @param Cart $cart
      * @param bool $force
+     *
      * @return Transfer[]
+     *
      * @throws
      */
     public function safePayCart(Cart $cart, bool $force = null): array;
 
     /**
      * @param Cart $cart
+     *
      * @return Transfer[]
+     *
      * @throws
      */
     public function forcePayCart(Cart $cart): array;
@@ -88,7 +104,9 @@ public function forcePayCart(Cart $cart): array;
      * @param Cart $cart
      * @param bool $force
      * @param bool $gifts
+     *
      * @return bool
+     *
      * @throws
      */
     public function refundCart(Cart $cart, bool $force = null, bool $gifts = null): bool;
@@ -97,13 +115,15 @@ public function refundCart(Cart $cart, bool $force = null, bool $gifts = null):
      * @param Cart $cart
      * @param bool $force
      * @param bool $gifts
+     *
      * @return bool
      */
     public function safeRefundCart(Cart $cart, bool $force = null, bool $gifts = null): bool;
 
     /**
      * @param Cart $cart
      * @param bool $gifts
+     *
      * @return bool
      */
     public function forceRefundCart(Cart $cart, bool $gifts = null): bool;

src/Interfaces/Discount.php

@@ -6,6 +6,7 @@ interface Discount extends Product
 {
     /**
      * @param Customer $customer
+     *
      * @return int|float
      */
     public function getPersonalDiscount(Customer $customer);

src/Interfaces/Exchangeable.php

@@ -10,6 +10,7 @@ interface Exchangeable
      * @param Wallet $to
      * @param int|string $amount
      * @param array|null $meta
+     *
      * @return Transfer
      */
     public function exchange(Wallet $to, $amount, ?array $meta = null): Transfer;
@@ -18,6 +19,7 @@ public function exchange(Wallet $to, $amount, ?array $meta = null): Transfer;
      * @param Wallet $to
      * @param int|string $amount
      * @param array|null $meta
+     *
      * @return Transfer|null
      */
     public function safeExchange(Wallet $to, $amount, ?array $meta = null): ?Transfer;
@@ -26,6 +28,7 @@ public function safeExchange(Wallet $to, $amount, ?array $meta = null): ?Transfe
      * @param Wallet $to
      * @param int|string $amount
      * @param array|null $meta
+     *
      * @return Transfer
      */
     public function forceExchange(Wallet $to, $amount, ?array $meta = null): Transfer;

src/Interfaces/Mathable.php

@@ -8,6 +8,7 @@ interface Mathable
      * @param int|float|string $first
      * @param int|float|string $second
      * @param int|null $scale
+     *
      * @return string
      */
     public function add($first, $second, ?int $scale = null): string;
@@ -16,6 +17,7 @@ public function add($first, $second, ?int $scale = null): string;
      * @param int|float|string $first
      * @param int|float|string $second
      * @param int|null $scale
+     *
      * @return string
      */
     public function sub($first, $second, ?int $scale = null): string;
@@ -24,6 +26,7 @@ public function sub($first, $second, ?int $scale = null): string;
      * @param int|float|string $first
      * @param int|float|string $second
      * @param int|null $scale
+     *
      * @return string
      */
     public function div($first, $second, ?int $scale = null): string;
@@ -32,6 +35,7 @@ public function div($first, $second, ?int $scale = null): string;
      * @param int|float|string $first
      * @param int|float|string $second
      * @param int|null $scale
+     *
      * @return string
      */
     public function mul($first, $second, ?int $scale = null): string;
@@ -40,6 +44,7 @@ public function mul($first, $second, ?int $scale = null): string;
      * @param int|float|string $first
      * @param int|string $second
      * @param int|null $scale
+     *
      * @return string
      */
     public function pow($first, $second, ?int $scale = null): string;
@@ -53,6 +58,7 @@ public function round($number, int $precision = 0): string;
 
     /**
      * @param int|float|string $number
+     *
      * @return string
      */
     public function floor($number): string;
@@ -65,19 +71,22 @@ public function ceil($number): string;
 
     /**
      * @param int|float|string $number
+     *
      * @return string
      */
     public function abs($number): string;
 
     /**
      * @param int|float|string $number
+     *
      * @return string
      */
     public function negative($number): string;
 
     /**
      * @param int|float|string $first
      * @param int|float|string $second
+     *
      * @return int
      */
     public function compare($first, $second): int;

src/Interfaces/Rateable.php

@@ -6,18 +6,21 @@ interface Rateable
 {
     /**
      * @param int|string $amount
+     *
      * @return Rateable
      */
     public function withAmount($amount): self;
 
     /**
      * @param Wallet $wallet
+     *
      * @return self
      */
     public function withCurrency(Wallet $wallet): self;
 
     /**
      * @param Wallet $wallet
+     *
      * @return int|float
      */
     public function convertTo(Wallet $wallet);

src/Interfaces/Storable.php

@@ -8,6 +8,7 @@ interface Storable
      * Get balance from storage.
      *
      * @param Wallet $object
+     *
      * @return int|float
      */
     public function getBalance($object);
@@ -17,6 +18,7 @@ public function getBalance($object);
      *
      * @param Wallet $object
      * @param int|string $amount
+     *
      * @return string
      */
     public function incBalance($object, $amount);
@@ -26,6 +28,7 @@ public function incBalance($object, $amount);
      *
      * @param Wallet $object
      * @param int|string $amount
+     *
      * @return bool
      */
     public function setBalance($object, $amount): bool;