forked from fa/breadcrumb-the-shire
fs
c7b8fd516a
Completes the generic module platform that enables modules to contribute
UI elements, runtime JS components, and search resources without any
core hardcoding.
New generic UI slot types:
- topbar.right_item: module-contributed topbar buttons
- layout.body_end_template: module-contributed dialog/overlay templates
- layout.head_style: module-contributed global CSS
- runtime.component: declarative JS component registration with phase ordering
New infrastructure:
- ModuleAutoloader: PSR-4 autoloading for module-local PHP classes
- ModuleRuntimePageBuilder: symlinks module pages into runtime directory
- ModuleRuntimeAssetPublisher: publishes module CSS/JS to web/modules/
- ModulePermissionSynchronizer: syncs module permissions to DB
- CLI scripts: module-runtime-sync, module-build, module-migrate,
module-permissions-sync, module-assets-sync
- {{userId}} placeholder in SearchDataService for user-scoped search queries
- Component runtime with phased initialization (early/default/late)
- AppContainer.protectExistingBindings() to prevent module→core overwrites
- Architecture tests: ModuleStructureContractTest, CoreTemplateIsolationTest,
FrontendComponentRuntimeContractTest, AppContainerIsolationContractTest
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
47 lines
1.5 KiB
PHP
47 lines
1.5 KiB
PHP
<?php
|
|
|
|
namespace MintyPHP\App\Module\Contracts;
|
|
|
|
/**
|
|
* Provides search resources contributed by a module.
|
|
*
|
|
* Each provider returns a list of search resources (with SQL for count/preview/result),
|
|
* maps result rows to display items, and provides list URLs for deep-linking.
|
|
*/
|
|
interface SearchResourceProvider
|
|
{
|
|
/**
|
|
* Return search resource definitions.
|
|
*
|
|
* Supported SQL placeholders (replaced before parameter binding):
|
|
* - `{{tenantFilter}}` — replaced with a tenant-scope WHERE clause (or empty string)
|
|
* - `{{userId}}` — replaced with the current user's ID (integer, safe for inline SQL)
|
|
*
|
|
* All remaining `?` placeholders are bound to the LIKE search term.
|
|
* The last `?` in preview_sql is reserved for the preview limit.
|
|
*
|
|
* @return array<string, array{
|
|
* label: string,
|
|
* permission: string,
|
|
* count_sql: string,
|
|
* preview_sql: string,
|
|
* result_sql: string,
|
|
* tenant_filter?: string
|
|
* }>
|
|
*/
|
|
public function resources(): array;
|
|
|
|
/**
|
|
* Map a raw result row to a display-ready item.
|
|
*
|
|
* @param array<string, mixed> $row
|
|
* @return array{title: string, subtitle?: string, url: string, icon?: string}|null
|
|
*/
|
|
public function mapResultItem(string $resourceKey, array $row): ?array;
|
|
|
|
/**
|
|
* Return the list URL for the given resource key and encoded search term.
|
|
*/
|
|
public function listUrl(string $resourceKey, string $encodedSearch): string;
|
|
}
|