forked from fa/breadcrumb-the-shire
fs
0e86925464
Rename the top-level lib/ directory to core/ so the project root immediately communicates which code is core platform and which lives in modules/. PHP namespaces (MintyPHP\*) are unchanged — only the Composer PSR-4 path mapping moves from lib/ to core/. Module-internal lib/ directories (modules/*/lib/) are untouched. Updated across the full stack: - composer.json PSR-4 mapping - bootstrap entry points (web/index.php, bin/*, tests/bootstrap.php) - tooling configs (phpstan.neon, phpunit.xml, php-cs-fixer) - 26 architecture contract tests - enforcement-policy, guard-catalog, quality-gates - all documentation (CLAUDE.md, README, 25 docs/, .agents/skills/) - bin/qa-extended.sh search paths - .claude/settings.local.json permission paths Workflow: .agents/runs/CORE-LIB-RENAME-001/ (Analyst → Planner → Executor → Code Review (4 findings fixed) → Security Review → Acceptance Test → Finalizer) Co-Authored-By: Claude Opus 4.6 <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;
|
|
}
|