introduce HasLabel

Author: QuentinGab

README.md

@@ -1027,6 +1027,41 @@ However, you might prefer to cast these properties to Enum objects for better ty
 
 To enable Enum casting for these properties, follow these steps:
 
+0.  **Create custom `InvoiceState` and `InvoiceType` Enums** (optional):
+
+If you're working with commonly used invoice states and types, you can use the enums provided by this package:
+
+-   `Elegantly\Invoices\Enums\InvoiceState`
+-   `Elegantly\Invoices\Enums\InvoiceType`
+
+For custom states or types, you can define your own enums.
+
+Make sure your custom enums implement the `Elegantly\Invoices\Contracts\HasLabel` contract, like so:
+
+```php
+namespace App\Enums;
+
+use Elegantly\Invoices\Contracts\HasLabel;
+
+enum InvoiceType: string implements HasLabel
+{
+    case Invoice = 'invoice';
+    case Quote = 'quote';
+    case Credit = 'credit';
+    case Proforma = 'proforma';
+
+    public function getLabel(): string
+    {
+        return match ($this) {
+            self::Invoice => __('invoices::invoice.types.invoice'),
+            self::Quote => __('invoices::invoice.types.quote'),
+            self::Credit => __('invoices::invoice.types.credit'),
+            self::Proforma => __('invoices::invoice.types.proforma'),
+        };
+    }
+}
+```
+
 1.  **Create a Custom `Invoice` Model**:
 
 Define your own `App\Models\Invoice` class that extends `\Elegantly\Invoices\Models\Invoice`.
@@ -1038,8 +1073,17 @@ namespace App\Models;
 use Elegantly\Invoices\Enums\InvoiceState;
 use Elegantly\Invoices\Enums\InvoiceType;
 
+/**
+ * @property InvoiceType $type
+ * @property InvoiceState $state
+ */
 class Invoice extends \Elegantly\Invoices\Models\Invoice
 {
+    protected $attributes = [
+        'type' => InvoiceType::Invoice->value,
+        'state' => InvoiceState::Draft->value,
+    ];
+
     protected function casts(): array
     {
         return [

resources/views/default/invoice.blade.php

@@ -4,10 +4,10 @@
             <tr>
                 <td class="p-0 align-top">
                     <h1 class="mb-1 text-2xl">
-                        <strong>{{ $invoice->type }}</strong>
+                        <strong>{{ $invoice->getTypeLabel() }}</strong>
                     </h1>
                     <p class="mb-5 text-sm">
-                        {{ $invoice->state }}
+                        {{ $invoice->getStateLabel() }}
                     </p>
 
                     <table class="w-full">

src/Concerns/FormatForPdf.php

@@ -5,6 +5,7 @@
 namespace Elegantly\Invoices\Concerns;
 
 use Brick\Money\Money;
+use Illuminate\Support\Facades\App;
 use NumberFormatter;
 
 trait FormatForPdf
@@ -20,8 +21,10 @@ public function formatPercentage(null|float|int $percentage, ?string $locale = n
             return null;
         }
 
-        $formatter = new NumberFormatter($locale ?? app()->getLocale(), NumberFormatter::PERCENT);
+        $percentage = ($percentage > 1) ? ($percentage / 100) : $percentage;
 
-        return $formatter->format(($percentage > 1) ? ($percentage / 100) : $percentage);
+        $formatter = new NumberFormatter($locale ?? App::getLocale(), NumberFormatter::PERCENT);
+
+        return $formatter->format($percentage);
     }
 }

src/Contracts/HasLabel.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Elegantly\Invoices\Contracts;
+
+interface HasLabel
+{
+    public function getLabel(): ?string;
+}

src/Enums/InvoiceState.php

@@ -4,7 +4,9 @@
 
 namespace Elegantly\Invoices\Enums;
 
-enum InvoiceState: string
+use Elegantly\Invoices\Contracts\HasLabel;
+
+enum InvoiceState: string implements HasLabel
 {
     case Draft = 'draft';
     case Pending = 'pending';

src/Enums/InvoiceType.php

@@ -4,7 +4,9 @@
 
 namespace Elegantly\Invoices\Enums;
 
-enum InvoiceType: string
+use Elegantly\Invoices\Contracts\HasLabel;
+
+enum InvoiceType: string implements HasLabel
 {
     case Invoice = 'invoice';
     case Quote = 'quote';

src/InvoiceServiceProvider.php

@@ -4,12 +4,14 @@
 
 namespace Elegantly\Invoices;
 
+use BackedEnum;
 use Elegantly\Invoices\Commands\DenormalizeInvoicesCommand;
-use Elegantly\Invoices\Enums\InvoiceType;
 use Exception;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
+use function Illuminate\Support\enum_value;
+
 class InvoiceServiceProvider extends PackageServiceProvider
 {
     public function configurePackage(Package $package): void
@@ -34,9 +36,10 @@ public function configurePackage(Package $package): void
             ->hasMigration('migrate_serial_number_details_columns_to_invoices_table');
     }
 
-    public static function getSerialNumberPrefixConfiguration(null|string|InvoiceType $type): ?string
+    public static function getSerialNumberPrefixConfiguration(null|string|BackedEnum $type): ?string
     {
-        $value = $type instanceof InvoiceType ? $type->value : $type;
+        /** @var null|int|string */
+        $value = enum_value($type);
 
         /** @var string|array<string, string> $prefixes */
         $prefixes = config('invoices.serial_number.prefix', '');
@@ -48,9 +51,10 @@ public static function getSerialNumberPrefixConfiguration(null|string|InvoiceTyp
         return $prefixes[$value] ?? null;
     }
 
-    public static function getSerialNumberFormatConfiguration(null|string|InvoiceType $type): string
+    public static function getSerialNumberFormatConfiguration(null|string|BackedEnum $type): string
     {
-        $value = $type instanceof InvoiceType ? $type->value : $type;
+        /** @var null|int|string */
+        $value = enum_value($type);
 
         /** @var string|array<string, string> $formats */
         $formats = config('invoices.serial_number.format') ?? '';

src/Models/Invoice.php

@@ -7,6 +7,7 @@
 use Brick\Money\Money;
 use Carbon\Carbon;
 use Elegantly\Invoices\Casts\Discounts;
+use Elegantly\Invoices\Contracts\HasLabel;
 use Elegantly\Invoices\Database\Factories\InvoiceFactory;
 use Elegantly\Invoices\Enums\InvoiceState;
 use Elegantly\Invoices\Enums\InvoiceType;
@@ -465,12 +466,12 @@ public function getLogo(): ?string
         return null;
     }
 
-    public function getType(): string|InvoiceType
+    public function getType(): string|HasLabel
     {
         return InvoiceType::tryFrom($this->type) ?? $this->type;
     }
 
-    public function getState(): string|InvoiceState
+    public function getState(): string|HasLabel
     {
         return InvoiceState::tryFrom($this->state) ?? $this->state;
     }

src/Pdf/PdfInvoice.php

@@ -9,6 +9,7 @@
 use Carbon\Carbon;
 use Dompdf\Dompdf;
 use Elegantly\Invoices\Concerns\FormatForPdf;
+use Elegantly\Invoices\Contracts\HasLabel;
 use Elegantly\Invoices\Enums\InvoiceState;
 use Elegantly\Invoices\Enums\InvoiceType;
 use Elegantly\Invoices\InvoiceDiscount;
@@ -25,10 +26,6 @@ class PdfInvoice
 {
     use FormatForPdf;
 
-    public string $type;
-
-    public string $state;
-
     public string $template;
 
     /**
@@ -40,8 +37,8 @@ class PdfInvoice
      * @param  array<string, mixed>  $templateData
      */
     public function __construct(
-        InvoiceType|string $type = InvoiceType::Invoice,
-        InvoiceState|string $state = InvoiceState::Draft,
+        public HasLabel|string $type = InvoiceType::Invoice,
+        public HasLabel|string $state = InvoiceState::Draft,
         public ?string $serial_number = null,
         public ?Carbon $created_at = null,
         public ?Carbon $due_at = null,
@@ -63,9 +60,6 @@ public function __construct(
 
         public ?string $logo = null,
     ) {
-        $this->type = $type instanceof InvoiceType ? $type->getLabel() : $type;
-        $this->state = $state instanceof InvoiceState ? $state->getLabel() : $state;
-
         // @phpstan-ignore-next-line
         $this->logo = $logo ?? config('invoices.pdf.logo') ?? config('invoices.default_logo');
         // @phpstan-ignore-next-line
@@ -74,6 +68,16 @@ public function __construct(
         $this->templateData = config('invoices.pdf.template_data') ?? [];
     }
 
+    public function getTypeLabel(): ?string
+    {
+        return $this->type instanceof HasLabel ? $this->type->getLabel() : $this->type;
+    }
+
+    public function getStateLabel(): ?string
+    {
+        return $this->state instanceof HasLabel ? $this->state->getLabel() : $this->state;
+    }
+
     public function getFilename(): string
     {
         return str($this->serial_number)