add model interfaces

Author: rez1dent3

src/Models/Transaction.php

@@ -29,11 +29,8 @@
  * @property Wallet      $payable
  * @property WalletModel $wallet
  */
-class Transaction extends Model
+class Transaction extends Model implements TransactionInterface
 {
-    public const TYPE_DEPOSIT = 'deposit';
-    public const TYPE_WITHDRAW = 'withdraw';
-
     /**
      * @var string[]
      */

src/Models/TransactionInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Models;
+
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+interface TransactionInterface
+{
+    public const TYPE_DEPOSIT = 'deposit';
+    public const TYPE_WITHDRAW = 'withdraw';
+
+    public function getTable(): string;
+
+    public function payable(): MorphTo;
+
+    public function wallet(): BelongsTo;
+
+    public function getAmountIntAttribute(): int;
+
+    public function getAmountFloatAttribute(): string;
+
+    /**
+     * @param float|int|string $amount
+     */
+    public function setAmountFloatAttribute($amount): void;
+}

src/Models/Transfer.php

@@ -25,14 +25,8 @@
  * @property Transaction $deposit
  * @property Transaction $withdraw
  */
-class Transfer extends Model
+class Transfer extends Model implements TransferInterface
 {
-    public const STATUS_EXCHANGE = 'exchange';
-    public const STATUS_TRANSFER = 'transfer';
-    public const STATUS_PAID = 'paid';
-    public const STATUS_REFUND = 'refund';
-    public const STATUS_GIFT = 'gift';
-
     /**
      * @var string[]
      */

src/Models/TransferInterface.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Models;
+
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+interface TransferInterface
+{
+    public const STATUS_EXCHANGE = 'exchange';
+    public const STATUS_TRANSFER = 'transfer';
+    public const STATUS_PAID = 'paid';
+    public const STATUS_REFUND = 'refund';
+    public const STATUS_GIFT = 'gift';
+
+    public function getTable(): string;
+
+    public function from(): MorphTo;
+
+    public function to(): MorphTo;
+
+    public function deposit(): BelongsTo;
+
+    public function withdraw(): BelongsTo;
+}

src/Models/Wallet.php

@@ -6,10 +6,6 @@
 
 use function app;
 use function array_key_exists;
-use Bavix\Wallet\Interfaces\Confirmable;
-use Bavix\Wallet\Interfaces\Customer;
-use Bavix\Wallet\Interfaces\Exchangeable;
-use Bavix\Wallet\Interfaces\WalletFloat;
 use Bavix\Wallet\Internal\Exceptions\ExceptionInterface;
 use Bavix\Wallet\Internal\Service\DatabaseServiceInterface;
 use Bavix\Wallet\Services\WalletServiceLegacy;
@@ -36,7 +32,7 @@
  * @property \Bavix\Wallet\Interfaces\Wallet $holder
  * @property string                          $currency
  */
-class Wallet extends Model implements Customer, WalletFloat, Confirmable, Exchangeable
+class Wallet extends Model implements WalletInterface
 {
     use CanConfirm;
     use CanExchange;

src/Models/WalletInterface.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bavix\Wallet\Models;
+
+use Bavix\Wallet\Interfaces\Confirmable;
+use Bavix\Wallet\Interfaces\Customer;
+use Bavix\Wallet\Interfaces\Exchangeable;
+use Bavix\Wallet\Interfaces\WalletFloat;
+use Bavix\Wallet\Internal\Exceptions\ExceptionInterface;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+interface WalletInterface extends Customer, WalletFloat, Confirmable, Exchangeable
+{
+    public function getTable(): string;
+
+    public function setNameAttribute(string $name): void;
+
+    /**
+     * Under ideal conditions, you will never need a method.
+     * Needed to deal with out-of-sync.
+     *
+     * @throws ExceptionInterface
+     */
+    public function refreshBalance(): bool;
+
+    public function getOriginalBalance(): string;
+
+    /**
+     * @return float|int
+     */
+    public function getAvailableBalance();
+
+    public function holder(): MorphTo;
+
+    public function getCurrencyAttribute(): string;
+}