Feature: Product option types to support multiple cases
This commit is contained in:
@@ -16,4 +16,23 @@ return [
|
|||||||
|
|
||||||
'auto_create_customer_for_user' => true,
|
'auto_create_customer_for_user' => true,
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Product Option Types
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Enabled `Modules\Core\Product\Contracts\ProductOptionTypeInterface`
|
||||||
|
| implementations, describing what structured data a ProductOption's
|
||||||
|
| values carry in their `meta` jsonb column, and how an admin edits it.
|
||||||
|
| An admin picks one per ProductOption from a dropdown built from this
|
||||||
|
| list (stored in ProductOption::meta, not tied to the option's handle) —
|
||||||
|
| a ProductOption with none selected has no described meta behavior,
|
||||||
|
| plain name/position only.
|
||||||
|
|
|
||||||
|
| \App\ProductOptions\ColorOptionType::class,
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'product_option_types' => [],
|
||||||
|
|
||||||
];
|
];
|
||||||
|
|||||||
@@ -0,0 +1,105 @@
|
|||||||
|
# Product Option Types
|
||||||
|
|
||||||
|
Lunar's `ProductOption`/`ProductOptionValue` are generic by design — a "Color" option
|
||||||
|
and a "Size" option are both just a handle, a translated name, and a list of values.
|
||||||
|
Each `ProductOptionValue` carries a free-form `meta` jsonb column, but nothing in
|
||||||
|
Lunar's own admin UI exposes it — there's no way for an admin to, say, attach a hex
|
||||||
|
code to a "Red" value without editing the database directly.
|
||||||
|
|
||||||
|
`Modules\Core\Product\Contracts\ProductOptionTypeInterface` describes how a category
|
||||||
|
of option behaves — what structured data its values carry in `meta`, and how an
|
||||||
|
admin edits that data — without introducing a new model. `ProductOption`/
|
||||||
|
`ProductOptionValue` stay exactly as Lunar defines them.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Registering a type
|
||||||
|
|
||||||
|
A shop enables a type class in `config/core.php`:
|
||||||
|
|
||||||
|
```php
|
||||||
|
// config/core.php
|
||||||
|
'product_option_types' => [
|
||||||
|
\App\ProductOptions\ColorOptionType::class,
|
||||||
|
],
|
||||||
|
```
|
||||||
|
|
||||||
|
This is a plain list, **not** keyed by `ProductOption::handle` — a shop's own handle
|
||||||
|
naming (transliterated Greek, legacy import slugs, whatever an admin happened to type
|
||||||
|
when creating the option) shouldn't have to match a type's key. Instead, an admin
|
||||||
|
picks a type per-option from a dropdown on the `ProductOption` edit form itself (see
|
||||||
|
below); the choice is stored in `ProductOption::meta['option_type']`, not inferred
|
||||||
|
from anything else.
|
||||||
|
|
||||||
|
A `ProductOption` with no type selected behaves exactly as stock Lunar does — plain
|
||||||
|
name/position, no extra meta form.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Writing a type
|
||||||
|
|
||||||
|
```php
|
||||||
|
namespace App\ProductOptions;
|
||||||
|
|
||||||
|
use Filament\Forms\Components\ColorPicker;
|
||||||
|
use Modules\Core\Product\Contracts\ProductOptionTypeInterface;
|
||||||
|
|
||||||
|
class ColorOptionType implements ProductOptionTypeInterface
|
||||||
|
{
|
||||||
|
public static function getKey(): string
|
||||||
|
{
|
||||||
|
return 'color';
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getMetaForm(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
ColorPicker::make('meta.hex')
|
||||||
|
->label('Color')
|
||||||
|
->required(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`getMetaForm()` returns Filament form components, keyed under `meta.*` dot notation
|
||||||
|
— the path they save to on `ProductOptionValue::meta` (cast as `AsArrayObject`, a
|
||||||
|
plain jsonb column). `getKey()` is the identifier used in the admin's "Option Type"
|
||||||
|
dropdown and in `ProductOption::meta['option_type']` — it has no relationship to the
|
||||||
|
`ProductOption::handle`.
|
||||||
|
|
||||||
|
A reference implementation ships at `Modules\Core\Product\OptionTypes\ColorOptionType`
|
||||||
|
— not auto-registered, since registration is always an explicit shop decision.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## How it's wired into the admin UI
|
||||||
|
|
||||||
|
`Modules\Core\Product\Services\ProductOptionTypeManager`:
|
||||||
|
- `all(): Collection<string, ProductOptionTypeInterface>` — every enabled type,
|
||||||
|
keyed by `getKey()`.
|
||||||
|
- `resolve(?string $key): ?ProductOptionTypeInterface` — looks up one by key (or
|
||||||
|
`null` if no key / not found).
|
||||||
|
|
||||||
|
Two extensions hook into Lunar's admin via its extension system
|
||||||
|
(`LunarPanel::extensions([...])`, registered in `CorePlugin`) — no forking of Lunar's
|
||||||
|
classes needed:
|
||||||
|
|
||||||
|
- `Modules\Core\Product\Filament\Extensions\ProductOptionResourceExtension` extends
|
||||||
|
`Lunar\Admin\Filament\Resources\ProductOptionResource`'s own form with a `Select`
|
||||||
|
(`meta.option_type`) listing every enabled type's key. Shown only when at least one
|
||||||
|
type is enabled.
|
||||||
|
- `Modules\Core\Product\Filament\Extensions\ValuesRelationManagerExtension` extends
|
||||||
|
the "Values" tab's form. Its `extendForm()` reads
|
||||||
|
`$option->meta['option_type']` off the owning `ProductOption`, resolves it via
|
||||||
|
`ProductOptionTypeManager`, and appends `getMetaForm()`'s fields to the stock name
|
||||||
|
field. A `ProductOption` with no type selected gets the stock form unchanged.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Reading the value back
|
||||||
|
|
||||||
|
Storefront code reads `ProductOptionValue::meta` like any other jsonb column — e.g.
|
||||||
|
`$value->meta['hex']` for a color swatch. `ProductOptionTypeManager` is an admin-side
|
||||||
|
concern only (describing *how to edit* the meta); nothing requires the storefront to
|
||||||
|
go through it to *read* the meta.
|
||||||
@@ -6,6 +6,8 @@ use Filament\Contracts\Plugin;
|
|||||||
use Filament\Panel;
|
use Filament\Panel;
|
||||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||||
use Illuminate\Support\Facades\Mail;
|
use Illuminate\Support\Facades\Mail;
|
||||||
|
use Lunar\Admin\Filament\Resources\ProductOptionResource;
|
||||||
|
use Lunar\Admin\Filament\Resources\ProductOptionResource\RelationManagers\ValuesRelationManager;
|
||||||
use Lunar\Admin\Filament\Resources\ProductResource;
|
use Lunar\Admin\Filament\Resources\ProductResource;
|
||||||
use Lunar\Admin\Filament\Resources\StaffResource;
|
use Lunar\Admin\Filament\Resources\StaffResource;
|
||||||
use Lunar\Admin\Models\Staff as LunarStaff;
|
use Lunar\Admin\Models\Staff as LunarStaff;
|
||||||
@@ -16,6 +18,8 @@ use Modules\Core\Auth\Extensions\StaffResourceExtension;
|
|||||||
use Modules\Core\Auth\Filament\Pages\Login;
|
use Modules\Core\Auth\Filament\Pages\Login;
|
||||||
use Modules\Core\Auth\Mail\InviteMail;
|
use Modules\Core\Auth\Mail\InviteMail;
|
||||||
use Modules\Core\Localization\Filament\Resources\LanguageLineResource;
|
use Modules\Core\Localization\Filament\Resources\LanguageLineResource;
|
||||||
|
use Modules\Core\Product\Filament\Extensions\ProductOptionResourceExtension;
|
||||||
|
use Modules\Core\Product\Filament\Extensions\ValuesRelationManagerExtension;
|
||||||
use Modules\Core\Review\Extensions\ProductResourceExtension;
|
use Modules\Core\Review\Extensions\ProductResourceExtension;
|
||||||
use Modules\Core\Review\Models\ProductReview;
|
use Modules\Core\Review\Models\ProductReview;
|
||||||
|
|
||||||
@@ -41,6 +45,8 @@ class CorePlugin implements Plugin
|
|||||||
LunarPanel::extensions([
|
LunarPanel::extensions([
|
||||||
StaffResource::class => StaffResourceExtension::class,
|
StaffResource::class => StaffResourceExtension::class,
|
||||||
ProductResource::class => ProductResourceExtension::class,
|
ProductResource::class => ProductResourceExtension::class,
|
||||||
|
ProductOptionResource::class => ProductOptionResourceExtension::class,
|
||||||
|
ValuesRelationManager::class => ValuesRelationManagerExtension::class,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
Product::macro('reviews', function (): HasMany {
|
Product::macro('reviews', function (): HasMany {
|
||||||
|
|||||||
+6
-6
@@ -1,6 +1,6 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace Modules\Core\Catalog;
|
namespace Modules\Core\Product\Contracts;
|
||||||
|
|
||||||
use Filament\Forms\Components\Component;
|
use Filament\Forms\Components\Component;
|
||||||
|
|
||||||
@@ -10,10 +10,10 @@ use Filament\Forms\Components\Component;
|
|||||||
* carry in their free-form `meta` jsonb column, and how an admin edits that data.
|
* carry in their free-form `meta` jsonb column, and how an admin edits that data.
|
||||||
*
|
*
|
||||||
* `ProductOption`/`ProductOptionValue` themselves stay exactly as Lunar defines
|
* `ProductOption`/`ProductOptionValue` themselves stay exactly as Lunar defines
|
||||||
* them — this is not a new model, just a registry (ProductOptionTypeRegistry) that
|
* them — this is not a new model. `ProductOptionTypeManager` maps a
|
||||||
* maps a `ProductOption::handle` to the type describing it, so adding a new kind of
|
* `ProductOption::handle` to the type describing it (via `config('core.product_option_types')`,
|
||||||
* option (a new color-like or size-like concept) is a single new class, not scattered
|
* typed explicitly by the admin), so adding a new kind of option is a single new
|
||||||
* per-option special-casing across the admin UI or storefront.
|
* class, not scattered per-option special-casing across the admin UI or storefront.
|
||||||
*/
|
*/
|
||||||
interface ProductOptionTypeInterface
|
interface ProductOptionTypeInterface
|
||||||
{
|
{
|
||||||
@@ -26,7 +26,7 @@ interface ProductOptionTypeInterface
|
|||||||
* Filament form components for editing a ProductOptionValue's `meta` under this
|
* Filament form components for editing a ProductOptionValue's `meta` under this
|
||||||
* option type — e.g. Color returns a color picker for `meta.hex`, Size returns a
|
* option type — e.g. Color returns a color picker for `meta.hex`, Size returns a
|
||||||
* numeric input for `meta.sort_value`. Field names should be dot-notation under
|
* numeric input for `meta.sort_value`. Field names should be dot-notation under
|
||||||
* `meta` (e.g. `meta.hex`), matching where ValuesRelationManager's form saves them.
|
* `meta` (e.g. `meta.hex`), matching where ValuesRelationManagerExtension saves them.
|
||||||
*
|
*
|
||||||
* @return array<Component>
|
* @return array<Component>
|
||||||
*/
|
*/
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Product\Filament\Extensions;
|
||||||
|
|
||||||
|
use Filament\Forms\Components\Select;
|
||||||
|
use Filament\Forms\Form;
|
||||||
|
use Illuminate\Support\Str;
|
||||||
|
use Lunar\Admin\Support\Extending\ResourceExtension;
|
||||||
|
use Modules\Core\Product\Services\ProductOptionTypeManager;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an "Option Type" dropdown to Lunar's own ProductOptionResource form, letting
|
||||||
|
* an admin pick which registered `ProductOptionTypeInterface` (if any) describes this
|
||||||
|
* option's values — e.g. "Color" — independent of the option's own `handle`. The
|
||||||
|
* selection is saved to `ProductOption::meta['option_type']`.
|
||||||
|
*/
|
||||||
|
class ProductOptionResourceExtension extends ResourceExtension
|
||||||
|
{
|
||||||
|
public function extendForm(Form $form): Form
|
||||||
|
{
|
||||||
|
$options = app(ProductOptionTypeManager::class)->all()
|
||||||
|
->keys()
|
||||||
|
->mapWithKeys(fn (string $key) => [$key => Str::headline($key)])
|
||||||
|
->all();
|
||||||
|
|
||||||
|
if ($options === []) {
|
||||||
|
return $form;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $form->schema([
|
||||||
|
...$form->getComponents(),
|
||||||
|
Select::make('meta.option_type')
|
||||||
|
->label('Option Type')
|
||||||
|
->options($options)
|
||||||
|
->helperText('Controls which meta fields appear when editing this option\'s values.')
|
||||||
|
->native(false),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Product\Filament\Extensions;
|
||||||
|
|
||||||
|
use Filament\Forms\Form;
|
||||||
|
use Lunar\Admin\Support\Extending\RelationManagerExtension;
|
||||||
|
use Lunar\Models\ProductOption;
|
||||||
|
use Modules\Core\Product\Services\ProductOptionTypeManager;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Appends the owning `ProductOption`'s registered `ProductOptionTypeInterface` meta
|
||||||
|
* form (if any) to Lunar's own ValuesRelationManager form, so e.g. a "color" option
|
||||||
|
* gets a hex-color picker for each value alongside the stock name field — without
|
||||||
|
* forking Lunar's relation manager.
|
||||||
|
*/
|
||||||
|
class ValuesRelationManagerExtension extends RelationManagerExtension
|
||||||
|
{
|
||||||
|
public function extendForm(Form $form): Form
|
||||||
|
{
|
||||||
|
/** @var ProductOption $option */
|
||||||
|
$option = $this->caller->getOwnerRecord();
|
||||||
|
|
||||||
|
$type = app(ProductOptionTypeManager::class)->resolve($option->meta['option_type'] ?? null);
|
||||||
|
|
||||||
|
if ($type === null) {
|
||||||
|
return $form;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $form->schema([
|
||||||
|
...$form->getComponents(),
|
||||||
|
...$type->getMetaForm(),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Product\Observers;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\DB;
|
||||||
|
use Lunar\Models\Product;
|
||||||
|
use Lunar\Models\ProductOption;
|
||||||
|
use Lunar\Models\ProductOptionValue;
|
||||||
|
use Lunar\Models\ProductVariant;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Keeps every product using a ProductOption/ProductOptionValue in sync with
|
||||||
|
* Meilisearch. ProductIndexer::mapVariant() embeds each option value's `meta`
|
||||||
|
* (e.g. a color's hex) directly into the product's indexed document — but saving
|
||||||
|
* the option or one of its values never fires the *product's* own save/update
|
||||||
|
* events, so without this, a changed option_type or a changed hex would only
|
||||||
|
* reach the index on that product's next unrelated reindex.
|
||||||
|
*/
|
||||||
|
class ProductOptionReindexObserver
|
||||||
|
{
|
||||||
|
public function optionSaved(ProductOption $option): void
|
||||||
|
{
|
||||||
|
$this->reindexProductsForOption($option->id);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function optionDeleted(ProductOption $option): void
|
||||||
|
{
|
||||||
|
$this->reindexProductsForOption($option->id);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function valueSaved(ProductOptionValue $value): void
|
||||||
|
{
|
||||||
|
$this->reindexProductsForValues([$value->id]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function valueDeleted(ProductOptionValue $value): void
|
||||||
|
{
|
||||||
|
$this->reindexProductsForValues([$value->id]);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function reindexProductsForOption(int $optionId): void
|
||||||
|
{
|
||||||
|
$valueIds = ProductOptionValue::where('product_option_id', $optionId)->pluck('id');
|
||||||
|
|
||||||
|
$this->reindexProductsForValues($valueIds->all());
|
||||||
|
}
|
||||||
|
|
||||||
|
private function reindexProductsForValues(array $valueIds): void
|
||||||
|
{
|
||||||
|
if ($valueIds === []) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$prefix = config('lunar.database.table_prefix');
|
||||||
|
|
||||||
|
$variantIds = DB::table("{$prefix}product_option_value_product_variant")
|
||||||
|
->whereIn('value_id', $valueIds)
|
||||||
|
->pluck('variant_id');
|
||||||
|
|
||||||
|
if ($variantIds->isEmpty()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$productIds = ProductVariant::whereIn('id', $variantIds)->pluck('product_id')->unique();
|
||||||
|
|
||||||
|
Product::whereIn('id', $productIds)->get()->each->searchable();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Product\OptionTypes;
|
||||||
|
|
||||||
|
use Filament\Forms\Components\ColorPicker;
|
||||||
|
use Modules\Core\Product\Contracts\ProductOptionTypeInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reference implementation: describes a 'color' ProductOption's values as
|
||||||
|
* carrying a hex code in `meta.hex`, editable via a Filament color picker.
|
||||||
|
* Not auto-registered — a shop opts in via config('core.product_option_types').
|
||||||
|
*/
|
||||||
|
class ColorOptionType implements ProductOptionTypeInterface
|
||||||
|
{
|
||||||
|
public static function getKey(): string
|
||||||
|
{
|
||||||
|
return 'color';
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getMetaForm(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
ColorPicker::make('meta.hex')
|
||||||
|
->label('Color')
|
||||||
|
->required(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Product\Services;
|
||||||
|
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
use Modules\Core\Product\Contracts\ProductOptionTypeInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolves an admin-selected option type key to the `ProductOptionTypeInterface`
|
||||||
|
* describing it. The selection (which key a given `Lunar\Models\ProductOption` uses)
|
||||||
|
* is stored per-option in `ProductOption::meta['option_type']` — deliberately not
|
||||||
|
* tied to the option's `handle`, since a shop's own handle naming (e.g. transliterated
|
||||||
|
* Greek, legacy imports) shouldn't have to match a type's key.
|
||||||
|
*
|
||||||
|
* The available keys come from `config('core.product_option_types')` — a plain list,
|
||||||
|
* not a config array, because the mapping from option to type is an admin's per-option
|
||||||
|
* choice made in the UI (see ValuesRelationManagerExtension/ProductOptionResourceExtension),
|
||||||
|
* not something config alone can express.
|
||||||
|
*/
|
||||||
|
class ProductOptionTypeManager
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @return Collection<string, ProductOptionTypeInterface> keyed by getKey()
|
||||||
|
*/
|
||||||
|
public function all(): Collection
|
||||||
|
{
|
||||||
|
return collect(config('core.product_option_types', []))
|
||||||
|
->map(fn (string $class) => app($class))
|
||||||
|
->keyBy(fn (ProductOptionTypeInterface $type) => $type::getKey());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function resolve(?string $key): ?ProductOptionTypeInterface
|
||||||
|
{
|
||||||
|
if ($key === null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->all()->get($key);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Providers;
|
||||||
|
|
||||||
|
use Illuminate\Support\ServiceProvider;
|
||||||
|
use Lunar\Models\ProductOption;
|
||||||
|
use Lunar\Models\ProductOptionValue;
|
||||||
|
use Modules\Core\Product\Observers\ProductOptionReindexObserver;
|
||||||
|
|
||||||
|
class ProductServiceProvider extends ServiceProvider
|
||||||
|
{
|
||||||
|
public function boot(): void
|
||||||
|
{
|
||||||
|
$observer = new ProductOptionReindexObserver;
|
||||||
|
|
||||||
|
ProductOption::saved(fn (ProductOption $option) => $observer->optionSaved($option));
|
||||||
|
ProductOption::deleted(fn (ProductOption $option) => $observer->optionDeleted($option));
|
||||||
|
|
||||||
|
ProductOptionValue::saved(fn (ProductOptionValue $value) => $observer->valueSaved($value));
|
||||||
|
ProductOptionValue::deleted(fn (ProductOptionValue $value) => $observer->valueDeleted($value));
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user