rkov / view-model

v1.0.0 2026-11-11 07:10 UTC

Requires

• php: ^8.1

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.40
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-strict-rules: ^1.5
• phpunit/phpunit: ^10.0

MIT

• Rochev Yakov

• json
• rest
• api
• transformer
• resource
• view-model
• rkov

Published on Packagist.org on 2026-11-11 07:12 UTC

README

Model representations for REST API. Now you can create “model representations” using dependency injection. Suitable for any frameworks (Laravel, Symfony).

Installation

composer require rkov/view-model

Usage

1. Add view models

Post Model

use Rkov\ViewModel\View;

class PostView extends View
{
    public function toArray(object $resource): array
    {
        if (! $resource instanceof Post) {
            throw new \InvalidArgumentException('Expected Post, got ' . get_class($resource));
        }

        return [
            'id' => $resource->id,
            'title' => $resource->title,
        ];
    }
}

Address Model

use Rkov\ViewModel\View;

class AddressView extends View
{
    public function toArray(object $resource): array
    {
        if (! $resource instanceof Address) {
            throw new \InvalidArgumentException('Expected Address, got ' . get_class($resource));
        }

        return [
            'city' => $resource->city,
            'street' => $resource->street,
            'home_number' => $resource->home_number,
            'flat_number' => $resource->flat_number,
        ];
    }
}

User Model

use Rkov\ViewModel\View;

class UserView extends View
{
    public function __construct(
        private PostView $postView,
        private AddressView $addressView,
    ) {}

    public function toArray(object $resource): array
    {
        if (! $resource instanceof User) {
            throw new \InvalidArgumentException('Expected User, got ' . get_class($resource));
        }

        return [
            'id' => $resource->id,
            'name' => $resource->name,
            'email' => $resource->email,
            // Posts are rendered as null when the resource has none
            'posts' => $this->postView
                ->collection($resource->posts)
                ->whenEmptyShowNull(),
            // A missing address is rendered as an empty object "{}"
            'address' => $this->addressView
                ->object($resource->address),
        ];
    }
}

1. Next, adding a controller

use Rkov\ViewModel\Responses\ViewResponse;

class GetUserController
{
    public function __construct(
        protected UserRepository $repository
    ) {}

    public function __invoke(Request $request, UserView $view): ViewResponse
    {
        $user = $this->repository->get($request->id);

        return $view->object($user);
    }
}

1. Result

{
    "id": 1,
    "name": "John Doe",
    "email": "[e-mail]",
    "posts": null,
    "address": {}
}

License

Copyright (c) Rochev Yakov. Distributed under the MIT.