|
| 1 | +<?php |
| 2 | + |
| 3 | +namespace Bavix\Wallet\Interfaces; |
| 4 | + |
| 5 | +use Bavix\Wallet\Models\Transaction; |
| 6 | +use Bavix\Wallet\Models\Transfer; |
| 7 | +use Illuminate\Database\Eloquent\Relations\MorphMany; |
| 8 | + |
| 9 | +interface Wallet |
| 10 | +{ |
| 11 | + /** |
| 12 | + * @param int $amount |
| 13 | + * @param array|null $meta |
| 14 | + * @param bool $confirmed |
| 15 | + * @return Transaction |
| 16 | + */ |
| 17 | + public function deposit(int $amount, ?array $meta = null, bool $confirmed = true): Transaction; |
| 18 | + |
| 19 | + /** |
| 20 | + * @param int $amount |
| 21 | + * @param array|null $meta |
| 22 | + * @param bool $confirmed |
| 23 | + * @return Transaction |
| 24 | + */ |
| 25 | + public function withdraw(int $amount, ?array $meta = null, bool $confirmed = true): Transaction; |
| 26 | + |
| 27 | + /** |
| 28 | + * @param int $amount |
| 29 | + * @param array|null $meta |
| 30 | + * @param bool $confirmed |
| 31 | + * @return Transaction |
| 32 | + */ |
| 33 | + public function forceWithdraw(int $amount, ?array $meta = null, bool $confirmed = true): Transaction; |
| 34 | + |
| 35 | + /** |
| 36 | + * @param self $wallet |
| 37 | + * @param int $amount |
| 38 | + * @param array|null $meta |
| 39 | + * @return Transfer |
| 40 | + */ |
| 41 | + public function transfer(self $wallet, int $amount, ?array $meta = null): Transfer; |
| 42 | + |
| 43 | + /** |
| 44 | + * @param self $wallet |
| 45 | + * @param int $amount |
| 46 | + * @param array|null $meta |
| 47 | + * @return null|Transfer |
| 48 | + */ |
| 49 | + public function safeTransfer(self $wallet, int $amount, ?array $meta = null): ?Transfer; |
| 50 | + |
| 51 | + /** |
| 52 | + * @param Wallet $wallet |
| 53 | + * @param int $amount |
| 54 | + * @param array|null $meta |
| 55 | + * @return Transfer |
| 56 | + */ |
| 57 | + public function forceTransfer(Wallet $wallet, int $amount, ?array $meta = null): Transfer; |
| 58 | + |
| 59 | + /** |
| 60 | + * @param int $amount |
| 61 | + * @return bool |
| 62 | + */ |
| 63 | + public function canWithdraw(int $amount): bool; |
| 64 | + |
| 65 | + /** |
| 66 | + * @return int |
| 67 | + */ |
| 68 | + public function getBalanceAttribute(): int; |
| 69 | + |
| 70 | + /** |
| 71 | + * @return MorphMany |
| 72 | + */ |
| 73 | + public function transactions(): MorphMany; |
| 74 | +} |
0 commit comments