blax-software
/
laravel-shop
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

style: pint the files touched by the OrderPaid / shop.models.order fix 

Formatting only (laravel preset via pint.json): import ordering, FQCN -> use,
`new X()` -> `new X`, `!` spacing, phpdoc trims, braces on one-line continue.
No behaviour change; suite re-run green (1485 tests).

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
Fabian @ Blax Software 2026-09-24 08:24:59 +02:00
parent 0d9823df04
commit 08e459959e
3 changed files with 245 additions and 235 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

355
src/Models/Cart.php
View File

File diff suppressed because it is too large Load Diff

67
src/Models/Order.php
View File

@ -6,6 +6,8 @@ namespace Blax\Shop\Models;
use Blax\Shop\Enums\OrderStatus; use Blax\Shop\Enums\OrderStatus;
use Blax\Shop\Enums\PurchaseStatus; use Blax\Shop\Enums\PurchaseStatus;
use Blax\Shop\Events\OrderCreated;
use Blax\Shop\Events\OrderPaid;
use Illuminate\Database\Eloquent\Concerns\HasUuids; use Illuminate\Database\Eloquent\Concerns\HasUuids;
use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Model;
@ -14,17 +16,18 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\HasManyThrough; use Illuminate\Database\Eloquent\Relations\HasManyThrough;
use Illuminate\Database\Eloquent\Relations\MorphTo; use Illuminate\Database\Eloquent\Relations\MorphTo;
use Illuminate\Database\Eloquent\SoftDeletes; use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\DB;
/** /**
* Order model representing a completed/paid cart. * Order model representing a completed/paid cart.
* *
* Orders are created when a cart is converted (checked out) and represent * Orders are created when a cart is converted (checked out) and represent
* a customer's purchase transaction with full tracking capabilities. * a customer's purchase transaction with full tracking capabilities.
*/ */
class Order extends Model class Order extends Model
{ {
use HasUuids, HasFactory, SoftDeletes; use HasFactory, HasUuids, SoftDeletes;
protected $fillable = [ protected $fillable = [
'order_number', 'order_number',
@ -89,7 +92,7 @@ class Order extends Model
]; ];
protected $dispatchesEvents = [ protected $dispatchesEvents = [
'created' => \Blax\Shop\Events\OrderCreated::class, 'created' => OrderCreated::class,
]; ];
public function __construct(array $attributes = []) public function __construct(array $attributes = [])
@ -129,19 +132,19 @@ class Order extends Model
); );
// Set timestamp fields based on status // Set timestamp fields based on status
if ($newStatus === OrderStatus::COMPLETED && !$order->completed_at) { if ($newStatus === OrderStatus::COMPLETED && ! $order->completed_at) {
$order->completed_at = now(); $order->completed_at = now();
} }
if ($newStatus === OrderStatus::SHIPPED && !$order->shipped_at) { if ($newStatus === OrderStatus::SHIPPED && ! $order->shipped_at) {
$order->shipped_at = now(); $order->shipped_at = now();
} }
if ($newStatus === OrderStatus::DELIVERED && !$order->delivered_at) { if ($newStatus === OrderStatus::DELIVERED && ! $order->delivered_at) {
$order->delivered_at = now(); $order->delivered_at = now();
} }
if ($newStatus === OrderStatus::CANCELLED && !$order->cancelled_at) { if ($newStatus === OrderStatus::CANCELLED && ! $order->cancelled_at) {
$order->cancelled_at = now(); $order->cancelled_at = now();
} }
if ($newStatus === OrderStatus::REFUNDED && !$order->refunded_at) { if ($newStatus === OrderStatus::REFUNDED && ! $order->refunded_at) {
$order->refunded_at = now(); $order->refunded_at = now();
} }
} }
@ -155,13 +158,13 @@ class Order extends Model
if ($difference > 0) { if ($difference > 0) {
$currency = $order->currency ?? config('shop.currency', 'USD'); $currency = $order->currency ?? config('shop.currency', 'USD');
$order->addNote( $order->addNote(
"Payment received: " . static::formatMoney($difference, $currency), 'Payment received: '.static::formatMoney($difference, $currency),
'payment', 'payment',
true true
); );
// Mark as paid if fully paid // Mark as paid if fully paid
if (!$order->paid_at && $newPaid >= $order->amount_total) { if (! $order->paid_at && $newPaid >= $order->amount_total) {
$order->paid_at = now(); $order->paid_at = now();
} }
} }
@ -174,8 +177,8 @@ class Order extends Model
// an already-paid order (status moves, meta touches) must not re-fire, // an already-paid order (status moves, meta touches) must not re-fire,
// and a host subclass configured via shop.models.order gets it too. // and a host subclass configured via shop.models.order gets it too.
static::updated(function (Order $order) { static::updated(function (Order $order) {
if ($order->wasChanged('paid_at') && $order->paid_at && !$order->getOriginal('paid_at')) { if ($order->wasChanged('paid_at') && $order->paid_at && ! $order->getOriginal('paid_at')) {
\Blax\Shop\Events\OrderPaid::dispatch($order); OrderPaid::dispatch($order);
} }
}); });
} }
@ -211,7 +214,8 @@ class Order extends Model
public static function formatMoney(int $amount, string $currency = 'USD'): string public static function formatMoney(int $amount, string $currency = 'USD'): string
{ {
$formatted = number_format($amount / 100, 2); $formatted = number_format($amount / 100, 2);
return strtoupper($currency) . ' ' . $formatted;
return strtoupper($currency).' '.$formatted;
} }
// ========================================================================= // =========================================================================
@ -304,12 +308,12 @@ class Order extends Model
/** /**
* Update the order status with validation. * Update the order status with validation.
* *
* @throws \InvalidArgumentException if transition is not allowed * @throws \InvalidArgumentException if transition is not allowed
*/ */
public function updateStatus(OrderStatus $newStatus, ?string $note = null): self public function updateStatus(OrderStatus $newStatus, ?string $note = null): self
{ {
if ($this->status && !$this->status->canTransitionTo($newStatus)) { if ($this->status && ! $this->status->canTransitionTo($newStatus)) {
throw new \InvalidArgumentException( throw new \InvalidArgumentException(
"Cannot transition order from '{$this->status->label()}' to '{$newStatus->label()}'" "Cannot transition order from '{$this->status->label()}' to '{$newStatus->label()}'"
); );
@ -462,7 +466,7 @@ class Order extends Model
$currency = $this->currency ?? config('shop.currency', 'USD'); $currency = $this->currency ?? config('shop.currency', 'USD');
$this->addNote( $this->addNote(
"Refund processed: " . static::formatMoney($amount, $currency) . 'Refund processed: '.static::formatMoney($amount, $currency).
($reason ? " - Reason: {$reason}" : ''), ($reason ? " - Reason: {$reason}" : ''),
'refund', 'refund',
true true
@ -487,7 +491,7 @@ class Order extends Model
* @param string $content The note content * @param string $content The note content
* @param string $type The note type (note, status_change, payment, etc.) * @param string $type The note type (note, status_change, payment, etc.)
* @param bool $isCustomerNote Whether the note is visible to the customer * @param bool $isCustomerNote Whether the note is visible to the customer
* @param \Illuminate\Database\Eloquent\Model|null $author The author model (User, Admin, etc.) * @param Model|null $author The author model (User, Admin, etc.)
* @param array|object|null $meta Additional metadata * @param array|object|null $meta Additional metadata
*/ */
public function addNote( public function addNote(
@ -533,7 +537,7 @@ class Order extends Model
public function getMeta(?string $key = null, $default = null) public function getMeta(?string $key = null, $default = null)
{ {
if ($key === null) { if ($key === null) {
return $this->meta ?? new \stdClass(); return $this->meta ?? new \stdClass;
} }
return $this->meta?->{$key} ?? $default; return $this->meta?->{$key} ?? $default;
@ -544,7 +548,7 @@ class Order extends Model
*/ */
public function updateMetaKey(string $key, $value): self public function updateMetaKey(string $key, $value): self
{ {
$meta = (array) ($this->meta ?? new \stdClass()); $meta = (array) ($this->meta ?? new \stdClass);
$meta[$key] = $value; $meta[$key] = $value;
$this->meta = (object) $meta; $this->meta = (object) $meta;
$this->save(); $this->save();
@ -569,7 +573,7 @@ class Order extends Model
*/ */
public function scopeWithStatuses($query, array $statuses) public function scopeWithStatuses($query, array $statuses)
{ {
return $query->whereIn('status', array_map(fn($s) => $s->value, $statuses)); return $query->whereIn('status', array_map(fn ($s) => $s->value, $statuses));
} }
/** /**
@ -594,8 +598,8 @@ class Order extends Model
public function scopeFinal($query) public function scopeFinal($query)
{ {
$finalStatuses = array_map( $finalStatuses = array_map(
fn(OrderStatus $status) => $status->value, fn (OrderStatus $status) => $status->value,
array_filter(OrderStatus::cases(), fn(OrderStatus $status) => $status->isFinal()) array_filter(OrderStatus::cases(), fn (OrderStatus $status) => $status->isFinal())
); );
return $query->whereIn('status', $finalStatuses); return $query->whereIn('status', $finalStatuses);
@ -616,8 +620,8 @@ class Order extends Model
public function scopeRequiresPayment($query) public function scopeRequiresPayment($query)
{ {
$requiresPaymentStatuses = array_map( $requiresPaymentStatuses = array_map(
fn(OrderStatus $status) => $status->value, fn (OrderStatus $status) => $status->value,
array_filter(OrderStatus::cases(), fn(OrderStatus $status) => $status->requiresPayment()) array_filter(OrderStatus::cases(), fn (OrderStatus $status) => $status->requiresPayment())
); );
return $query->whereIn('status', $requiresPaymentStatuses); return $query->whereIn('status', $requiresPaymentStatuses);
@ -630,8 +634,8 @@ class Order extends Model
public function scopeStatusPaid($query) public function scopeStatusPaid($query)
{ {
$paidStatuses = array_map( $paidStatuses = array_map(
fn(OrderStatus $status) => $status->value, fn (OrderStatus $status) => $status->value,
array_filter(OrderStatus::cases(), fn(OrderStatus $status) => $status->isPaid()) array_filter(OrderStatus::cases(), fn (OrderStatus $status) => $status->isPaid())
); );
return $query->whereIn('status', $paidStatuses); return $query->whereIn('status', $paidStatuses);
@ -789,6 +793,7 @@ class Order extends Model
public static function getNetRevenue(): int public static function getNetRevenue(): int
{ {
$result = static::selectRaw('COALESCE(SUM(amount_paid), 0) - COALESCE(SUM(amount_refunded), 0) as net')->first(); $result = static::selectRaw('COALESCE(SUM(amount_paid), 0) - COALESCE(SUM(amount_refunded), 0) as net')->first();
return (int) $result->net; return (int) $result->net;
} }
@ -827,7 +832,7 @@ class Order extends Model
public static function getRevenueSummary(\DateTimeInterface $from, \DateTimeInterface $until): array public static function getRevenueSummary(\DateTimeInterface $from, \DateTimeInterface $until): array
{ {
$stats = static::createdBetween($from, $until) $stats = static::createdBetween($from, $until)
->selectRaw(" ->selectRaw('
COUNT(*) as total_orders, COUNT(*) as total_orders,
SUM(CASE WHEN status = ? THEN 1 ELSE 0 END) as completed, SUM(CASE WHEN status = ? THEN 1 ELSE 0 END) as completed,
SUM(CASE WHEN amount_paid > 0 THEN 1 ELSE 0 END) as paid, SUM(CASE WHEN amount_paid > 0 THEN 1 ELSE 0 END) as paid,
@ -837,7 +842,7 @@ class Order extends Model
COALESCE(SUM(amount_refunded), 0) as refunded, COALESCE(SUM(amount_refunded), 0) as refunded,
COALESCE(AVG(amount_total), 0) as avg_order_value, COALESCE(AVG(amount_total), 0) as avg_order_value,
COALESCE(AVG(amount_paid), 0) as avg_paid_amount COALESCE(AVG(amount_paid), 0) as avg_paid_amount
", [OrderStatus::COMPLETED->value]) ', [OrderStatus::COMPLETED->value])
->first(); ->first();
return [ return [
@ -867,7 +872,7 @@ class Order extends Model
/** /**
* Get daily revenue breakdown for a date range. * Get daily revenue breakdown for a date range.
*/ */
public static function getDailyRevenue(\DateTimeInterface $from, \DateTimeInterface $until): \Illuminate\Support\Collection public static function getDailyRevenue(\DateTimeInterface $from, \DateTimeInterface $until): Collection
{ {
return static::createdBetween($from, $until) return static::createdBetween($from, $until)
->selectRaw('DATE(created_at) as date') ->selectRaw('DATE(created_at) as date')
@ -883,7 +888,7 @@ class Order extends Model
/** /**
* Get monthly revenue breakdown for a date range. * Get monthly revenue breakdown for a date range.
*/ */
public static function getMonthlyRevenue(\DateTimeInterface $from, \DateTimeInterface $until): \Illuminate\Support\Collection public static function getMonthlyRevenue(\DateTimeInterface $from, \DateTimeInterface $until): Collection
{ {
return static::createdBetween($from, $until) return static::createdBetween($from, $until)
->selectRaw('YEAR(created_at) as year') ->selectRaw('YEAR(created_at) as year')
@ -907,7 +912,7 @@ class Order extends Model
*/ */
public static function createFromCart(Cart $cart): self public static function createFromCart(Cart $cart): self
{ {
if (!$cart->converted_at) { if (! $cart->converted_at) {
throw new \InvalidArgumentException('Cart must be converted before creating an order'); throw new \InvalidArgumentException('Cart must be converted before creating an order');
} }

58
src/Services/ShopService.php
View File

@ -12,12 +12,15 @@ use Blax\Shop\Models\Order;
use Blax\Shop\Models\Product; use Blax\Shop\Models\Product;
use Blax\Shop\Models\ProductCategory; use Blax\Shop\Models\ProductCategory;
use Blax\Shop\Models\ProductPrice; use Blax\Shop\Models\ProductPrice;
use Blax\Shop\Models\ProductPurchase;
use Blax\Shop\Models\StripeTransaction; use Blax\Shop\Models\StripeTransaction;
use Blax\Shop\Models\Subscription; use Blax\Shop\Models\Subscription;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection; use Illuminate\Database\Eloquent\Collection;
use Carbon\Carbon; use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\Log;
use Stripe\Charge;
use Stripe\Stripe;
class ShopService class ShopService
{ {
@ -27,8 +30,6 @@ class ShopService
/** /**
* Get all products query builder * Get all products query builder
*
* @return Builder
*/ */
public function products(): Builder public function products(): Builder
{ {
@ -38,8 +39,7 @@ class ShopService
/** /**
* Get a product by ID * Get a product by ID
* *
* @param mixed $id * @param mixed $id
* @return Product|null
*/ */
public function product($id): ?Product public function product($id): ?Product
{ {
@ -48,8 +48,6 @@ class ShopService
/** /**
* Get all categories query builder * Get all categories query builder
*
* @return Builder
*/ */
public function categories(): Builder public function categories(): Builder
{ {
@ -58,8 +56,6 @@ class ShopService
/** /**
* Get in-stock products * Get in-stock products
*
* @return Builder
*/ */
public function inStock(): Builder public function inStock(): Builder
{ {
@ -68,8 +64,6 @@ class ShopService
/** /**
* Get featured products * Get featured products
*
* @return Builder
*/ */
public function featured(): Builder public function featured(): Builder
{ {
@ -78,8 +72,6 @@ class ShopService
/** /**
* Get published and visible products * Get published and visible products
*
* @return Builder
*/ */
public function published(): Builder public function published(): Builder
{ {
@ -88,9 +80,6 @@ class ShopService
/** /**
* Search products by query * Search products by query
*
* @param string $query
* @return Builder
*/ */
public function search(string $query): Builder public function search(string $query): Builder
{ {
@ -103,14 +92,10 @@ class ShopService
/** /**
* Check if product has available stock for quantity * Check if product has available stock for quantity
*
* @param Product $product
* @param int $quantity
* @return bool
*/ */
public function checkStock(Product $product, int $quantity): bool public function checkStock(Product $product, int $quantity): bool
{ {
if (!$product->manage_stock) { if (! $product->manage_stock) {
return true; return true;
} }
@ -119,13 +104,10 @@ class ShopService
/** /**
* Get available stock for a product * Get available stock for a product
*
* @param Product $product
* @return int
*/ */
public function getAvailableStock(Product $product): int public function getAvailableStock(Product $product): int
{ {
if (!$product->manage_stock) { if (! $product->manage_stock) {
return PHP_INT_MAX; return PHP_INT_MAX;
} }
@ -134,9 +116,6 @@ class ShopService
/** /**
* Check if product is on sale * Check if product is on sale
*
* @param Product $product
* @return bool
*/ */
public function isOnSale(Product $product): bool public function isOnSale(Product $product): bool
{ {
@ -405,7 +384,7 @@ class ShopService
$startOfYear = Carbon::now()->startOfYear(); $startOfYear = Carbon::now()->startOfYear();
$endOfYear = Carbon::now()->endOfYear(); $endOfYear = Carbon::now()->endOfYear();
$orderStats = $this->orderModel()::selectRaw(" $orderStats = $this->orderModel()::selectRaw('
COUNT(*) as total, COUNT(*) as total,
SUM(CASE WHEN status = ? THEN 1 ELSE 0 END) as pending, SUM(CASE WHEN status = ? THEN 1 ELSE 0 END) as pending,
SUM(CASE WHEN status = ? THEN 1 ELSE 0 END) as processing, SUM(CASE WHEN status = ? THEN 1 ELSE 0 END) as processing,
@ -421,7 +400,7 @@ class ShopService
COALESCE(SUM(CASE WHEN created_at BETWEEN ? AND ? THEN amount_paid ELSE 0 END), 0) as revenue_this_year, COALESCE(SUM(CASE WHEN created_at BETWEEN ? AND ? THEN amount_paid ELSE 0 END), 0) as revenue_this_year,
COALESCE(SUM(amount_refunded), 0) as total_refunded, COALESCE(SUM(amount_refunded), 0) as total_refunded,
COALESCE(AVG(amount_total), 0) as average_order COALESCE(AVG(amount_total), 0) as average_order
", [ ', [
OrderStatus::PENDING->value, OrderStatus::PENDING->value,
OrderStatus::PROCESSING->value, OrderStatus::PROCESSING->value,
OrderStatus::COMPLETED->value, OrderStatus::COMPLETED->value,
@ -925,8 +904,7 @@ class ShopService
/** /**
* Get shop configuration value * Get shop configuration value
* *
* @param string $key * @param mixed $default
* @param mixed $default
* @return mixed * @return mixed
*/ */
public function config(string $key, $default = null) public function config(string $key, $default = null)
@ -936,8 +914,6 @@ class ShopService
/** /**
* Get default shop currency * Get default shop currency
*
* @return string
*/ */
public function currency(): string public function currency(): string
{ {
@ -952,7 +928,7 @@ class ShopService
$currency = $currency ?? $this->currency(); $currency = $currency ?? $this->currency();
$amount = $cents / 100; $amount = $cents / 100;
return number_format($amount, 2) . ' ' . strtoupper($currency); return number_format($amount, 2).' '.strtoupper($currency);
} }
// ========================================================================= // =========================================================================
@ -962,7 +938,7 @@ class ShopService
/** /**
* The configured {@see StripeTransaction} model class. * The configured {@see StripeTransaction} model class.
* *
* @return class-string<\Illuminate\Database\Eloquent\Model> * @return class-string<Model>
*/ */
protected function ledgerModel(): string protected function ledgerModel(): string
{ {
@ -1061,7 +1037,7 @@ class ShopService
* sum misses (they are stored there as amount=0). * sum misses (they are stored there as amount=0).
* *
* @param string|array<int,string> $customerIds Stripe customer id(s) (cus_…) * @param string|array<int,string> $customerIds Stripe customer id(s) (cus_…)
* @param string|array<int,string> $emails buyer email(s) * @param string|array<int,string> $emails buyer email(s)
* @return array{amount: int, gross: int, refunds: int, fees: int, net: int, count: int} * @return array{amount: int, gross: int, refunds: int, fees: int, net: int, count: int}
*/ */
public function customerLedgerTotals( public function customerLedgerTotals(
@ -1233,8 +1209,8 @@ class ShopService
} }
try { try {
\Stripe\Stripe::setApiKey($secret); Stripe::setApiKey($secret);
$charge = \Stripe\Charge::retrieve([ $charge = Charge::retrieve([
'id' => $chargeId, 'id' => $chargeId,
'expand' => ['balance_transaction', 'refunds.data.balance_transaction'], 'expand' => ['balance_transaction', 'refunds.data.balance_transaction'],
]); ]);
@ -1254,7 +1230,7 @@ class ShopService
return $count; return $count;
} catch (\Throwable $e) { } catch (\Throwable $e) {
\Illuminate\Support\Facades\Log::warning('[shop:ledger] syncLedgerForCharge failed', [ Log::warning('[shop:ledger] syncLedgerForCharge failed', [
'charge' => $chargeId, 'charge' => $chargeId,
'error' => $e->getMessage(), 'error' => $e->getMessage(),
]); ]);