bearsunday / BEAR.Resource

src/DataLoader/DataLoaderInterface.php

<?php

declare(strict_types=1);

namespace BEAR\Resource\DataLoader;

use BEAR\Resource\Types;

/**
 * Interface for data loaders that batch multiple resource requests
 *
 * Implementations receive query parameters and return database rows.
 * The framework handles URI parsing and result distribution.
 *
 * $queries is passed as an array of associative arrays (not just values)
 * to support multiple key parameters:
 *
 * Single key: app://self/meta{?post_id}
 * ```php
 * $postIds = array_column($queries, 'post_id');
 * ```
 *
 * Multiple keys: app://self/translation?post_id={post_id}&locale={locale}
 * ```php
 * foreach ($queries as $q) {
 *     // Use both $q['post_id'] and $q['locale']
 * }
 * ```
 *
 * @psalm-import-type DataLoaderQueries from Types
 * @psalm-import-type DataLoaderRows from Types
 */
interface DataLoaderInterface
{
    /**
     * @param DataLoaderQueries $queries Query parameters extracted from URIs

The type BEAR\Resource\DataLoader\DataLoaderQueries was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return DataLoaderRows Rows that contain the query key columns for matching

The type BEAR\Resource\DataLoader\DataLoaderRows was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function __invoke(array $queries): array;
}