phpsoftbox/resource

Resource component for the PhpSoftBox framework

dev-master 2026-02-06 10:49 UTC

Requires

• php: ^8.4

Requires (Dev)

• phpsoftbox/pagination: dev-master
• phpunit/phpunit: ^11.2

MIT

• Anton K.

README

Компонент для сериализации данных API через ресурсы и единый envelope.

Установка

composer require phpsoftbox/resource

Быстрый старт

<?php

use PhpSoftBox\Resource\ApiResponse;
use PhpSoftBox\Resource\Resource;

final class UserResource extends Resource
{
    public function toArray(): array
    {
        return [
            'id' => $this->resource['id'],
            'email' => $this->resource['email'],
        ];
    }
}

$user = ['id' => 10, 'email' => '[e-mail]'];

$response = ApiResponse::success(new UserResource($user));

return $response->toArray();

Документация

• docs/01-usage.md — envelope и ApiResponse
• docs/02-resources.md — Resource и ResourceCollection
• docs/03-errors.md — формат ошибок и ErrorBag
• docs/04-conditional.md — условные атрибуты