koriym/csv-entities

A PDO mapping library that simplifies fetching and handling of one-to-many relationships

1.0.2 2024-06-07 00:57 UTC

Requires

• php: ^8.1

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.8
• phpunit/phpunit: ^9.6.19

MIT

• Akihito Koriyama

README

Efficiently manage one-to-many relationships in PDO with Koriym.CsvEntities. This library simplifies the process of fetching related tables by transforming the results into easily manageable PHP entities. Ideal for scenarios where a primary entity has multiple related sub-entities, it streamlines data handling and reduces the complexity of your code.

Japanese

PDO - Fetching one to many related tables together

Create a one-to-many entity list with Todo having multiple Memos in PDO as shown below.

Example

SELECT todo.id AS id,
       todo.title AS title,
       memo.id AS memo_id,
       memo.body AS memo_body
FROM todo
       LEFT OUTER JOIN memo
       ON memo.todo_id = todo.id
GROUP BY todo.id;

Memo class

final class Memo
{
    public string $id,
    public string $title
}

Todo class

final class Todo
{
    public string $id,
    public string $title,
    /** @var array<Memo> */
    public array $memos,
}

Usage

Change the above SQL and entity classes as follows.

SELECT todo.id AS id,
       todo.title AS title,
       GROUP_CONCAT(memo.id),
       GROUP_CONCAT(memo.body)
FROM todo
       LEFT OUTER JOIN memo
       ON memo.todo_id = todo.id
GROUP BY todo.id;

final class Memo
{
    public function __construct(
        public string $id,
        public string $title
    ){}
}

final class Todo
{
    /** @var array<Memo> */
    public array $memos;

    public function __construct(
        public string $id,
        public string $title,
        string|null $memoIds,
        string|null $memoBodies
    ){
        $this->memos = (new CsvEntities())(Memo::class, $memoIds, $memoBodies);
    }
}

After query() SQL, fetchAll as follows.

$todoList = $pdo->fetchAll(PDO::FETCH_FUNC, static function (...$args) {
    return new Todo(...$args);
});

We get the Todo[] array we originally intended.

final class Todo
{
    public string $id,
    public string $title,
    /** @var array<Memo> */
    public array $memos,
}

Separator can be specified。

$this->memos = (new CsvEntities())->get("\t", Memo::class, $memoIds, $memoBodies); // tab separator

Set maximum concatenation value for GROUP_CONCAT

The maximum value of the concatenation process of columns using GROUP_CONCAT must be changed to group_concat_max_len in an ini file or query. (default value is 1024)

SET SESSION group_concat_max_len = 200000;

Install

composer require koriym/csv-entities