Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e31de1b4e3 | ||
|
|
113fa35da7 | ||
|
|
7c199cc3bd | ||
|
|
5cb6c529a0 | ||
|
|
f7da26b487 | ||
|
|
1857ced3a2 | ||
|
|
8646dca16a | ||
|
|
93469d033f | ||
|
|
4c00369005 | ||
|
|
cf6aa343f1 | ||
|
|
ee9893bd64 |
@@ -4,6 +4,43 @@ All notable changes to this project will be documented in this file.
|
|||||||
|
|
||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
||||||
|
|
||||||
|
## [0.5.0] - 2026-08-24
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- **`Modules\Core\Catalog\ProductService`**: storefront product listing/filtering (`list()`) and single-product lookup (`getById()`, `getBySlug()`), reading directly from the Meilisearch index rather than the database — one data source, no `->get()` model hydration. Returns plain arrays (not Eloquent models), meant to be called directly from a consuming app's controllers.
|
||||||
|
- `ProductFilters` DTO: optional `collectionId`, `brand`, `minPrice`, `maxPrice`, translated into a Meilisearch `filter` expression.
|
||||||
|
- Listing results are locale-aware: `withLocalizedFields()` resolves `name`/`description` from the indexer's per-locale fields, falling back to the store's default language (via `LocaleMiddleware::defaultLocale()`) when the current locale has no translation yet, instead of rendering blank.
|
||||||
|
- `Modules\Core\Search\ProductIndexer` expanded well beyond its original collection/price additions to carry everything a detail page needs: `id`/`slugs` (filterable — `getById()`/`getBySlug()` resolve purely from the index, no database read), `collection_names`, `tags`, the full media gallery, per-variant data (`sku`, `stock`, `purchasable`, translated option/value names + `meta` for swatches, per-currency prices, variant media), and reviews (`reviews`, `review_count`, `average_rating` — public-safe fields only, `reviewer_email` deliberately excluded).
|
||||||
|
- `Modules\Core\Providers\ReviewServiceProvider` (newly registered): re-indexes a product whenever one of its reviews is created/updated/deleted, since a review write doesn't touch the `Product` row and so never fires the product's own model events.
|
||||||
|
- **`Modules\Core\Search\ProductSearchService`**: locale-aware full-text product search on top of the same Meilisearch index, for use by a storefront's search bar — separate from `ProductService`, which is for browsing/filtering without a query term.
|
||||||
|
- `docs/product-listing.md` and `docs/product-search.md` — usage, full field reference, and design notes for the two services above.
|
||||||
|
- `docs/lunar.md` "Gotchas": three new entries hit while building this — `ProductOption`/`ProductOptionValue::name` isn't `attribute_data` (so `translateAttribute()` silently returns `null` for it), a running `queue:work` process not picking up an edited Scout indexer class, and Scout's `paginateRaw()->items()` on the Meilisearch driver returning the whole raw response rather than a hit list.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- The admin login form (`Modules\Core\Auth\Filament\Pages\Login`) had no way back from the OTP-entry step to the email step short of reloading the page. A `back()` method resets to the email step; a "← Back" link/button is shown on the OTP step only.
|
||||||
|
|
||||||
|
## [0.4.0] - 2026-08-06
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- **Locale-prefixed routing** (`Modules\Core\Localization\LocaleMiddleware`): a `locale` route-middleware alias, opt-in per shop (not pushed onto the `web` group globally, since admin/Livewire/webhook routes must not be locale-redirected). Reads the first URL segment against Lunar's own `languages` table, sets `App::setLocale()`, and redirects unprefixed/unknown-locale requests to a resolved locale (`Accept-Language` match → default language → first language). Every locale is prefixed, including the default (`/el/...`, `/en/...`), never a bare root — avoids the hreflang/duplicate-content ambiguity of a bare-root default locale.
|
||||||
|
- Language list cached with `Cache::rememberForever()`, invalidated via `Modules\Core\Localization\LanguageCacheObserver` dispatching `LanguageCreated`/`LanguageUpdated`/`LanguageDeleted` events (see below) rather than doing the work itself.
|
||||||
|
- **Language rename safety**: renaming a `Language::code` (e.g. `el` → `gr`) no longer strands existing translations. `MigrateTranslationsForRenamedLanguage` (listening on `LanguageUpdated`) migrates every affected `LanguageLine.text` key from the old code to the new one and flushes both codes' translation caches — closing a real data-loss gap where a rename would otherwise make existing `LanguageLine` translations permanently unreachable.
|
||||||
|
- **Storefront UI label translations**: pulled in `spatie/laravel-translation-loader` (self-registers via Composer package auto-discovery; its loader *extends* Laravel's file-based `FileLoader` and merges DB translations on top — existing Filament/Lunar vendor `lang/` strings are unaffected). Labels are looked up via Laravel's native `__('storefront.nav.cart')`, kept in its own `storefront` group so nothing collides with Lunar/Filament's own translation groups.
|
||||||
|
- `Modules\Core\Command\InstallLunarCommand` (overriding `lunar:install`) seeds a starter set of ~15 common e-shop labels (`nav.*`, `cart.*`, `product.*`, `auth.*`, `search.*`, English + Greek), idempotently guarded so it's safe on every boot.
|
||||||
|
- `Modules\Core\Localization\TranslationReader::group('storefront')` returns the whole reduced/cached label array for a locale (backed by `LanguageLine`'s own forever-cache) — for sharing to a view as `$labels` or `@json()`-ing to JS, on top of `__()` for single-key Blade lookups.
|
||||||
|
- **Admin UI**: `Modules\Core\Localization\Filament\Resources\LanguageLineResource` (registered in `CorePlugin`) lists/searches/filters `language_lines` and edits each row's `group`, `key`, and one text input per locale currently in `lunar_languages` — locale columns/inputs are generated dynamically from the language list, so a new language needs no resource changes.
|
||||||
|
- **Event-driven writes**: `Modules\Core\Localization\TranslationService` (`create`/`update`/`delete`) is the single write path for `LanguageLine` — the Filament resource's Create/Edit/Delete pages route through it rather than Filament's default direct-model writes. Dispatches `TranslationCreated`/`TranslationUpdated` (carries the full pre-update `{group, key, text}` snapshot, so a bare rename is tracked the same as a text edit)/`TranslationDeleted`, each handled by two listeners:
|
||||||
|
- `FlushTranslationCache` — closes a real gap in `LanguageLine`'s own self-invalidation, which only flushes locales/groups present *after* a save. Flushes the union of old and new group+locale combinations, so a locale removed from `text`, or a `group`/`key` rename, can't leave a stale cached array behind.
|
||||||
|
- `LogTranslationActivity` — audits every write via the existing `Modules\Core\Logging\ActivityLogService` (`lunar` activity log channel), same `created`/`updated`/`deleted` shape as every other domain write in this project. Properties are flattened with `Arr::dot()` before logging (`text.en`, `text.el` instead of a nested `text` object) since Filament's Activity resource renders `properties` with a flat `KeyValue` field that can't display nested arrays.
|
||||||
|
- `Modules\Core\Providers\LocalizationServiceProvider` — split out of the growing `CoreServiceProvider` (per this project's own "split when a provider does too much" convention) to own all locale/translation middleware, observer, and event-listener registration.
|
||||||
|
|
||||||
|
## [0.3.0] - 2026-07-12
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- **Meilisearch product search**: pulled in `lunarphp/search` (Lunar's driver-agnostic search abstraction — `database`/`meilisearch`/`typesense` engines, selectable via Scout's own `SCOUT_DRIVER` config) and `lunarphp/meilisearch`, wiring Meilisearch in as the search engine for products.
|
||||||
|
- `Search\ProductIndexer` overrides Lunar's own indexer to strip HTML tags from string fields (e.g. `name_en`, `description_en`) before they reach the search index — Lunar's default indexer sends raw attribute HTML straight through, which pollutes relevance ranking and highlighting with markup.
|
||||||
|
- Meilisearch itself is treated as app-level infrastructure, not a `boboko-core` concern: the actual Meilisearch container, host port, and master key live in each consuming app's own `docker-compose.yml`/`.env` (e.g. `3dealer`), the same way Postgres and Valkey do — `boboko-core` only declares the PHP package dependency and the indexing code.
|
||||||
|
|
||||||
## [0.2.0] - 2026-07-10
|
## [0.2.0] - 2026-07-10
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
+10
-4
@@ -2,7 +2,7 @@
|
|||||||
"name": "boboko/core",
|
"name": "boboko/core",
|
||||||
"description": "Core module — authentication and shared panel behaviour",
|
"description": "Core module — authentication and shared panel behaviour",
|
||||||
"type": "library",
|
"type": "library",
|
||||||
"version": "0.2.0",
|
"version": "0.5.0",
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"Modules\\Core\\": "src/"
|
"Modules\\Core\\": "src/"
|
||||||
@@ -14,7 +14,10 @@
|
|||||||
"laravel/framework": "^12.0",
|
"laravel/framework": "^12.0",
|
||||||
"laravel/tinker": "^3.0",
|
"laravel/tinker": "^3.0",
|
||||||
"symfony/yaml": "^7.0",
|
"symfony/yaml": "^7.0",
|
||||||
"lunarphp/table-rate-shipping": "^1.3"
|
"lunarphp/table-rate-shipping": "^1.3",
|
||||||
|
"lunarphp/search": "*",
|
||||||
|
"lunarphp/meilisearch": "*",
|
||||||
|
"spatie/laravel-translation-loader": "^2.8"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"fakerphp/faker": "^1.23",
|
"fakerphp/faker": "^1.23",
|
||||||
@@ -31,13 +34,16 @@
|
|||||||
"providers": [
|
"providers": [
|
||||||
"Modules\\Core\\Providers\\CoreServiceProvider",
|
"Modules\\Core\\Providers\\CoreServiceProvider",
|
||||||
"Modules\\Core\\Providers\\AuthServiceProvider",
|
"Modules\\Core\\Providers\\AuthServiceProvider",
|
||||||
"Modules\\Core\\Providers\\CustomerServiceProvider"
|
"Modules\\Core\\Providers\\CustomerServiceProvider",
|
||||||
|
"Modules\\Core\\Providers\\LocalizationServiceProvider",
|
||||||
|
"Modules\\Core\\Providers\\ReviewServiceProvider"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"config": {
|
"config": {
|
||||||
"allow-plugins": {
|
"allow-plugins": {
|
||||||
"pestphp/pest-plugin": true
|
"pestphp/pest-plugin": true,
|
||||||
|
"php-http/discovery": true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,210 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
return [
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Default Search Engine
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| This option controls the default search connection that gets used while
|
||||||
|
| using Laravel Scout. This connection is used when syncing all models
|
||||||
|
| to the search service. You should adjust this based on your needs.
|
||||||
|
|
|
||||||
|
| Supported: "algolia", "meilisearch", "typesense",
|
||||||
|
| "database", "collection", "null"
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'driver' => env('SCOUT_DRIVER', 'collection'),
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Index Prefix
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Here you may specify a prefix that will be applied to all search index
|
||||||
|
| names used by Scout. This prefix may be useful if you have multiple
|
||||||
|
| "tenants" or applications sharing the same search infrastructure.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'prefix' => env('SCOUT_PREFIX', ''),
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Queue Data Syncing
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| This option allows you to control if the operations that sync your data
|
||||||
|
| with your search engines are queued. When this is set to "true" then
|
||||||
|
| all automatic data syncing will get queued for better performance.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'queue' => env('SCOUT_QUEUE', false),
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Database Transactions
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| This configuration option determines if your data will only be synced
|
||||||
|
| with your search indexes after every open database transaction has
|
||||||
|
| been committed, thus preventing any discarded data from syncing.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'after_commit' => false,
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Chunk Sizes
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| These options allow you to control the maximum chunk size when you are
|
||||||
|
| mass importing data into the search engine. This allows you to fine
|
||||||
|
| tune each of these chunk sizes based on the power of the servers.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'chunk' => [
|
||||||
|
'searchable' => 500,
|
||||||
|
'unsearchable' => 500,
|
||||||
|
],
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Soft Deletes
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| This option allows to control whether to keep soft deleted records in
|
||||||
|
| the search indexes. Maintaining soft deleted records can be useful
|
||||||
|
| if your application still needs to search for the records later.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'soft_delete' => false,
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Identify User
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| This option allows you to control whether to notify the search engine
|
||||||
|
| of the user performing the search. This is sometimes useful if the
|
||||||
|
| engine supports any analytics based on this application's users.
|
||||||
|
|
|
||||||
|
| Supported engines: "algolia"
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'identify' => env('SCOUT_IDENTIFY', false),
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Algolia Configuration
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Here you may configure your Algolia settings. Algolia is a cloud hosted
|
||||||
|
| search engine which works great with Scout out of the box. Just plug
|
||||||
|
| in your application ID and admin API key to get started searching.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'algolia' => [
|
||||||
|
'id' => env('ALGOLIA_APP_ID', ''),
|
||||||
|
'secret' => env('ALGOLIA_SECRET', ''),
|
||||||
|
'index-settings' => [
|
||||||
|
// 'users' => [
|
||||||
|
// 'searchableAttributes' => ['id', 'name', 'email'],
|
||||||
|
// 'attributesForFaceting'=> ['filterOnly(email)'],
|
||||||
|
// ],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Meilisearch Configuration
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Here you may configure your Meilisearch settings. Meilisearch is an open
|
||||||
|
| source search engine with minimal configuration. Below, you can state
|
||||||
|
| the host and key information for your own Meilisearch installation.
|
||||||
|
|
|
||||||
|
| See: https://www.meilisearch.com/docs/learn/configuration/instance_options#all-instance-options
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'meilisearch' => [
|
||||||
|
'host' => env('MEILISEARCH_HOST', 'http://localhost:7700'),
|
||||||
|
'key' => env('MEILISEARCH_KEY'),
|
||||||
|
'index-settings' => [
|
||||||
|
// 'users' => [
|
||||||
|
// 'filterableAttributes'=> ['id', 'name', 'email'],
|
||||||
|
// ],
|
||||||
|
],
|
||||||
|
],
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Typesense Configuration
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Here you may configure your Typesense settings. Typesense is an open
|
||||||
|
| source search engine using minimal configuration. Below, you will
|
||||||
|
| state the host, key, and schema configuration for the instance.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'typesense' => [
|
||||||
|
'client-settings' => [
|
||||||
|
'api_key' => env('TYPESENSE_API_KEY', 'xyz'),
|
||||||
|
'nodes' => [
|
||||||
|
[
|
||||||
|
'host' => env('TYPESENSE_HOST', 'localhost'),
|
||||||
|
'port' => env('TYPESENSE_PORT', '8108'),
|
||||||
|
'path' => env('TYPESENSE_PATH', ''),
|
||||||
|
'protocol' => env('TYPESENSE_PROTOCOL', 'http'),
|
||||||
|
],
|
||||||
|
],
|
||||||
|
'nearest_node' => [
|
||||||
|
'host' => env('TYPESENSE_HOST', 'localhost'),
|
||||||
|
'port' => env('TYPESENSE_PORT', '8108'),
|
||||||
|
'path' => env('TYPESENSE_PATH', ''),
|
||||||
|
'protocol' => env('TYPESENSE_PROTOCOL', 'http'),
|
||||||
|
],
|
||||||
|
'connection_timeout_seconds' => env('TYPESENSE_CONNECTION_TIMEOUT_SECONDS', 2),
|
||||||
|
'healthcheck_interval_seconds' => env('TYPESENSE_HEALTHCHECK_INTERVAL_SECONDS', 30),
|
||||||
|
'num_retries' => env('TYPESENSE_NUM_RETRIES', 3),
|
||||||
|
'retry_interval_seconds' => env('TYPESENSE_RETRY_INTERVAL_SECONDS', 1),
|
||||||
|
],
|
||||||
|
// 'max_total_results' => env('TYPESENSE_MAX_TOTAL_RESULTS', 1000),
|
||||||
|
'model-settings' => [
|
||||||
|
// User::class => [
|
||||||
|
// 'collection-schema' => [
|
||||||
|
// 'fields' => [
|
||||||
|
// [
|
||||||
|
// 'name' => 'id',
|
||||||
|
// 'type' => 'string',
|
||||||
|
// ],
|
||||||
|
// [
|
||||||
|
// 'name' => 'name',
|
||||||
|
// 'type' => 'string',
|
||||||
|
// ],
|
||||||
|
// [
|
||||||
|
// 'name' => 'created_at',
|
||||||
|
// 'type' => 'int64',
|
||||||
|
// ],
|
||||||
|
// ],
|
||||||
|
// 'default_sorting_field' => 'created_at',
|
||||||
|
// ],
|
||||||
|
// 'search-parameters' => [
|
||||||
|
// 'query_by' => 'name'
|
||||||
|
// ],
|
||||||
|
// ],
|
||||||
|
],
|
||||||
|
'import_action' => env('TYPESENSE_IMPORT_ACTION', 'upsert'),
|
||||||
|
],
|
||||||
|
|
||||||
|
];
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Database\Migrations\Migration;
|
||||||
|
use Illuminate\Database\Schema\Blueprint;
|
||||||
|
use Illuminate\Support\Facades\Schema;
|
||||||
|
|
||||||
|
return new class extends Migration
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Run the migrations.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function up(): void
|
||||||
|
{
|
||||||
|
Schema::create('language_lines', function (Blueprint $table) {
|
||||||
|
$table->id();
|
||||||
|
$table->string('group')->index();
|
||||||
|
$table->string('key');
|
||||||
|
$table->json('text');
|
||||||
|
$table->timestamps();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reverse the migrations.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function down(): void
|
||||||
|
{
|
||||||
|
Schema::dropIfExists('language_lines');
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -0,0 +1,215 @@
|
|||||||
|
# Localization
|
||||||
|
|
||||||
|
Storefront routes can be locale-prefixed (`/el/proionta`, `/en/products`) using a middleware
|
||||||
|
that reads directly from Lunar's `languages` table — the same table the Filament **Languages**
|
||||||
|
resource manages, so there's no separate locale config to keep in sync.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Why prefix every locale, including the default
|
||||||
|
|
||||||
|
Leaving the default locale bare at the root (`/proionta` for Greek, `/en/products` for English)
|
||||||
|
creates ambiguity: is `/` the language-neutral homepage or specifically the Greek version? It
|
||||||
|
also complicates `hreflang` (needs a self-referencing tag on the root plus a possibly-duplicate
|
||||||
|
`x-default`) and risks duplicate content if a bot or campaign link reaches the root without a
|
||||||
|
language signal.
|
||||||
|
|
||||||
|
Prefixing every locale avoids this: every URL unambiguously declares its language, `hreflang`
|
||||||
|
tags are symmetrical, and adding a locale later requires no URL restructuring.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Opt-in, not global
|
||||||
|
|
||||||
|
The middleware is registered as a **named alias** (`locale`), not pushed onto the `web`
|
||||||
|
middleware group. Apply it explicitly to the route group(s) that make up your storefront:
|
||||||
|
|
||||||
|
```php
|
||||||
|
// routes/web.php
|
||||||
|
use Illuminate\Support\Facades\Route;
|
||||||
|
|
||||||
|
Route::middleware('locale')->group(function () {
|
||||||
|
Route::get('/{locale}', HomeController::class);
|
||||||
|
Route::get('/{locale}/proionta', ProductIndexController::class);
|
||||||
|
Route::get('/{locale}/proionta/{slug}', ProductShowController::class);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
It is **not** applied automatically because storefront routes aren't the only routes living
|
||||||
|
under `web` in a shop:
|
||||||
|
|
||||||
|
- The Filament admin panel (`/boboko*`, see `PanelServiceProvider`) has its own routing/auth
|
||||||
|
concerns and must never be locale-redirected.
|
||||||
|
- Livewire's internal update endpoint (`/livewire/update`) must resolve without a locale prefix.
|
||||||
|
- Webhooks, health checks, and other non-storefront routes shouldn't be touched.
|
||||||
|
|
||||||
|
If a shop's entire `web.php` *is* the storefront, wrapping the whole file in the group above is
|
||||||
|
fine — just keep admin/Livewire/webhook routes registered outside of it (as they already are).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Behavior
|
||||||
|
|
||||||
|
`Modules\Core\Localization\LocaleMiddleware`:
|
||||||
|
|
||||||
|
1. Reads the first path segment (`request()->segment(1)`).
|
||||||
|
2. Matches it against `Lunar\Models\Language::code`.
|
||||||
|
- **Match** — `App::setLocale($code)` is set, and `locale` / `language` request attributes
|
||||||
|
are populated for controllers/views to use.
|
||||||
|
- **No match** (missing, wrong, or unknown segment) — redirects to the same path prefixed
|
||||||
|
with a resolved locale:
|
||||||
|
- the best match from the `Accept-Language` header against available language codes, or
|
||||||
|
- the language flagged `default` in the `languages` table, or
|
||||||
|
- the first language row, as a last resort.
|
||||||
|
|
||||||
|
The language list is cached with `Cache::rememberForever()` under `core.localization.languages`
|
||||||
|
and invalidated automatically. Adding, editing, or removing a language via the Filament
|
||||||
|
**Languages** resource clears the cache immediately — no TTL, no stale reads.
|
||||||
|
|
||||||
|
### How invalidation is wired (event-driven, not the observer itself)
|
||||||
|
|
||||||
|
`Modules\Core\Localization\LanguageCacheObserver` observes `Lunar\Models\Language`'s
|
||||||
|
`created`/`updated`/`deleted` Eloquent events, but it's a thin trigger only — it doesn't do any
|
||||||
|
invalidation work itself. It dispatches one of three events from
|
||||||
|
`Modules\Core\Localization\Events` (`LanguageCreated`, `LanguageUpdated` — carrying the old
|
||||||
|
`code` — or `LanguageDeleted`), and two listeners, wired in
|
||||||
|
`Modules\Core\Providers\LocalizationServiceProvider`, react:
|
||||||
|
|
||||||
|
- **`FlushLanguageCache`** — flushes `core.localization.languages` on all three events.
|
||||||
|
- **`MigrateTranslationsForRenamedLanguage`** — `LanguageUpdated` only, and only when `code`
|
||||||
|
actually changed. A renamed `Language::code` (e.g. `el` → `gr`) would otherwise strand every
|
||||||
|
`LanguageLine`'s translated text under the old, now-unroutable key —
|
||||||
|
`getTranslationsForGroup('gr', ...)` would silently return nothing for that locale even though
|
||||||
|
the translated content still exists. This listener moves the `text.{oldCode}` key to
|
||||||
|
`text.{newCode}` on every affected `LanguageLine` row and flushes both the old and new code's
|
||||||
|
translation cache for every group touched.
|
||||||
|
|
||||||
|
Deleting a `Language` only flushes the language-list cache — `LanguageLine.text` keys for the
|
||||||
|
deleted code are left in place rather than destructively erased, in case the language is ever
|
||||||
|
re-added under the same code.
|
||||||
|
|
||||||
|
Splitting cache-flush and text-migration into separate listeners (rather than one
|
||||||
|
`LanguageCacheObserver` method doing both) mirrors the same event → listener pattern used for
|
||||||
|
`TranslationService`'s writes below — the observer only detects *what happened*, listeners own
|
||||||
|
*what to do about it*.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Reading the resolved locale/language downstream
|
||||||
|
|
||||||
|
```php
|
||||||
|
// In a controller or view composer
|
||||||
|
$locale = $request->attributes->get('locale'); // e.g. "el"
|
||||||
|
$language = $request->attributes->get('language'); // Lunar\Models\Language instance
|
||||||
|
```
|
||||||
|
|
||||||
|
Use `$language->id` when querying Lunar's translatable content (e.g. `Url::where('language_id', ...)`).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Single-language shops
|
||||||
|
|
||||||
|
If a shop has only one row in `languages`, the middleware still enforces the prefix (e.g. every
|
||||||
|
URL under `/en/...`) rather than special-casing it away — this keeps behavior identical across
|
||||||
|
shops and avoids a silent restructuring if a second language is added later. If a shop genuinely
|
||||||
|
never wants locale prefixes, don't apply the `locale` middleware to its routes at all.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Storefront UI labels (`__('storefront.*')`)
|
||||||
|
|
||||||
|
The `locale` middleware resolves *which* language a request is in — routing/redirects,
|
||||||
|
`Lunar\Models\Language`, and Lunar's own translatable product/collection content. It has nothing
|
||||||
|
to do with static UI chrome like "Cart", "Back", "Add to Cart". Those are handled separately by
|
||||||
|
[`spatie/laravel-translation-loader`](https://github.com/spatie/laravel-translation-loader),
|
||||||
|
stored in the `language_lines` table.
|
||||||
|
|
||||||
|
### Why a separate system, not another `languages`-table lookup
|
||||||
|
|
||||||
|
Lunar's translatable fields (`TranslatedText`, `Url`, etc.) are all tied to specific *model
|
||||||
|
records* — a product's name, a collection's description. UI labels aren't attached to any model;
|
||||||
|
they're static strings the app itself owns. `laravel-translation-loader` is Laravel's own
|
||||||
|
`__()`/`trans()` mechanism with a DB-backed source layered on top of the normal file-based one —
|
||||||
|
no new helper to learn, no bespoke table shape.
|
||||||
|
|
||||||
|
**Nothing existing breaks.** The package's `TranslationLoaderManager` *extends* Laravel's
|
||||||
|
`FileLoader` and merges DB translations on top of file-based ones
|
||||||
|
(`array_replace_recursive()`) — Filament's own vendor `lang/en/product.php`-style strings
|
||||||
|
keep working exactly as before. The package registers itself via Laravel's standard Composer
|
||||||
|
package auto-discovery (`extra.laravel.providers` in its own `composer.json`) — nothing needed
|
||||||
|
in `CoreServiceProvider` to wire it up.
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
```blade
|
||||||
|
{{ __('storefront.nav.cart') }}
|
||||||
|
{{ __('storefront.product.add_to_cart') }}
|
||||||
|
```
|
||||||
|
|
||||||
|
`group` is `storefront` for e-shop UI labels — kept separate from Lunar/Filament's own `lunar::`
|
||||||
|
namespaced groups so nothing collides. `__()` resolves the translation for whatever
|
||||||
|
`App::getLocale()` currently is, which `LocaleMiddleware` already sets per-request (see
|
||||||
|
"Behavior" above) — no extra wiring needed between the two systems.
|
||||||
|
|
||||||
|
### Seeding
|
||||||
|
|
||||||
|
A starter set of common e-shop labels (`nav.*`, `cart.*`, `product.*`, `auth.*`, `search.*`,
|
||||||
|
English + Greek) is seeded by `Modules\Core\Command\InstallLunarCommand` (overrides Lunar's own
|
||||||
|
`lunar:install`), guarded by `LanguageLine::where('group', 'storefront')->exists()` — same
|
||||||
|
idempotent pattern as the rest of that command, safe to run unattended on every boot.
|
||||||
|
|
||||||
|
### Admin UI
|
||||||
|
|
||||||
|
`Modules\Core\Localization\Filament\Resources\LanguageLineResource` (registered in
|
||||||
|
`CorePlugin`, under the panel's Settings group) lists/searches/filters `language_lines` and
|
||||||
|
edits each row's `group`, `key`, and one text input per row currently in `lunar_languages` —
|
||||||
|
the locale columns are generated dynamically from `Language::query()->pluck('code')`, so adding
|
||||||
|
a third language automatically adds a third input, no resource changes needed.
|
||||||
|
|
||||||
|
### `TranslationService` — writes go through here, not the model directly
|
||||||
|
|
||||||
|
`Modules\Core\Localization\TranslationService` wraps create/update/delete on `LanguageLine` and
|
||||||
|
dispatches a domain event after each write, following this project's standard event-driven
|
||||||
|
pattern (see `modules.md`'s "Splitting Service Providers" / event-listener convention —
|
||||||
|
the same shape as `Modules\Core\Auth\Events\UserCreated`):
|
||||||
|
|
||||||
|
```php
|
||||||
|
use Modules\Core\Localization\TranslationService;
|
||||||
|
|
||||||
|
app(TranslationService::class)->create('storefront', 'nav.wishlist', [
|
||||||
|
'en' => 'Wishlist',
|
||||||
|
'el' => 'Λίστα Επιθυμιών',
|
||||||
|
]);
|
||||||
|
|
||||||
|
app(TranslationService::class)->update(
|
||||||
|
$languageLine,
|
||||||
|
'storefront',
|
||||||
|
'nav.wishlist',
|
||||||
|
['en' => 'Wishlist ♥', 'el' => 'Λίστα Επιθυμιών ♥'],
|
||||||
|
);
|
||||||
|
|
||||||
|
app(TranslationService::class)->delete($languageLine);
|
||||||
|
```
|
||||||
|
|
||||||
|
`update()` takes the full `group`/`key`/`text` state, not just `text` — a rename is a normal
|
||||||
|
update, not a special case. `TranslationCreated`, `TranslationUpdated` (carries the full
|
||||||
|
`{group, key, text}` snapshot from *before* the update, so a listener can tell a rename from a
|
||||||
|
text edit), and `TranslationDeleted` are dispatched from `Modules\Core\Localization\Events`. Two
|
||||||
|
listeners are wired in `Modules\Core\Providers\LocalizationServiceProvider` for all three events:
|
||||||
|
|
||||||
|
- **`FlushTranslationCache`** — `LanguageLine::boot()` already flushes the cache for the
|
||||||
|
*current* group's locales present after a save, but misses two cases on update: locales a save
|
||||||
|
*removed* from `text` (e.g. dropping the `el` key leaves `storefront.el` stale), and a changed
|
||||||
|
`group`/`key` (the *old* group's cached array is never told a row left it). This listener
|
||||||
|
flushes every group+locale combination touched by either the old or new state, so nothing —
|
||||||
|
including the group a row was renamed away from — can remain stale.
|
||||||
|
- **`LogTranslationActivity`** — records the change via `Modules\Core\Logging\ActivityLogService`
|
||||||
|
on the `lunar` activity log channel, same `created`/`updated`/`deleted` shape as every other
|
||||||
|
domain write in this project. A rename shows up in the log as an `old`/`attributes` diff across
|
||||||
|
`group`, `key`, and `text` together, not just a text diff.
|
||||||
|
|
||||||
|
The Filament resource's Create/Edit/Delete pages route through `TranslationService` (via
|
||||||
|
`handleRecordCreation`/`handleRecordUpdate`/the delete action's `->action()` override) rather
|
||||||
|
than Filament's default direct-model calls, so **every** edit made in the admin UI — including a
|
||||||
|
bare `group`/`key` rename with no `text` change — dispatches `TranslationUpdated` and is both
|
||||||
|
cache-invalidated and audit-logged.
|
||||||
@@ -1206,3 +1206,6 @@ Real bugs/traps hit while building against Lunar in this package — not obvious
|
|||||||
- **`ProductOption.handle` must be unique and non-null if a product has more than one option.** Lunar's Filament variant-switcher widget does `SelectFilter::make($option->handle)` per option — two options with a `null`/matching handle throws "Filter must have a unique name" as a 500 when opening that product's variant pricing page. Always derive a slug and check uniqueness.
|
- **`ProductOption.handle` must be unique and non-null if a product has more than one option.** Lunar's Filament variant-switcher widget does `SelectFilter::make($option->handle)` per option — two options with a `null`/matching handle throws "Filter must have a unique name" as a 500 when opening that product's variant pricing page. Always derive a slug and check uniqueness.
|
||||||
- **`Attribute.position` is per-group, and the panel sorts by it.** Hardcoding `position => 1` for multiple new attributes in the same group makes their order undefined/collide with existing attributes at position 1. Compute `max('position') + 1` per group instead.
|
- **`Attribute.position` is per-group, and the panel sorts by it.** Hardcoding `position => 1` for multiple new attributes in the same group makes their order undefined/collide with existing attributes at position 1. Compute `max('position') + 1` per group instead.
|
||||||
- **Currency `decimal_places` isn't always 2.** A seeded/demo currency can have the wrong value (seen: EUR seeded with `decimal_places = 1`), which silently corrupts every price display (`€16.50` renders as `165`). If prices look wrong by a factor of 10, check the currency row before assuming the price-writing code is broken.
|
- **Currency `decimal_places` isn't always 2.** A seeded/demo currency can have the wrong value (seen: EUR seeded with `decimal_places = 1`), which silently corrupts every price display (`€16.50` renders as `165`). If prices look wrong by a factor of 10, check the currency row before assuming the price-writing code is broken.
|
||||||
|
- **`Builder::paginateRaw()`'s `items()` is not a hit list on the Meilisearch driver.** It contains the *entire* raw response (`hits`, `query`, `processingTimeMs`, `hitsPerPage`, `page`, `totalPages`, `totalHits`) as one associative array. Treating `$paginator->items()` as a plain list (e.g. `collect($paginator->items())->values()`) silently produces 7 elements — the real hits array happens to land first, the rest are stray scalars from the other response keys — no error, just corrupted data. Pull `$paginator->items()['hits']` explicitly. `total()`/`perPage()`/`currentPage()`/`lastPage()` on the paginator are unaffected. See `Modules\Core\Catalog\ProductService` / `docs/product-listing.md`.
|
||||||
|
- **`ProductOption`/`ProductOptionValue::$name` is not `attribute_data` — `translateAttribute('name')` silently returns null for them.** Unlike `Product`/`Collection`/`Brand`, their translated `name` is a plain locale-keyed array cast (`AsArrayObject`) directly on the column, not stored in `attribute_data`. `HasTranslations::translateAttribute()` only reads `attribute_data`, so calling it on these two models compiles fine and returns `null` with no error — read the array directly instead (`$value->name[$locale] ?? ...`). See `Modules\Core\Search\ProductIndexer::translatedName()`.
|
||||||
|
- **A running `queue:work` process does not pick up an edited/newly-added Scout indexer class.** It loads PHP classes once at boot and keeps them for the process's lifetime. Symptoms: reindexing commands succeed with no errors, calling `toSearchableArray()` directly (e.g. via `artisan tinker`, which always boots fresh) returns the new fields correctly, but documents written via `$model->searchable()` through the live queue are still missing them. Restart the queue worker after deploying an indexer change — no code fix needed.
|
||||||
|
|||||||
@@ -0,0 +1,157 @@
|
|||||||
|
# Product Listing
|
||||||
|
|
||||||
|
`Modules\Core\Catalog\ProductService` provides catalog browsing/filtering AND single-product
|
||||||
|
lookup for a storefront — `list()`, `getById()`, `getBySlug()` — all reading directly from the
|
||||||
|
Meilisearch index rather than the database. One data source for everything this service does.
|
||||||
|
|
||||||
|
This is separate from `Modules\Core\Search\ProductSearchService` (see `product-search.md`), which
|
||||||
|
handles free-text query search. `ProductService` is for browsing/lookup without a search term.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Why it reads from the index, not the database
|
||||||
|
|
||||||
|
Every method here reads Meilisearch documents directly and returns plain arrays — never Scout's
|
||||||
|
`->get()`, which would re-hydrate Eloquent models from the database. This means the index has to
|
||||||
|
carry everything a detail page needs (variants, prices, options, media, reviews — see below), not
|
||||||
|
just the trimmed fields a listing page needs. `Modules\Core\Search\ProductIndexer` is built to
|
||||||
|
carry that full shape.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```php
|
||||||
|
use Modules\Core\Catalog\ProductFilters;
|
||||||
|
use Modules\Core\Catalog\ProductService;
|
||||||
|
|
||||||
|
$service = app(ProductService::class);
|
||||||
|
|
||||||
|
// List everything, paginated
|
||||||
|
$result = $service->list(perPage: 24, page: 1);
|
||||||
|
|
||||||
|
// Filter by collection, brand, and/or price range
|
||||||
|
$result = $service->list(
|
||||||
|
filters: new ProductFilters(collectionId: 17, minPrice: 10.0, maxPrice: 50.0),
|
||||||
|
perPage: 24,
|
||||||
|
page: 1,
|
||||||
|
);
|
||||||
|
|
||||||
|
$result['data']; // array of Meilisearch documents (plain arrays, not models)
|
||||||
|
$result['meta']['total'];
|
||||||
|
$result['meta']['per_page'];
|
||||||
|
$result['meta']['current_page'];
|
||||||
|
$result['meta']['last_page'];
|
||||||
|
|
||||||
|
// Single product, by primary key
|
||||||
|
$product = $service->getById(367); // array, or null if not found
|
||||||
|
|
||||||
|
// Single product, by URL slug (any locale — slugs are indexed across all languages)
|
||||||
|
$product = $service->getBySlug('erotika-mprelok'); // array, or null if not found
|
||||||
|
```
|
||||||
|
|
||||||
|
All `ProductFilters` fields are optional; only the ones set are added to the Meilisearch query.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Fields this depends on: `Modules\Core\Search\ProductIndexer`
|
||||||
|
|
||||||
|
Lunar's own `Lunar\Search\ProductIndexer` only carries listing-grade fields (name, description,
|
||||||
|
status, brand, a single thumbnail, skus) and marks just `__soft_deleted`, `skus`, `status` as
|
||||||
|
filterable. `Modules\Core\Search\ProductIndexer` extends it to add everything `ProductService`
|
||||||
|
needs, listing and detail alike:
|
||||||
|
|
||||||
|
| Field | Source | Notes |
|
||||||
|
|---|---|---|
|
||||||
|
| `id` | — | Newly marked **filterable** — needed for `getById()`'s `id = "..."` filter; Meilisearch doesn't filter on the primary key by default. |
|
||||||
|
| `collections` | `$product->collections->pluck('id')` | Filterable. Array of collection IDs (as strings) — filtering matches by ID, not slug. |
|
||||||
|
| `collection_names` | `$product->collections` | Display only, not filterable — translated collection names. |
|
||||||
|
| `slugs` | `$product->urls->pluck('slug')` | Filterable. Every locale's `Url::slug` for the product, so `getBySlug()` resolves purely from the index — no database read. |
|
||||||
|
| `price` | Cheapest variant's base price | Filterable. Float in major units (e.g. `19.99`, not `1999`). Base price only — no customer group, default currency (`Currency::getDefault()`) only. `null` if the product has no priced variant yet, so it's excluded from range filters rather than treated as free. |
|
||||||
|
| `brand` | Already indexed by Lunar's base indexer | Newly marked **filterable** — it existed in the document already, just wasn't usable in a `filter` clause. |
|
||||||
|
| `tags` | `$product->tags->pluck('value')` | Display only. |
|
||||||
|
| `media` | `$product->media` | Full gallery (id/url/thumb per image), not just the single thumbnail Lunar's base indexer sends. |
|
||||||
|
| `variants` | `$product->variants` | Per variant: `id`, `sku`, `stock`, `purchasable`, `options` (option/value names, in the current locale), `prices` (per currency/customer group), `media` (variant-specific images). |
|
||||||
|
| `reviews`, `review_count`, `average_rating` | `Modules\Core\Review\Models\ProductReview` | See "Reviews" below. |
|
||||||
|
|
||||||
|
`description` and other translated attributes are indexed as-is, including any HTML markup
|
||||||
|
(e.g. from a Shopify `Body (HTML)` import) — **not stripped**. Any view rendering a description
|
||||||
|
sourced from `ProductService`'s results must treat it as trusted HTML.
|
||||||
|
|
||||||
|
**`ProductOption`/`ProductOptionValue` names need a different translation accessor.** Unlike
|
||||||
|
`Product`/`Collection`/`Brand`, their `name` is a plain locale-keyed array cast, not
|
||||||
|
`attribute_data` — Lunar's `translateAttribute('name')` silently returns `null` for them. The
|
||||||
|
indexer's `translatedName()` reads the array directly instead. See `docs/lunar.md` "Gotchas".
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Reviews
|
||||||
|
|
||||||
|
`Modules\Core\Review\Models\ProductReview` (`product_reviews` table) is indexed per-product as
|
||||||
|
`reviews` (array), plus `review_count` and `average_rating` (rounded to 1 decimal, `null` if the
|
||||||
|
product has no reviews). Only public-safe fields are included — **`reviewer_email` is deliberately
|
||||||
|
excluded**, it's PII with no storefront use. `reply`/`replied_at` (the staff response) are
|
||||||
|
included, since they're meant to be shown alongside the review.
|
||||||
|
|
||||||
|
A review is created/edited independently of its product (a customer submission, a staff reply)
|
||||||
|
— its own save doesn't touch the `Product` row, so the product's own model events never fire.
|
||||||
|
`Modules\Core\Providers\ReviewServiceProvider` listens on `ProductReview`'s `created`/`updated`/
|
||||||
|
`deleted` events and calls `$review->product->searchable()`, so the parent product's document
|
||||||
|
stays current without waiting for the next full reindex. This provider must be registered in
|
||||||
|
`composer.json`'s `extra.laravel.providers` (already done in this repo) — see `docs/modules.md`
|
||||||
|
"Provider Registration Pitfalls" for what happens if a provider like this is ever added but not
|
||||||
|
registered.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Multi-variant products and price
|
||||||
|
|
||||||
|
A product's `price` is its *cheapest* variant's price ("from €19.99" style), not every variant's
|
||||||
|
price. A price-range filter matches based on that single minimum — a product with one cheap
|
||||||
|
variant and several expensive ones will match a low-price-range filter even though most of its
|
||||||
|
variants don't.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Registering the indexer
|
||||||
|
|
||||||
|
Not automatic — an app opts in via its own `config/lunar/search.php`:
|
||||||
|
|
||||||
|
```php
|
||||||
|
'indexers' => [
|
||||||
|
Lunar\Models\Product::class => Modules\Core\Search\ProductIndexer::class,
|
||||||
|
// ...other model indexers unchanged
|
||||||
|
],
|
||||||
|
```
|
||||||
|
|
||||||
|
## Re-syncing after this change
|
||||||
|
|
||||||
|
Filterable attributes are Meilisearch index settings, not computed per-query — changing them
|
||||||
|
requires re-syncing settings and reindexing existing documents:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan lunar:meilisearch:setup
|
||||||
|
php artisan lunar:search:index "Lunar\Models\Product" --refresh
|
||||||
|
```
|
||||||
|
|
||||||
|
**If `SCOUT_QUEUE=true`, restart the queue worker after deploying an indexer change.** A running
|
||||||
|
`queue:work` process loads PHP classes once at boot and keeps that code in memory for its entire
|
||||||
|
lifetime — it does not pick up an edited/newly-deployed indexer class. Symptoms: reindexing
|
||||||
|
commands succeed with no errors, `Product::toSearchableArray()` returns the new fields correctly
|
||||||
|
when called directly (e.g. via `artisan tinker`, which always boots fresh), but documents written
|
||||||
|
via `$model->searchable()` through the live queue are still missing the new fields. Restarting the
|
||||||
|
queue worker (`docker compose restart queue`, or equivalent) resolves it — no code change needed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Meilisearch driver quirk: `paginateRaw()`'s `items()` is not a list of hits
|
||||||
|
|
||||||
|
For the Meilisearch engine specifically, Scout's `Builder::paginateRaw()` puts the **entire raw
|
||||||
|
response** (`hits`, `query`, `processingTimeMs`, `hitsPerPage`, `page`, `totalPages`, `totalHits`)
|
||||||
|
into the paginator's `items()`, not a plain array of documents. Calling `$paginator->items()`
|
||||||
|
and treating it as a list (e.g. `collect($paginator->items())->values()`) silently produces a
|
||||||
|
7-element array whose first element happens to be the real hits and the rest are stray scalars
|
||||||
|
from the other response keys — no error, just wrong data leaking into what looks like a normal
|
||||||
|
list. `ProductService::list()` pulls `$paginator->items()['hits']` explicitly to avoid this;
|
||||||
|
`$paginator->total()`/`perPage()`/`currentPage()`/`lastPage()` are unaffected and safe to use
|
||||||
|
as-is.
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
# Product Search
|
||||||
|
|
||||||
|
`Modules\Core\Search\ProductSearchService` provides locale-aware full-text product search on
|
||||||
|
top of Laravel Scout + Meilisearch.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Why locale-aware search isn't a filter
|
||||||
|
|
||||||
|
Lunar's Meilisearch indexer (`Lunar\Search\ScoutIndexer::mapSearchableAttributes()`) flattens
|
||||||
|
every translated attribute into **locale-suffixed fields on a single document** — a product with
|
||||||
|
a translated `name` produces `name_en`, `name_el`, etc. as separate top-level fields, not
|
||||||
|
separate documents per locale and not a filterable `locale` field.
|
||||||
|
|
||||||
|
That means "search in Greek" isn't a `->filter('locale = el')` — Meilisearch has no such field to
|
||||||
|
filter on. It's a choice of **which fields the query targets**: `name_el`/`description_el`
|
||||||
|
instead of `name_en`/`description_en`. This is what Meilisearch's `attributesToSearchOn` search
|
||||||
|
parameter controls, exposed through Scout via `Builder::options()`, which passes straight through
|
||||||
|
to the underlying Meilisearch client call (`Laravel\Scout\Engines\MeilisearchEngine::performSearch()`
|
||||||
|
merges `$builder->options` directly into the search request).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```php
|
||||||
|
use Modules\Core\Search\ProductSearchService;
|
||||||
|
|
||||||
|
$results = app(ProductSearchService::class)->search('running shoes');
|
||||||
|
// or an explicit locale, bypassing App::getLocale():
|
||||||
|
$results = app(ProductSearchService::class)->search('running shoes', 'el');
|
||||||
|
```
|
||||||
|
|
||||||
|
Returns an `Illuminate\Database\Eloquent\Collection` of `Lunar\Models\Product` — Scout's
|
||||||
|
`->get()` hydrates real models from the database after the Meilisearch query, so relations
|
||||||
|
(`variants`, `brand`, `media`, etc.) are available on the results as normal.
|
||||||
|
|
||||||
|
`$locale` defaults to `App::getLocale()` — already set correctly on every storefront request by
|
||||||
|
`Modules\Core\Localization\LocaleMiddleware` (see `localization.md`), so callers in controllers
|
||||||
|
don't need to pass it explicitly.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Missing-translation fallback
|
||||||
|
|
||||||
|
If a product was only ever given an English name, `name_el` doesn't exist on that document at
|
||||||
|
all (Lunar's indexer only writes a `{handle}_{locale}` field for locales actually present in the
|
||||||
|
attribute's stored data — see `ScoutIndexer::mapSearchableAttributes()`). Searching strictly
|
||||||
|
against `name_el` would make that product invisible to Greek-locale search, even though it's a
|
||||||
|
real catalog item.
|
||||||
|
|
||||||
|
To avoid silently hiding incompletely-translated products, `ProductSearchService` targets **both**
|
||||||
|
the resolved locale's fields **and** the default language's fields
|
||||||
|
(`Lunar\Models\Language::getDefault()->code`) — e.g. searching in `el` targets `name_el`,
|
||||||
|
`name_en`, `description_el`, `description_en` together (assuming `en` is the default language).
|
||||||
|
A product missing an `el` translation still matches via its `en` fields.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Field list is dynamic, not hardcoded
|
||||||
|
|
||||||
|
The set of attribute handles searched (`name`, `description`, or whatever else) comes from
|
||||||
|
`Lunar\Facades\AttributeManifest::getSearchableAttributes(Product::morphName())` — the same
|
||||||
|
source `ScoutIndexer` itself uses to decide what gets indexed. If an admin marks a new attribute
|
||||||
|
searchable in the panel, `ProductSearchService` picks it up automatically; nothing in this class
|
||||||
|
needs to change.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Re-syncing after indexer changes
|
||||||
|
|
||||||
|
Changing which attributes are searchable, or `ProductIndexer`'s filterable/sortable fields,
|
||||||
|
requires re-syncing Meilisearch's index settings and re-indexing existing documents:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php artisan lunar:meilisearch:setup
|
||||||
|
php artisan lunar:search:index "Lunar\Models\Product" --refresh
|
||||||
|
```
|
||||||
|
|
||||||
|
`ProductSearchService` itself needs no re-sync when locales change — `attributesToSearchOn` is
|
||||||
|
computed per-query from the live language list, not baked into index settings.
|
||||||
@@ -46,6 +46,10 @@
|
|||||||
<x-filament::button type="submit" class="w-full">
|
<x-filament::button type="submit" class="w-full">
|
||||||
Sign in
|
Sign in
|
||||||
</x-filament::button>
|
</x-filament::button>
|
||||||
|
|
||||||
|
<x-filament::link wire:click="back" tag="button" type="button" class="mx-auto">
|
||||||
|
← Back
|
||||||
|
</x-filament::link>
|
||||||
</div>
|
</div>
|
||||||
</form>
|
</form>
|
||||||
@endif
|
@endif
|
||||||
|
|||||||
@@ -35,6 +35,12 @@ class Login extends SimplePage
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function back(): void
|
||||||
|
{
|
||||||
|
$this->otpSent = false;
|
||||||
|
$this->otp = '';
|
||||||
|
}
|
||||||
|
|
||||||
public function requestOtp(): void
|
public function requestOtp(): void
|
||||||
{
|
{
|
||||||
$this->validate(['email' => 'required|email']);
|
$this->validate(['email' => 'required|email']);
|
||||||
|
|||||||
@@ -0,0 +1,20 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Catalog;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filter input for ProductService::list(). All fields are optional — omitted
|
||||||
|
* filters are simply not added to the Meilisearch query. Values are matched
|
||||||
|
* against Modules\Core\Search\ProductIndexer's document fields, so filtering
|
||||||
|
* only works on stores where that indexer is registered and the index has
|
||||||
|
* been re-synced (see docs/product-listing.md).
|
||||||
|
*/
|
||||||
|
class ProductFilters
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
public readonly ?int $collectionId = null,
|
||||||
|
public readonly ?string $brand = null,
|
||||||
|
public readonly ?float $minPrice = null,
|
||||||
|
public readonly ?float $maxPrice = null,
|
||||||
|
) {}
|
||||||
|
}
|
||||||
@@ -0,0 +1,126 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Catalog;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
use Illuminate\Support\Facades\App;
|
||||||
|
use Lunar\Models\Product;
|
||||||
|
use Modules\Core\Localization\LocaleMiddleware;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Storefront product listing/filtering AND single-product lookup, all reading directly
|
||||||
|
* from the Meilisearch index (Modules\Core\Search\ProductIndexer) - one data source, no
|
||||||
|
* ->get() model hydration anywhere in this service. Callers get plain arrays of the
|
||||||
|
* indexed document, not Eloquent models.
|
||||||
|
*
|
||||||
|
* Full-text query search lives separately in Modules\Core\Search\ProductSearchService;
|
||||||
|
* this service is for browsing/filtering without a search term.
|
||||||
|
*/
|
||||||
|
class ProductService
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @return array{data: array<int, array>, meta: array}
|
||||||
|
*/
|
||||||
|
public function list(?ProductFilters $filters = null, int $perPage = 24, int $page = 1): array
|
||||||
|
{
|
||||||
|
$paginator = Product::search('')
|
||||||
|
->options([
|
||||||
|
'filter' => $this->buildFilter($filters),
|
||||||
|
])
|
||||||
|
->paginateRaw(perPage: $perPage, page: $page);
|
||||||
|
|
||||||
|
return [
|
||||||
|
'data' => collect($this->hitsFrom($paginator))
|
||||||
|
->map(fn (array $product) => $this->withLocalizedFields($product))
|
||||||
|
->all(),
|
||||||
|
'meta' => [
|
||||||
|
'total' => $paginator->total(),
|
||||||
|
'per_page' => $paginator->perPage(),
|
||||||
|
'current_page' => $paginator->currentPage(),
|
||||||
|
'last_page' => $paginator->lastPage(),
|
||||||
|
],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Look up a single product by its URL slug (any locale - slugs are indexed across
|
||||||
|
* all languages, see Modules\Core\Search\ProductIndexer). Returns the full indexed
|
||||||
|
* product document, or null if no product has that slug.
|
||||||
|
*/
|
||||||
|
public function getBySlug(string $slug): ?array
|
||||||
|
{
|
||||||
|
return $this->findOneWhere('slugs = "'.addcslashes($slug, '"\\').'"');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Look up a single product by its primary key. Returns the full indexed product
|
||||||
|
* document, or null if no product has that id.
|
||||||
|
*/
|
||||||
|
public function getById(int $id): ?array
|
||||||
|
{
|
||||||
|
return $this->findOneWhere("id = \"{$id}\"");
|
||||||
|
}
|
||||||
|
|
||||||
|
private function findOneWhere(string $filter): ?array
|
||||||
|
{
|
||||||
|
$paginator = Product::search('')
|
||||||
|
->options(['filter' => $filter])
|
||||||
|
->paginateRaw(perPage: 1, page: 1);
|
||||||
|
|
||||||
|
$product = $this->hitsFrom($paginator)[0] ?? null;
|
||||||
|
|
||||||
|
return $product !== null ? $this->withLocalizedFields($product) : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolves the current-locale `name`/`description` from the indexer's
|
||||||
|
* per-locale `name_{locale}`/`description_{locale}` fields, falling back to
|
||||||
|
* the store's default language (Language::default, see
|
||||||
|
* LocaleMiddleware::defaultLocale()) when the current locale has no
|
||||||
|
* translation - e.g. a product with no English copy yet still shows its
|
||||||
|
* Greek name/description on /en/ rather than rendering blank.
|
||||||
|
*
|
||||||
|
* Deliberately not config('app.locale') - App::setLocale() overwrites that
|
||||||
|
* config value on every request, so by request time it's just whatever the
|
||||||
|
* current locale already is, not a stable fallback.
|
||||||
|
*/
|
||||||
|
private function withLocalizedFields(array $product): array
|
||||||
|
{
|
||||||
|
$locale = App::getLocale();
|
||||||
|
$fallbackLocale = LocaleMiddleware::defaultLocale();
|
||||||
|
|
||||||
|
$product['name'] = $product['name_'.$locale] ?? $product['name_'.$fallbackLocale] ?? null;
|
||||||
|
$product['description'] = $product['description_'.$locale] ?? $product['description_'.$fallbackLocale] ?? null;
|
||||||
|
|
||||||
|
return $product;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* For the Meilisearch driver, Scout's paginateRaw() puts the whole raw response
|
||||||
|
* (hits, query, processingTimeMs, ...) in items(), not a plain list of hits - the
|
||||||
|
* actual documents are under the 'hits' key.
|
||||||
|
*/
|
||||||
|
private function hitsFrom(LengthAwarePaginator $paginator): array
|
||||||
|
{
|
||||||
|
$rawResponse = $paginator->items();
|
||||||
|
|
||||||
|
return collect($rawResponse['hits'] ?? [])->values()->all();
|
||||||
|
}
|
||||||
|
|
||||||
|
private function buildFilter(?ProductFilters $filters): ?string
|
||||||
|
{
|
||||||
|
if ($filters === null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$clauses = Collection::make([
|
||||||
|
$filters->collectionId !== null ? "collections = \"{$filters->collectionId}\"" : null,
|
||||||
|
$filters->brand !== null ? 'brand = "'.addcslashes($filters->brand, '"\\').'"' : null,
|
||||||
|
$filters->minPrice !== null ? "price >= {$filters->minPrice}" : null,
|
||||||
|
$filters->maxPrice !== null ? "price <= {$filters->maxPrice}" : null,
|
||||||
|
])->filter();
|
||||||
|
|
||||||
|
return $clauses->isEmpty() ? null : $clauses->join(' AND ');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -18,6 +18,7 @@ use Lunar\Models\Product;
|
|||||||
use Lunar\Models\ProductType;
|
use Lunar\Models\ProductType;
|
||||||
use Lunar\Models\TaxClass;
|
use Lunar\Models\TaxClass;
|
||||||
use Lunar\Models\TaxZone;
|
use Lunar\Models\TaxZone;
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Overrides Lunar's own lunar:install to skip the interactive prompts (migrate
|
* Overrides Lunar's own lunar:install to skip the interactive prompts (migrate
|
||||||
@@ -241,9 +242,43 @@ class InstallLunarCommand extends Command
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
if (! LanguageLine::where('group', 'storefront')->exists()) {
|
||||||
|
$this->components->info('Seeding storefront label translations');
|
||||||
|
$this->seedStorefrontLabels();
|
||||||
|
}
|
||||||
|
|
||||||
$this->components->info('Publishing Filament assets');
|
$this->components->info('Publishing Filament assets');
|
||||||
$this->call('filament:assets');
|
$this->call('filament:assets');
|
||||||
|
|
||||||
$this->components->info('Lunar default data seeded.');
|
$this->components->info('Lunar default data seeded.');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private function seedStorefrontLabels(): void
|
||||||
|
{
|
||||||
|
$labels = [
|
||||||
|
'nav.home' => ['en' => 'Home', 'el' => 'Αρχική'],
|
||||||
|
'nav.products' => ['en' => 'Products', 'el' => 'Προϊόντα'],
|
||||||
|
'nav.cart' => ['en' => 'Cart', 'el' => 'Καλάθι'],
|
||||||
|
'nav.account' => ['en' => 'Account', 'el' => 'Λογαριασμός'],
|
||||||
|
'nav.back' => ['en' => 'Back', 'el' => 'Πίσω'],
|
||||||
|
'cart.empty' => ['en' => 'Your cart is empty', 'el' => 'Το καλάθι σας είναι άδειο'],
|
||||||
|
'cart.checkout' => ['en' => 'Checkout', 'el' => 'Ολοκλήρωση Παραγγελίας'],
|
||||||
|
'cart.total' => ['en' => 'Total', 'el' => 'Σύνολο'],
|
||||||
|
'cart.remove' => ['en' => 'Remove', 'el' => 'Αφαίρεση'],
|
||||||
|
'product.add_to_cart' => ['en' => 'Add to Cart', 'el' => 'Προσθήκη στο Καλάθι'],
|
||||||
|
'product.out_of_stock' => ['en' => 'Out of Stock', 'el' => 'Εξαντλήθηκε'],
|
||||||
|
'product.price' => ['en' => 'Price', 'el' => 'Τιμή'],
|
||||||
|
'auth.login' => ['en' => 'Log In', 'el' => 'Σύνδεση'],
|
||||||
|
'auth.logout' => ['en' => 'Log Out', 'el' => 'Αποσύνδεση'],
|
||||||
|
'search.placeholder' => ['en' => 'Search products…', 'el' => 'Αναζήτηση προϊόντων…'],
|
||||||
|
];
|
||||||
|
|
||||||
|
foreach ($labels as $key => $text) {
|
||||||
|
LanguageLine::create([
|
||||||
|
'group' => 'storefront',
|
||||||
|
'key' => $key,
|
||||||
|
'text' => $text,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ use Lunar\Shipping\ShippingPlugin;
|
|||||||
use Modules\Core\Auth\Extensions\StaffResourceExtension;
|
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\Review\Extensions\ProductResourceExtension;
|
use Modules\Core\Review\Extensions\ProductResourceExtension;
|
||||||
use Modules\Core\Review\Models\ProductReview;
|
use Modules\Core\Review\Models\ProductReview;
|
||||||
|
|
||||||
@@ -32,6 +33,9 @@ class CorePlugin implements Plugin
|
|||||||
->brandLogo(asset('static/logos/core/boboko-logo.svg'))
|
->brandLogo(asset('static/logos/core/boboko-logo.svg'))
|
||||||
->darkModeBrandLogo(asset('static/logos/core/boboko-logo-white.svg'))
|
->darkModeBrandLogo(asset('static/logos/core/boboko-logo-white.svg'))
|
||||||
->login(Login::class)
|
->login(Login::class)
|
||||||
|
->resources([
|
||||||
|
LanguageLineResource::class,
|
||||||
|
])
|
||||||
->plugin(ShippingPlugin::make());
|
->plugin(ShippingPlugin::make());
|
||||||
|
|
||||||
LunarPanel::extensions([
|
LunarPanel::extensions([
|
||||||
|
|||||||
@@ -0,0 +1,12 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Events;
|
||||||
|
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
|
||||||
|
class LanguageCreated
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
public readonly Language $language,
|
||||||
|
) {}
|
||||||
|
}
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Events;
|
||||||
|
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
|
||||||
|
class LanguageDeleted
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
public readonly Language $language,
|
||||||
|
) {}
|
||||||
|
}
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Events;
|
||||||
|
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
|
||||||
|
class LanguageUpdated
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @param array{code: string} $old Snapshot of watched attributes before the update.
|
||||||
|
*/
|
||||||
|
public function __construct(
|
||||||
|
public readonly Language $language,
|
||||||
|
public readonly array $old,
|
||||||
|
) {}
|
||||||
|
}
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Events;
|
||||||
|
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
|
class TranslationCreated
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
public readonly LanguageLine $languageLine,
|
||||||
|
) {}
|
||||||
|
}
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Events;
|
||||||
|
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
|
class TranslationDeleted
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
public readonly LanguageLine $languageLine,
|
||||||
|
) {}
|
||||||
|
}
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Events;
|
||||||
|
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
|
class TranslationUpdated
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @param array{group: string, key: string, text: array} $old Snapshot before the update.
|
||||||
|
*/
|
||||||
|
public function __construct(
|
||||||
|
public readonly LanguageLine $languageLine,
|
||||||
|
public readonly array $old,
|
||||||
|
) {}
|
||||||
|
}
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Filament\Resources;
|
||||||
|
|
||||||
|
use Filament\Forms;
|
||||||
|
use Filament\Forms\Form;
|
||||||
|
use Filament\Resources\Resource;
|
||||||
|
use Filament\Tables;
|
||||||
|
use Filament\Tables\Table;
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
use Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages;
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
|
class LanguageLineResource extends Resource
|
||||||
|
{
|
||||||
|
protected static ?string $model = LanguageLine::class;
|
||||||
|
|
||||||
|
protected static ?string $navigationIcon = 'heroicon-o-language';
|
||||||
|
|
||||||
|
protected static ?string $navigationGroup = 'Settings';
|
||||||
|
|
||||||
|
protected static ?string $modelLabel = 'Translation';
|
||||||
|
|
||||||
|
protected static ?string $pluralModelLabel = 'Translations';
|
||||||
|
|
||||||
|
public static function form(Form $form): Form
|
||||||
|
{
|
||||||
|
return $form->schema([
|
||||||
|
Forms\Components\TextInput::make('group')
|
||||||
|
->required()
|
||||||
|
->maxLength(255)
|
||||||
|
->default('storefront')
|
||||||
|
->helperText('Namespace for this label, e.g. "storefront" for e-shop UI text.'),
|
||||||
|
|
||||||
|
Forms\Components\TextInput::make('key')
|
||||||
|
->required()
|
||||||
|
->maxLength(255)
|
||||||
|
->helperText('Dot-notation key, e.g. "nav.cart".'),
|
||||||
|
|
||||||
|
Forms\Components\Fieldset::make('Translations')
|
||||||
|
->schema(static::localeInputs()),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function table(Table $table): Table
|
||||||
|
{
|
||||||
|
return $table
|
||||||
|
->columns([
|
||||||
|
Tables\Columns\TextColumn::make('group')
|
||||||
|
->badge()
|
||||||
|
->sortable(),
|
||||||
|
Tables\Columns\TextColumn::make('key')
|
||||||
|
->searchable()
|
||||||
|
->sortable(),
|
||||||
|
...static::localeColumns(),
|
||||||
|
])
|
||||||
|
->filters([
|
||||||
|
Tables\Filters\SelectFilter::make('group')
|
||||||
|
->options(fn () => LanguageLine::query()->distinct()->pluck('group', 'group')),
|
||||||
|
])
|
||||||
|
->defaultSort('key');
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function getRelations(): array
|
||||||
|
{
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function getPages(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'index' => Pages\ListLanguageLines::route('/'),
|
||||||
|
'create' => Pages\CreateLanguageLine::route('/create'),
|
||||||
|
'edit' => Pages\EditLanguageLine::route('/{record}/edit'),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array<Forms\Components\Textarea>
|
||||||
|
*/
|
||||||
|
private static function localeInputs(): array
|
||||||
|
{
|
||||||
|
return static::localeCodes()
|
||||||
|
->map(fn (string $code) => Forms\Components\Textarea::make("text.{$code}")
|
||||||
|
->label(strtoupper($code))
|
||||||
|
->rows(2))
|
||||||
|
->all();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array<Tables\Columns\TextColumn>
|
||||||
|
*/
|
||||||
|
private static function localeColumns(): array
|
||||||
|
{
|
||||||
|
return static::localeCodes()
|
||||||
|
->map(fn (string $code) => Tables\Columns\TextColumn::make("text.{$code}")
|
||||||
|
->label(strtoupper($code))
|
||||||
|
->limit(40)
|
||||||
|
->toggleable())
|
||||||
|
->all();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static function localeCodes(): \Illuminate\Support\Collection
|
||||||
|
{
|
||||||
|
return Language::query()->pluck('code');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages;
|
||||||
|
|
||||||
|
use Filament\Resources\Pages\CreateRecord;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Modules\Core\Localization\Filament\Resources\LanguageLineResource;
|
||||||
|
use Modules\Core\Localization\TranslationService;
|
||||||
|
|
||||||
|
class CreateLanguageLine extends CreateRecord
|
||||||
|
{
|
||||||
|
protected static string $resource = LanguageLineResource::class;
|
||||||
|
|
||||||
|
protected function handleRecordCreation(array $data): Model
|
||||||
|
{
|
||||||
|
return app(TranslationService::class)->create(
|
||||||
|
$data['group'],
|
||||||
|
$data['key'],
|
||||||
|
$data['text'] ?? [],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages;
|
||||||
|
|
||||||
|
use Filament\Actions;
|
||||||
|
use Filament\Actions\Action;
|
||||||
|
use Filament\Resources\Pages\EditRecord;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Modules\Core\Localization\Filament\Resources\LanguageLineResource;
|
||||||
|
use Modules\Core\Localization\TranslationService;
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
|
class EditLanguageLine extends EditRecord
|
||||||
|
{
|
||||||
|
protected static string $resource = LanguageLineResource::class;
|
||||||
|
|
||||||
|
protected function getHeaderActions(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
Actions\DeleteAction::make()
|
||||||
|
->action(function (LanguageLine $record) {
|
||||||
|
app(TranslationService::class)->delete($record);
|
||||||
|
|
||||||
|
$this->redirect($this->getResource()::getUrl('index'));
|
||||||
|
}),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filament's default Cancel button uses window.history.back(), which
|
||||||
|
* restores the browser's cached previous page instead of re-fetching —
|
||||||
|
* so an edit made just before clicking Cancel doesn't show up in the
|
||||||
|
* list until a manual refresh. Redirect through Livewire instead, which
|
||||||
|
* always re-queries.
|
||||||
|
*/
|
||||||
|
protected function getCancelFormAction(): Action
|
||||||
|
{
|
||||||
|
return Action::make('cancel')
|
||||||
|
->label(__('filament-panels::resources/pages/edit-record.form.actions.cancel.label'))
|
||||||
|
->url(static::getResource()::getUrl('index'))
|
||||||
|
->color('gray');
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function handleRecordUpdate(Model $record, array $data): Model
|
||||||
|
{
|
||||||
|
return app(TranslationService::class)->update(
|
||||||
|
$record,
|
||||||
|
$data['group'],
|
||||||
|
$data['key'],
|
||||||
|
$data['text'] ?? [],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Filament\Resources\LanguageLineResource\Pages;
|
||||||
|
|
||||||
|
use Filament\Actions;
|
||||||
|
use Filament\Resources\Pages\ListRecords;
|
||||||
|
use Modules\Core\Localization\Filament\Resources\LanguageLineResource;
|
||||||
|
|
||||||
|
class ListLanguageLines extends ListRecords
|
||||||
|
{
|
||||||
|
protected static string $resource = LanguageLineResource::class;
|
||||||
|
|
||||||
|
protected function getHeaderActions(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
Actions\CreateAction::make(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Event;
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
use Modules\Core\Localization\Events\LanguageCreated;
|
||||||
|
use Modules\Core\Localization\Events\LanguageDeleted;
|
||||||
|
use Modules\Core\Localization\Events\LanguageUpdated;
|
||||||
|
|
||||||
|
class LanguageCacheObserver
|
||||||
|
{
|
||||||
|
public function created(Language $language): void
|
||||||
|
{
|
||||||
|
Event::dispatch(new LanguageCreated($language));
|
||||||
|
}
|
||||||
|
|
||||||
|
public function updated(Language $language): void
|
||||||
|
{
|
||||||
|
Event::dispatch(new LanguageUpdated($language, [
|
||||||
|
'code' => $language->getOriginal('code'),
|
||||||
|
]));
|
||||||
|
}
|
||||||
|
|
||||||
|
public function deleted(Language $language): void
|
||||||
|
{
|
||||||
|
Event::dispatch(new LanguageDeleted($language));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Listeners;
|
||||||
|
|
||||||
|
use Modules\Core\Localization\Events\LanguageCreated;
|
||||||
|
use Modules\Core\Localization\Events\LanguageDeleted;
|
||||||
|
use Modules\Core\Localization\Events\LanguageUpdated;
|
||||||
|
use Modules\Core\Localization\LocaleMiddleware;
|
||||||
|
|
||||||
|
class FlushLanguageCache
|
||||||
|
{
|
||||||
|
public function handle(LanguageCreated|LanguageUpdated|LanguageDeleted $event): void
|
||||||
|
{
|
||||||
|
LocaleMiddleware::forgetLanguagesCache();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Cache;
|
||||||
|
use Modules\Core\Localization\Events\TranslationCreated;
|
||||||
|
use Modules\Core\Localization\Events\TranslationDeleted;
|
||||||
|
use Modules\Core\Localization\Events\TranslationUpdated;
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* LanguageLine::boot() already flushes the cache for the current group's locales
|
||||||
|
* present after a save, but misses two cases on update: locales removed from
|
||||||
|
* `text` (e.g. dropping the "el" key leaves `{group}.el` stale), and a changed
|
||||||
|
* `group`/`key` (the old group's cached array never gets told a row left it).
|
||||||
|
* This listener flushes every group+locale combination touched by either the
|
||||||
|
* old or new state so nothing can remain stale.
|
||||||
|
*/
|
||||||
|
class FlushTranslationCache
|
||||||
|
{
|
||||||
|
public function handle(TranslationCreated|TranslationUpdated|TranslationDeleted $event): void
|
||||||
|
{
|
||||||
|
$this->flush($event->languageLine->group, array_keys($event->languageLine->text ?? []));
|
||||||
|
|
||||||
|
if ($event instanceof TranslationUpdated) {
|
||||||
|
$this->flush($event->old['group'], array_keys($event->old['text'] ?? []));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private function flush(string $group, array $locales): void
|
||||||
|
{
|
||||||
|
foreach ($locales as $locale) {
|
||||||
|
Cache::forget(LanguageLine::getCacheKey($group, $locale));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Support\Arr;
|
||||||
|
use Modules\Core\Localization\Events\TranslationCreated;
|
||||||
|
use Modules\Core\Localization\Events\TranslationDeleted;
|
||||||
|
use Modules\Core\Localization\Events\TranslationUpdated;
|
||||||
|
use Modules\Core\Logging\ActivityLogService;
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
|
class LogTranslationActivity
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
private readonly ActivityLogService $activityLog,
|
||||||
|
) {}
|
||||||
|
|
||||||
|
public function handle(TranslationCreated|TranslationUpdated|TranslationDeleted $event): void
|
||||||
|
{
|
||||||
|
$languageLine = $event->languageLine;
|
||||||
|
|
||||||
|
match (true) {
|
||||||
|
$event instanceof TranslationCreated => $this->activityLog->created(
|
||||||
|
$languageLine,
|
||||||
|
$this->flatten($languageLine),
|
||||||
|
),
|
||||||
|
$event instanceof TranslationUpdated => $this->activityLog->updated(
|
||||||
|
$languageLine,
|
||||||
|
Arr::dot($event->old),
|
||||||
|
$this->flatten($languageLine),
|
||||||
|
),
|
||||||
|
$event instanceof TranslationDeleted => $this->activityLog->deleted(
|
||||||
|
$languageLine,
|
||||||
|
$this->flatten($languageLine),
|
||||||
|
),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filament's Activity resource renders `properties` with a flat KeyValue
|
||||||
|
* field, which can't display a nested value like `text: {en, el}` — it
|
||||||
|
* shows as "[object Object]". Flatten to dot-notation ("text.en",
|
||||||
|
* "text.el") so every property is a plain string, viewable as-is.
|
||||||
|
*/
|
||||||
|
private function flatten(LanguageLine $languageLine): array
|
||||||
|
{
|
||||||
|
return Arr::dot([
|
||||||
|
'group' => $languageLine->group,
|
||||||
|
'key' => $languageLine->key,
|
||||||
|
'text' => $languageLine->text,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Cache;
|
||||||
|
use Modules\Core\Localization\Events\LanguageUpdated;
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A renamed Language::code (e.g. "el" -> "gr") would otherwise strand every
|
||||||
|
* LanguageLine's translated text under the old, now-unroutable key —
|
||||||
|
* getTranslationsForGroup($newCode, ...) would silently return nothing for
|
||||||
|
* that locale even though the translated content still exists. Move the
|
||||||
|
* text.{oldCode} key to text.{newCode} on every affected row instead.
|
||||||
|
*/
|
||||||
|
class MigrateTranslationsForRenamedLanguage
|
||||||
|
{
|
||||||
|
public function handle(LanguageUpdated $event): void
|
||||||
|
{
|
||||||
|
$oldCode = $event->old['code'];
|
||||||
|
$newCode = $event->language->code;
|
||||||
|
|
||||||
|
if ($oldCode === $newCode) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$affectedGroups = [];
|
||||||
|
|
||||||
|
LanguageLine::query()
|
||||||
|
->whereJsonContainsKey('text->'.$oldCode)
|
||||||
|
->each(function (LanguageLine $languageLine) use ($oldCode, $newCode, &$affectedGroups) {
|
||||||
|
$text = $languageLine->text;
|
||||||
|
$text[$newCode] = $text[$oldCode];
|
||||||
|
unset($text[$oldCode]);
|
||||||
|
|
||||||
|
$languageLine->update(['text' => $text]);
|
||||||
|
|
||||||
|
$affectedGroups[$languageLine->group] = true;
|
||||||
|
});
|
||||||
|
|
||||||
|
foreach (array_keys($affectedGroups) as $group) {
|
||||||
|
Cache::forget(LanguageLine::getCacheKey($group, $oldCode));
|
||||||
|
Cache::forget(LanguageLine::getCacheKey($group, $newCode));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization;
|
||||||
|
|
||||||
|
use Closure;
|
||||||
|
use Illuminate\Http\Request;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
use Illuminate\Support\Facades\App;
|
||||||
|
use Illuminate\Support\Facades\Cache;
|
||||||
|
use Illuminate\Support\Facades\URL;
|
||||||
|
use Illuminate\Support\Facades\View;
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
use Symfony\Component\HttpFoundation\Response;
|
||||||
|
|
||||||
|
class LocaleMiddleware
|
||||||
|
{
|
||||||
|
private const CACHE_KEY = 'core.localization.languages';
|
||||||
|
|
||||||
|
public function handle(Request $request, Closure $next): Response
|
||||||
|
{
|
||||||
|
$languages = $this->availableLanguages();
|
||||||
|
|
||||||
|
if ($languages->isEmpty()) {
|
||||||
|
return $next($request);
|
||||||
|
}
|
||||||
|
|
||||||
|
$segment = (string) $request->segment(1);
|
||||||
|
$language = $languages->firstWhere('code', $segment);
|
||||||
|
|
||||||
|
if (! $language) {
|
||||||
|
return $this->redirectToLocalizedUrl($request, $languages);
|
||||||
|
}
|
||||||
|
|
||||||
|
App::setLocale($language->code);
|
||||||
|
$request->attributes->set('locale', $language->code);
|
||||||
|
$request->attributes->set('language', $language);
|
||||||
|
|
||||||
|
// Lets route() calls omit {locale} anywhere in the request lifecycle
|
||||||
|
// (controllers, views) — without this, every route() call would need
|
||||||
|
// locale passed explicitly every time.
|
||||||
|
URL::defaults(['locale' => $language->code]);
|
||||||
|
|
||||||
|
$this->shareLocaleViewData($request, $language, $languages);
|
||||||
|
|
||||||
|
return $next($request);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function forgetLanguagesCache(): void
|
||||||
|
{
|
||||||
|
Cache::forget(self::CACHE_KEY);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The store's default language code (e.g. 'el') - the fixed fallback other
|
||||||
|
* locale-aware code (Modules\Core\Catalog\ProductService) should use, as
|
||||||
|
* opposed to config('app.locale') which App::setLocale() mutates per
|
||||||
|
* request and so can't serve as a stable fallback.
|
||||||
|
*/
|
||||||
|
public static function defaultLocale(): ?string
|
||||||
|
{
|
||||||
|
return (new self)->availableLanguages()->firstWhere('default', true)?->code;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shares the current/alternate locale (and the alternate's URL) with all
|
||||||
|
* views, so the header language switcher and layout hreflang tags don't
|
||||||
|
* have to recompute it.
|
||||||
|
*/
|
||||||
|
private function shareLocaleViewData(Request $request, Language $language, Collection $languages): void
|
||||||
|
{
|
||||||
|
$altLanguage = $languages->firstWhere('code', '!=', $language->code);
|
||||||
|
$route = $request->route();
|
||||||
|
$routeName = $route?->getName();
|
||||||
|
|
||||||
|
View::share('currentLocale', $language->code);
|
||||||
|
View::share('altLocale', $altLanguage?->code);
|
||||||
|
View::share(
|
||||||
|
'altLocaleUrl',
|
||||||
|
$altLanguage && $routeName
|
||||||
|
? route($routeName, array_merge($route->parameters(), ['locale' => $altLanguage->code]))
|
||||||
|
: ($altLanguage ? url('/'.$altLanguage->code) : null),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function redirectToLocalizedUrl(Request $request, Collection $languages): Response
|
||||||
|
{
|
||||||
|
$locale = $this->negotiateLocale($request, $languages);
|
||||||
|
|
||||||
|
$path = trim($request->getPathInfo(), '/');
|
||||||
|
$target = '/'.$locale.($path !== '' ? '/'.$path : '');
|
||||||
|
|
||||||
|
$query = $request->getQueryString();
|
||||||
|
if ($query) {
|
||||||
|
$target .= '?'.$query;
|
||||||
|
}
|
||||||
|
|
||||||
|
return redirect($target);
|
||||||
|
}
|
||||||
|
|
||||||
|
private function negotiateLocale(Request $request, Collection $languages): string
|
||||||
|
{
|
||||||
|
$preferred = $request->getPreferredLanguage($languages->pluck('code')->all());
|
||||||
|
|
||||||
|
if ($preferred) {
|
||||||
|
return $preferred;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $languages->firstWhere('default', true)?->code
|
||||||
|
?? $languages->first()->code;
|
||||||
|
}
|
||||||
|
|
||||||
|
private function availableLanguages(): Collection
|
||||||
|
{
|
||||||
|
return Cache::rememberForever(
|
||||||
|
self::CACHE_KEY,
|
||||||
|
fn () => Language::query()->get(['id', 'code', 'name', 'default']),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\App;
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
|
class TranslationReader
|
||||||
|
{
|
||||||
|
private const DEFAULT_GROUP = 'storefront';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* All labels in a group for the given (or current) locale, keyed by their
|
||||||
|
* dot-notation key — e.g. ['nav.cart' => 'Cart', 'nav.home' => 'Home'].
|
||||||
|
* Backed by LanguageLine's own forever-cache, so this is a cache hit after
|
||||||
|
* the first call for a given group+locale.
|
||||||
|
*/
|
||||||
|
public function group(string $group = self::DEFAULT_GROUP, ?string $locale = null): array
|
||||||
|
{
|
||||||
|
return LanguageLine::getTranslationsForGroup($locale ?? App::getLocale(), $group);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Localization;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Event;
|
||||||
|
use Modules\Core\Localization\Events\TranslationCreated;
|
||||||
|
use Modules\Core\Localization\Events\TranslationDeleted;
|
||||||
|
use Modules\Core\Localization\Events\TranslationUpdated;
|
||||||
|
use Spatie\TranslationLoader\LanguageLine;
|
||||||
|
|
||||||
|
class TranslationService
|
||||||
|
{
|
||||||
|
public function create(string $group, string $key, array $text): LanguageLine
|
||||||
|
{
|
||||||
|
$languageLine = LanguageLine::create([
|
||||||
|
'group' => $group,
|
||||||
|
'key' => $key,
|
||||||
|
'text' => $text,
|
||||||
|
]);
|
||||||
|
|
||||||
|
Event::dispatch(new TranslationCreated($languageLine));
|
||||||
|
|
||||||
|
return $languageLine;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function update(LanguageLine $languageLine, string $group, string $key, array $text): LanguageLine
|
||||||
|
{
|
||||||
|
// Callers (e.g. Filament's EditRecord) may hand us a model instance
|
||||||
|
// already filled with the new form values in memory — refresh from the
|
||||||
|
// database first so $old reflects what's actually persisted, not what's
|
||||||
|
// about to be written.
|
||||||
|
$persisted = $languageLine->fresh();
|
||||||
|
|
||||||
|
$old = [
|
||||||
|
'group' => $persisted->group,
|
||||||
|
'key' => $persisted->key,
|
||||||
|
'text' => $persisted->text,
|
||||||
|
];
|
||||||
|
|
||||||
|
$languageLine->update([
|
||||||
|
'group' => $group,
|
||||||
|
'key' => $key,
|
||||||
|
'text' => $text,
|
||||||
|
]);
|
||||||
|
|
||||||
|
Event::dispatch(new TranslationUpdated($languageLine, $old));
|
||||||
|
|
||||||
|
return $languageLine;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function delete(LanguageLine $languageLine): void
|
||||||
|
{
|
||||||
|
$languageLine->delete();
|
||||||
|
|
||||||
|
Event::dispatch(new TranslationDeleted($languageLine));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -26,6 +26,7 @@ class CoreServiceProvider extends ServiceProvider
|
|||||||
|
|
||||||
$this->publishes([
|
$this->publishes([
|
||||||
__DIR__ . '/../../config/core.php' => config_path('core.php'),
|
__DIR__ . '/../../config/core.php' => config_path('core.php'),
|
||||||
|
__DIR__ . '/../../config/scout.php' => config_path('scout.php'),
|
||||||
], 'core-config');
|
], 'core-config');
|
||||||
|
|
||||||
$this->publishes([
|
$this->publishes([
|
||||||
|
|||||||
@@ -0,0 +1,39 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Providers;
|
||||||
|
|
||||||
|
use Illuminate\Support\Facades\Event;
|
||||||
|
use Illuminate\Support\ServiceProvider;
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
use Modules\Core\Localization\Events\LanguageCreated;
|
||||||
|
use Modules\Core\Localization\Events\LanguageDeleted;
|
||||||
|
use Modules\Core\Localization\Events\LanguageUpdated;
|
||||||
|
use Modules\Core\Localization\Events\TranslationCreated;
|
||||||
|
use Modules\Core\Localization\Events\TranslationDeleted;
|
||||||
|
use Modules\Core\Localization\Events\TranslationUpdated;
|
||||||
|
use Modules\Core\Localization\LanguageCacheObserver;
|
||||||
|
use Modules\Core\Localization\Listeners\FlushLanguageCache;
|
||||||
|
use Modules\Core\Localization\Listeners\FlushTranslationCache;
|
||||||
|
use Modules\Core\Localization\Listeners\LogTranslationActivity;
|
||||||
|
use Modules\Core\Localization\Listeners\MigrateTranslationsForRenamedLanguage;
|
||||||
|
use Modules\Core\Localization\LocaleMiddleware;
|
||||||
|
|
||||||
|
class LocalizationServiceProvider extends ServiceProvider
|
||||||
|
{
|
||||||
|
public function boot(): void
|
||||||
|
{
|
||||||
|
$this->app['router']->aliasMiddleware('locale', LocaleMiddleware::class);
|
||||||
|
Language::observe(LanguageCacheObserver::class);
|
||||||
|
|
||||||
|
foreach ([TranslationCreated::class, TranslationUpdated::class, TranslationDeleted::class] as $event) {
|
||||||
|
Event::listen($event, FlushTranslationCache::class);
|
||||||
|
Event::listen($event, LogTranslationActivity::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ([LanguageCreated::class, LanguageUpdated::class, LanguageDeleted::class] as $event) {
|
||||||
|
Event::listen($event, FlushLanguageCache::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
Event::listen(LanguageUpdated::class, MigrateTranslationsForRenamedLanguage::class);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Providers;
|
||||||
|
|
||||||
|
use Illuminate\Support\ServiceProvider;
|
||||||
|
use Modules\Core\Review\Models\ProductReview;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Keeps a product's Meilisearch document in sync with its reviews. A review is
|
||||||
|
* created/edited independently of its product (customer submission, staff reply),
|
||||||
|
* so the product's own save/update events never fire for it — without this listener,
|
||||||
|
* Modules\Core\Search\ProductIndexer's review data would only refresh on the next
|
||||||
|
* full product reindex.
|
||||||
|
*/
|
||||||
|
class ReviewServiceProvider extends ServiceProvider
|
||||||
|
{
|
||||||
|
public function boot(): void
|
||||||
|
{
|
||||||
|
ProductReview::created(fn (ProductReview $review) => $review->product?->searchable());
|
||||||
|
ProductReview::updated(fn (ProductReview $review) => $review->product?->searchable());
|
||||||
|
ProductReview::deleted(fn (ProductReview $review) => $review->product?->searchable());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,177 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Search;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Lunar\Models\Currency;
|
||||||
|
use Lunar\Models\Price;
|
||||||
|
use Lunar\Models\Product;
|
||||||
|
use Lunar\Models\ProductVariant;
|
||||||
|
use Lunar\Search\ProductIndexer as BaseProductIndexer;
|
||||||
|
use Modules\Core\Review\Models\ProductReview;
|
||||||
|
use Spatie\MediaLibrary\MediaCollections\Models\Media;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extends Lunar's own indexer so Modules\Core\Catalog\ProductService can serve both
|
||||||
|
* listing/filtering AND single-product lookups from Meilisearch alone — one data
|
||||||
|
* source, no separate database read path for a product detail page. Adds:
|
||||||
|
* - collections (ids, filterable) and collection_names (display)
|
||||||
|
* - slugs (every locale's Url::slug for the product, filterable) — lets
|
||||||
|
* ProductService::getBySlug() resolve a product from the index directly, with
|
||||||
|
* no database read at all
|
||||||
|
* - price (cheapest variant, filterable) and full per-variant pricing
|
||||||
|
* - variants: sku, stock, purchasable, option values, prices, media
|
||||||
|
* - the full media gallery (not just the single thumbnail Lunar's base indexer sends)
|
||||||
|
* - tags
|
||||||
|
* - reviews: public-safe fields only (see mapReview() — reviewer_email is deliberately
|
||||||
|
* excluded, it's PII with no storefront use), including staff replies, plus an
|
||||||
|
* average rating
|
||||||
|
*
|
||||||
|
* A review is created/edited independently of its product (Modules\Core\Providers\
|
||||||
|
* ReviewServiceProvider re-indexes the product on review create/update/delete), so
|
||||||
|
* this data doesn't go stale between full reindexes.
|
||||||
|
*
|
||||||
|
* New fields aren't filterable in Meilisearch until `php artisan lunar:meilisearch:setup`
|
||||||
|
* re-syncs index settings, and existing documents need `lunar:search:index --refresh` to
|
||||||
|
* pick up the new shape — see docs/product-listing.md. If SCOUT_QUEUE is enabled, the
|
||||||
|
* queue worker also needs restarting after deploying changes to this class (see
|
||||||
|
* docs/lunar.md "Gotchas" — a running worker keeps stale indexer code in memory).
|
||||||
|
*/
|
||||||
|
class ProductIndexer extends BaseProductIndexer
|
||||||
|
{
|
||||||
|
public function getFilterableFields(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
...parent::getFilterableFields(),
|
||||||
|
'id',
|
||||||
|
'brand',
|
||||||
|
'collections',
|
||||||
|
'price',
|
||||||
|
'slugs',
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
public function makeAllSearchableUsing(Builder $query): Builder
|
||||||
|
{
|
||||||
|
return parent::makeAllSearchableUsing($query)->with([
|
||||||
|
'collections',
|
||||||
|
'media',
|
||||||
|
'tags',
|
||||||
|
'urls',
|
||||||
|
'variants.images',
|
||||||
|
'variants.prices',
|
||||||
|
'variants.values.option',
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function toSearchableArray(Model $model): array
|
||||||
|
{
|
||||||
|
/** @var Product $model */
|
||||||
|
$data = parent::toSearchableArray($model);
|
||||||
|
|
||||||
|
$currency = Currency::getDefault();
|
||||||
|
$reviews = ProductReview::where('product_id', $model->id)->with('media')->get();
|
||||||
|
|
||||||
|
$data['collections'] = $model->collections->pluck('id')->map(fn ($id) => (string) $id)->all();
|
||||||
|
$data['collection_names'] = $model->collections->map(fn ($collection) => $collection->translateAttribute('name'))->all();
|
||||||
|
$data['slugs'] = $model->urls->pluck('slug')->unique()->values()->all();
|
||||||
|
$data['tags'] = $model->tags->pluck('value')->all();
|
||||||
|
$data['media'] = $model->media->map(fn (Media $media) => $this->mapMedia($media))->all();
|
||||||
|
$data['variants'] = $model->variants->map(fn (ProductVariant $variant) => $this->mapVariant($variant, $currency))->all();
|
||||||
|
$data['price'] = $this->cheapestPrice($model, $currency);
|
||||||
|
$data['reviews'] = $reviews->map(fn (ProductReview $review) => $this->mapReview($review))->all();
|
||||||
|
$data['review_count'] = $reviews->count();
|
||||||
|
$data['average_rating'] = $reviews->isEmpty() ? null : round($reviews->avg('rating'), 1);
|
||||||
|
|
||||||
|
return $data;
|
||||||
|
}
|
||||||
|
|
||||||
|
private function mapVariant(ProductVariant $variant, Currency $currency): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'id' => $variant->id,
|
||||||
|
'sku' => $variant->sku,
|
||||||
|
'stock' => $variant->stock,
|
||||||
|
'purchasable' => $variant->purchasable,
|
||||||
|
'options' => $variant->values->map(fn ($value) => [
|
||||||
|
'option' => $this->translatedName($value->option->name),
|
||||||
|
'value' => $this->translatedName($value->name),
|
||||||
|
'meta' => $value->meta,
|
||||||
|
])->all(),
|
||||||
|
'prices' => $variant->prices->map(fn (Price $price) => [
|
||||||
|
'currency_id' => $price->currency_id,
|
||||||
|
'customer_group_id' => $price->customer_group_id,
|
||||||
|
'price' => $price->price->decimal(),
|
||||||
|
'compare_price' => $price->compare_price?->decimal(),
|
||||||
|
'min_quantity' => $price->min_quantity,
|
||||||
|
])->all(),
|
||||||
|
'media' => $variant->images->map(fn (Media $media) => $this->mapMedia($media))->all(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public-safe fields only — reviewer_email is PII with no storefront use and is
|
||||||
|
* deliberately excluded, unlike every other column on the review. reply/replied_at
|
||||||
|
* (the staff response) are included since they're meant to be shown alongside the
|
||||||
|
* review on the storefront.
|
||||||
|
*/
|
||||||
|
private function mapReview(ProductReview $review): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'id' => $review->id,
|
||||||
|
'title' => $review->title,
|
||||||
|
'body' => $review->body,
|
||||||
|
'rating' => $review->rating,
|
||||||
|
'reviewed_at' => $review->reviewed_at?->timestamp,
|
||||||
|
'reviewer_name' => $review->reviewer_name,
|
||||||
|
'reply' => $review->reply,
|
||||||
|
'replied_at' => $review->replied_at?->timestamp,
|
||||||
|
'location' => $review->location,
|
||||||
|
'media' => $review->media->map(fn (Media $media) => $this->mapMedia($media))->all(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ProductOption/ProductOptionValue's `name` is a plain locale-keyed array cast
|
||||||
|
* (AsArrayObject) directly on the column — unlike Product/Collection/Brand, it is
|
||||||
|
* not stored in attribute_data. Lunar's translateAttribute() only reads
|
||||||
|
* attribute_data, so it silently returns null for these two models; this reads
|
||||||
|
* the array directly instead. Falls back to the first available locale if the
|
||||||
|
* current one is missing. Not a general replacement for translateAttribute() —
|
||||||
|
* every other translated field in this indexer (product/collection name and
|
||||||
|
* description) genuinely is attribute_data-backed and translateAttribute() is
|
||||||
|
* correct for those.
|
||||||
|
*/
|
||||||
|
private function translatedName(mixed $name): ?string
|
||||||
|
{
|
||||||
|
$names = is_array($name) ? $name : (array) $name;
|
||||||
|
|
||||||
|
return $names[app()->getLocale()] ?? reset($names) ?: null;
|
||||||
|
}
|
||||||
|
|
||||||
|
private function mapMedia(Media $media): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'id' => $media->id,
|
||||||
|
'url' => $media->getUrl(),
|
||||||
|
'thumb' => $media->getUrl('small'),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The cheapest variant's base price (no customer group) in the default currency,
|
||||||
|
* as a float in major units — e.g. 19.99, not 1999. Null if the product has no
|
||||||
|
* variant with a price in that currency yet, so it's excluded from price filters
|
||||||
|
* rather than sorting to the bottom as if it were free.
|
||||||
|
*/
|
||||||
|
private function cheapestPrice(Product $model, Currency $currency): ?float
|
||||||
|
{
|
||||||
|
$price = $model->variants
|
||||||
|
->flatMap(fn ($variant) => $variant->prices)
|
||||||
|
->filter(fn ($price) => $price->currency_id === $currency->id && $price->customer_group_id === null)
|
||||||
|
->min(fn ($price) => $price->price->value);
|
||||||
|
|
||||||
|
return $price !== null ? $price / (10 ** $currency->decimal_places) : null;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Modules\Core\Search;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Collection;
|
||||||
|
use Illuminate\Support\Facades\App;
|
||||||
|
use Lunar\Facades\AttributeManifest;
|
||||||
|
use Lunar\Models\Language;
|
||||||
|
use Lunar\Models\Product;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lunar's Meilisearch indexer flattens translated attributes into locale-suffixed
|
||||||
|
* fields on a single document (name_en, name_el, description_en, description_el —
|
||||||
|
* see Lunar\Search\ScoutIndexer::mapSearchableAttributes()), not separate indexes
|
||||||
|
* or a filterable locale field. Locale-aware search means choosing which fields
|
||||||
|
* to search on, not filtering results by locale.
|
||||||
|
*/
|
||||||
|
class ProductSearchService
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @return Collection<int, Product>
|
||||||
|
*/
|
||||||
|
public function search(string $query, ?string $locale = null): Collection
|
||||||
|
{
|
||||||
|
$locale ??= App::getLocale();
|
||||||
|
$defaultLocale = Language::getDefault()->code;
|
||||||
|
|
||||||
|
return Product::search($query)
|
||||||
|
->options([
|
||||||
|
'attributesToSearchOn' => $this->searchableFields($locale, $defaultLocale),
|
||||||
|
])
|
||||||
|
->get();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Target the resolved locale's fields plus the default locale's fields, so a
|
||||||
|
* product that's only ever been translated into the default language still
|
||||||
|
* surfaces when searched in another locale, instead of becoming invisible
|
||||||
|
* until every product is fully translated.
|
||||||
|
*
|
||||||
|
* @return array<int, string>
|
||||||
|
*/
|
||||||
|
private function searchableFields(string $locale, string $defaultLocale): array
|
||||||
|
{
|
||||||
|
$handles = AttributeManifest::getSearchableAttributes(Product::morphName())
|
||||||
|
->pluck('handle');
|
||||||
|
|
||||||
|
$locales = array_unique([$locale, $defaultLocale]);
|
||||||
|
|
||||||
|
return $handles
|
||||||
|
->crossJoin($locales)
|
||||||
|
->map(fn (array $pair) => "{$pair[0]}_{$pair[1]}")
|
||||||
|
->values()
|
||||||
|
->all();
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user