PHP code example of vitek-dev / nette-api-controller

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

vitek-dev / nette-api-controller example snippets

declare(strict_types=1);

final readonly class HelloController extends \VitekDev\Nette\Application\ApiController
{
    public function __construct(
        private UsersService $usersService,
    ) {
    }
    
    // Controller actions are in httpmethodActionName format

    /**
     * @return UserDto[]
     */
    public function getIndex(): array // List of users
    {
        return $this->usersService->listUsers(); // Automatically translates to JSON
    }
    
    public function postIndex(CreateUser $dto): UserDto // Create new user; automatically maps payload to object
    {
        return $this->usersService->createUser($dto);
    }
    
    public function postSayHello(string $id): string // Say hello to user; automatically maps route parameter to action parameter
    {
        $user = $this->usersService->get($id);
        if (!$user) {
            throw new ResourceNotFound('User not found'); // Automatically returns HTTP 404 Not Found
        }
    
        return sprintf('Hello %s', $user->name); // Automatically sends text response 'Hello John'
    }
}

class SayHelloDto implements \VitekDev\Nette\Application\Request\RequestBody
{
    public string $name;
    
    public static function map(array $json): self
    {
        $dto = new self();
        $dto->name = $json['name'] ?? throw new InvalidArgumentException('Missing name');
        return $dto;
    }
}

public function postHello(SayHelloDto $request): void
{
    // do what you have to do
}

class SayHelloDto extends \VitekDev\Nette\Application\Request\AutoMappedRequestBody
{
    public string $name;
    
    public int $age;
    
    public static function getCustomRules(): array
    {
        return [
            'age' => \Nette\Schema\Expect::int()->min(0)->max(90),
        ];
    }
}

public function getCustomResponse(): \Nette\Application\Response
{
    return new Nette\Application\Responses\VoidResponse(); // you can manually send any compatible Response
}

public function getText(): string
{
    return 'hello world'; // will send HTTP 200 response with 'hello world' text
}

public function getJson(): array
{
    return ['foo' => 'bar']; // will send HTTP 200 response with '{"foo":"bar"}' JSON
}

public function getDto(): SayHelloDto
{
    $dto = new SayHelloDto();
    $dto->name = 'John';
    return $dto; // will send HTTP 200 response with '{"name":"John"}' JSON
}

public function getJustNothing(): void
{
    // will send HTTP 204 No Content
}