| 1: | <?php |
| 2: | |
| 3: | namespace LaravelUi5\Core\Contracts; |
| 4: | |
| 5: | use LaravelUi5\Core\Attributes\Parameter; |
| 6: | use LaravelUi5\Core\Exceptions\InvalidParameterException; |
| 7: | use LaravelUi5\Core\Exceptions\InvalidPathException; |
| 8: | |
| 9: | /** |
| 10: | * Contract for validating input parameters for UI5 artifacts. |
| 11: | * |
| 12: | * This interface defines a service responsible for validating and normalizing |
| 13: | * the input parameters passed to a report (e.g., from the selection screen or a URL). |
| 14: | * |
| 15: | * Implementations must: |
| 16: | * - enforce declared Parameter attributes |
| 17: | * - normalize missing or default values |
| 18: | * - throw validation exceptions on error |
| 19: | * |
| 20: | * @see Parameter |
| 21: | */ |
| 22: | interface ParameterResolverInterface |
| 23: | { |
| 24: | /** |
| 25: | * Resolve and validate all path parameters for a handler. |
| 26: | * |
| 27: | * This method reflects the handler's invocation contract by: |
| 28: | * - reading all #[Parameter] attributes declared on the handler class, |
| 29: | * - validating the request path against the declared parameter count, |
| 30: | * - resolving and casting each path segment, |
| 31: | * - and returning the fully resolved arguments keyed by parameter name. |
| 32: | * |
| 33: | * @param object $target |
| 34: | * The handler instance whose parameters should be resolved. |
| 35: | * |
| 36: | * @return array<string, mixed> |
| 37: | * A map of resolved argument values keyed by handler parameter name. |
| 38: | * |
| 39: | * @throws InvalidPathException |
| 40: | * If the number or structure of path segments does not match the |
| 41: | * declared parameter contract. |
| 42: | * @throws InvalidParameterException |
| 43: | * If a path segment cannot be resolved or cast according to its |
| 44: | * parameter definition. |
| 45: | */ |
| 46: | public function resolve(object $target): array; |
| 47: | } |
| 48: |