b757d7df9d
- changed order pk column to id - refactored and fixed inShop - using php Money for transaction
393 lines
12 KiB
PHP
393 lines
12 KiB
PHP
<?php
|
|
|
|
namespace App\Models\Shop;
|
|
|
|
use App\Enums\Order\DeliveryStatus;
|
|
use App\Enums\Order\PaymentStatus;
|
|
use App\Enums\Order\TransactionType;
|
|
use App\Enums\Order\ValidationStatus;
|
|
use App\Lib\Helpers\ToolboxHelper;
|
|
use App\Models\Customer\Customer;
|
|
use App\Models\Merchandise\Product;
|
|
use App\Models\Payment\Transaction;
|
|
use App\Notifications\Order\OrderValidationStatusChanged;
|
|
use App\Notifications\Order\OrderDeliveryStatusChanged;
|
|
use Gloudemans\Shoppingcart\Cart;
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Support\Facades\Session;
|
|
use Illuminate\Support\Str;
|
|
use Illuminate\Validation\ValidationException;
|
|
use Kwaadpepper\Enum\Traits\CastsEnums;
|
|
use Money\Currency;
|
|
use Money\Money;
|
|
|
|
/**
|
|
* Order
|
|
*
|
|
* @property-read string $reference The order unique reference string.
|
|
* @property array $basket The order serialized basket.
|
|
* @property string $email The customer email used for this order.
|
|
* @property boolean $mail_sent Has the confirmation mail been sent to the customer.
|
|
* @property object $shipping The shipping address info.
|
|
* @property object $billing The billing address info.
|
|
* @property integer $total_discounted Total discounted on this order in cents.
|
|
* @property integer $total_ttc Total payed fro mthe customer in cents.
|
|
* @property integer $total_ht Total without taxes in cents.
|
|
* @property integer $total_weight Total weight in gramms.
|
|
* @property \App\Enums\Order\ValidationStatus $validation_status The order validation status.
|
|
* @property \App\Enums\Order\PaymentStatus $payment_status The order payment status.
|
|
* @property \App\Enums\Order\DeliveryStatus $delivery_status The order delivery status.
|
|
*
|
|
* @property-read boolean $can_be_cancelled Can the order be cancelled ?
|
|
*
|
|
* @package App\Models
|
|
*/
|
|
class Order extends Model
|
|
{
|
|
use CastsEnums;
|
|
use HasFactory;
|
|
|
|
/**
|
|
* Indicates if the IDs are auto-incrementing.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $incrementing = false;
|
|
|
|
/**
|
|
* The "type" of the primary key ID.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $keyType = 'uuid';
|
|
|
|
/**
|
|
* The model's attributes.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $attributes = [
|
|
'mail_sent' => false
|
|
];
|
|
|
|
/**
|
|
* Map attribute names to enum classes.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $enumCasts = [
|
|
'validation_status' => ValidationStatus::class,
|
|
'payment_status' => PaymentStatus::class,
|
|
'delivery_status' => DeliveryStatus::class
|
|
];
|
|
|
|
/**
|
|
* The attributes that should be cast to native types.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $casts = [
|
|
'basket' => 'object',
|
|
'shipping' => 'object',
|
|
'billing' => 'object',
|
|
'mail_sent' => 'bool'
|
|
];
|
|
|
|
/**
|
|
* The attributes that are mass assignable.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $fillable = [
|
|
'shipping',
|
|
'billing'
|
|
];
|
|
|
|
/**
|
|
* Perform any actions required after the model boots.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected static function booted()
|
|
{
|
|
static::creating(function (self $model) {
|
|
// * ASSERTIONS
|
|
static::assertValidateStatus($model);
|
|
static::assertCancelStatus($model);
|
|
$model->setUniqueOrderReference();
|
|
});
|
|
static::updating(function (self $model) {
|
|
static::assertValidateStatus($model);
|
|
static::assertCancelStatus($model);
|
|
static::assertDeliveryStatusCanBeChanged($model);
|
|
|
|
if ($model->validation_status->value !== $model->getOriginal('validation_status')) {
|
|
// * Notifiy customer
|
|
$model->customer->notify(new OrderValidationStatusChanged($model));
|
|
Session::flash('bo.info', trans('Le client recevra une notification sur l\'état de validation.'));
|
|
}
|
|
if (
|
|
$model->delivery_status->equals(DeliveryStatus::ready()) and
|
|
$model->delivery_status->value !== $model->getOriginal('delivery_status')
|
|
) {
|
|
// * Notifiy customer
|
|
$model->customer->notify(new OrderDeliveryStatusChanged($model));
|
|
Session::flash('bo.info', trans('Le client recevra une notification sur \'état de livraison.'));
|
|
}
|
|
});
|
|
}
|
|
|
|
// * RELATIONSHIPS
|
|
|
|
/**
|
|
* HasMany transactions relation
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function transactions()
|
|
{
|
|
return $this->hasMany(Transaction::class);
|
|
}
|
|
|
|
/**
|
|
* BelongsToMany products relation
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
|
|
*/
|
|
public function products()
|
|
{
|
|
return $this->belongsToMany(Product::class, 'order_lines', 'order_id', 'product_id');
|
|
}
|
|
|
|
/**
|
|
* BelongsTo customer relation
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function customer()
|
|
{
|
|
return $this->belongsTo(Customer::class);
|
|
}
|
|
|
|
/**
|
|
* BelongsTo DeliveryMode relation
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function deliveryMode()
|
|
{
|
|
return $this->belongsTo(DeliveryMode::class);
|
|
}
|
|
|
|
/**
|
|
* hasOne timeslot relation
|
|
*
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasOne
|
|
*/
|
|
public function timeslot()
|
|
{
|
|
return $this->hasOne(Timeslot::class);
|
|
}
|
|
|
|
// * GETTER
|
|
|
|
/**
|
|
* Getter can_be_cancelled
|
|
*
|
|
* ! Logique modifiée pour refonte only here (sans paiement)
|
|
*
|
|
* On peut annuler la commande si le client
|
|
* n'as pas payé et que la livraison n'a pas
|
|
* encore été initié, et la commande n'est pas
|
|
* déjà annulée.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function getCanBeCancelledAttribute(): bool
|
|
{
|
|
// * Si le status de validation n'est pas annulé
|
|
return $this->getOriginal('validation_status') !== ValidationStatus::cancelled()->value and
|
|
// * Si le status de paiement n'est pas payé
|
|
!($this->getOriginal('payment_status') === PaymentStatus::payed()->value) and
|
|
// * Si le statut de livraison n'est pas récupéré
|
|
!($this->getOriginal('delivery_status') === DeliveryStatus::recovered()->value);
|
|
}
|
|
|
|
// * SETTER
|
|
|
|
/**
|
|
* Getter reference
|
|
*
|
|
* @return void
|
|
* @throws \RuntimeException This is readonly.
|
|
*/
|
|
public function setReferenceAttribute(): void
|
|
{
|
|
throw new \RuntimeException('Reference is readonly');
|
|
}
|
|
|
|
// * METHODS
|
|
|
|
/**
|
|
* Total payed by the customer
|
|
*
|
|
* @return \Money\Money
|
|
*/
|
|
public function getTotalPayed(): Money
|
|
{
|
|
return $this->transactions->reduce(function ($previous, Transaction $actual) {
|
|
/** @var \Money\Money|null $previous */
|
|
/** @var \App\Models\Payment\Transaction $actual */
|
|
$out = new Money(0, new Currency(Str::lower(env('CASHIER_CURRENCY', 'eur'))));
|
|
if ($previous) {
|
|
$out->add($previous);
|
|
}
|
|
if ($actual->type->equals(TransactionType::debit())) {
|
|
$out->add($actual->amount);
|
|
}
|
|
return $out;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Total refunded to the customer
|
|
*
|
|
* @return \Money\Money
|
|
*/
|
|
public function getTotalRefunded(): Money
|
|
{
|
|
return $this->transactions->reduce(function ($previous, Transaction $actual) {
|
|
/** @var \Money\Money|null $previous */
|
|
/** @var \App\Models\Payment\Transaction $actual */
|
|
$out = new Money(0, new Currency(Str::lower(env('CASHIER_CURRENCY', 'eur'))));
|
|
if ($previous) {
|
|
$out->add($previous);
|
|
}
|
|
if ($actual->type->equals(TransactionType::credit())) {
|
|
$out->add($actual->amount);
|
|
}
|
|
return $out;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Has the customer been completelly refunded ?
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function isFullyRefunded(): bool
|
|
{
|
|
return $this->getTotalPayed()->subtract($this->getTotalRefunded())
|
|
->lessThanOrEqual(new Money(0, new Currency(Str::lower(env('CASHIER_CURRENCY', 'eur')))));
|
|
}
|
|
|
|
/**
|
|
* Setup reference
|
|
*
|
|
* @return void
|
|
*/
|
|
public function setUniqueOrderReference()
|
|
{
|
|
if (!$this->reference) {
|
|
$this->setRawAttributes(\array_merge(
|
|
$this->attributes,
|
|
[
|
|
'reference' => ToolboxHelper::getUniqueReference(self::class)
|
|
]
|
|
));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if order can be cancelled
|
|
*
|
|
* @param self $model
|
|
* @return void
|
|
* @throws \Illuminate\Validation\ValidationException If the order is canceled while it cannot be.
|
|
*/
|
|
public static function assertCancelStatus(self $model)
|
|
{
|
|
if (
|
|
!$model->can_be_cancelled and
|
|
$model->validation_status->equals(ValidationStatus::cancelled())
|
|
) {
|
|
throw ValidationException::withMessages(['messages' => "La commande '{$model->id}' ne peut être annulée"
|
|
]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if order can be validated
|
|
*
|
|
* @param self $model
|
|
* @return void
|
|
* @throws \Illuminate\Validation\ValidationException If the order is canceled while it cannot be.
|
|
*/
|
|
public static function assertValidateStatus(self $model)
|
|
{
|
|
if ($model->getOriginal('validation_status') === ValidationStatus::cancelled()->value) {
|
|
throw ValidationException::withMessages([
|
|
'messages' => "La commande '{$model->id}' ne peut être validée après avoir été annulée"
|
|
]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if delivery status can be changed.
|
|
*
|
|
* @param self $model
|
|
* @return void
|
|
* @throws \Illuminate\Validation\ValidationException If the order is canceled while it cannot be.
|
|
*/
|
|
public static function assertDeliveryStatusCanBeChanged(self $model)
|
|
{
|
|
$deliveryStatusHasChanged = $model->getOriginal('delivery_status') !== $model->delivery_status->value;
|
|
if ($deliveryStatusHasChanged and !$model->validation_status->equals(ValidationStatus::validated())) {
|
|
throw ValidationException::withMessages([
|
|
'messages' =>
|
|
// phpcs:ignore Generic.Files.LineLength.TooLong
|
|
"L'état de livraison de la commande ne peut être modifié car la commande '{$model->id}' n'est pas validée"
|
|
]);
|
|
}
|
|
if ($model->getOriginal('validation_status') === ValidationStatus::cancelled()->value) {
|
|
throw ValidationException::withMessages([
|
|
'messages' =>
|
|
"L'état de livraison de la commande ne peut être modifié car la commande '{$model->id}' est annulée"
|
|
]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get updated current session order
|
|
*
|
|
* @return null|\App\Models\Shop\Order
|
|
*/
|
|
public static function getCurrentOrder(): ?self
|
|
{
|
|
/** @var \App\Models\Shop\Order|null $order */
|
|
if ($order = Session::get('currentOrder')) {
|
|
// * Refresh order if exists in DB.
|
|
$order = Order::query()->where('id', $order->id)
|
|
->orWhere('reference', $order->reference)
|
|
->first() ?? $order;
|
|
}
|
|
return $order;
|
|
}
|
|
|
|
/**
|
|
* Inject the basket items into the order.
|
|
*
|
|
* @param \Gloudemans\Shoppingcart\Cart $basket
|
|
* @return void
|
|
* @throws \Illuminate\Validation\ValidationException If a product from the basket is not accessible anymore.
|
|
*/
|
|
public function assignBasket(Cart $basket): void
|
|
{
|
|
$this->basket = $basket->content();
|
|
$this->total_discounted = \intval($basket->discount());
|
|
$this->total_ttc = \intval($basket->total());
|
|
$this->total_ht = \intval($this->total_ttc - $basket->tax());
|
|
$this->total_weight = \intval($basket->weight());
|
|
}
|
|
}
|