theunic/symfony-response-helpers

A set of helpers intended to ease the instantiation of symfony responses

v0.2.0 2024-02-04 17:19 UTC

Requires

• php: >=8.1
• symfony/filesystem: ^6.0 | ^7.0
• symfony/http-foundation: ^6.0 | ^7.0

Requires (Dev)

• azjezz/psl: ^2.0
• lstrojny/functional-php: ^1.17
• phpunit/phpunit: ^10.0
• symfony/console: ^6.0 | ^7.0
• symfony/string: ^6.0 | ^7.0
• symplify/easy-coding-standard: ^12.1
• twig/twig: ^3.0
• vimeo/psalm: ^5.6

MIT

• theUniC

• symfony
• http
• response
• helper

README

A small utility to ease the instantiation of Response objects

Installation

composer req theunic/symfony-response-helpers

Usage

Use it in your Symfony controllers

<?php

declare(strict_types=1);

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response; 
use Symfony\Component\Routing\Annotation\Route;

final class HomePageController extends AbstractController
{
    #[Route("/")]
    public function __invoke(): Response
    {
        return Response\ok("<h1>Hello World!</h1>");
    }
}

Or to generate json responses

<?php

declare(strict_types=1);

namespace App\Controller\Api;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use App\Repository\UsersRepository;
use Symfony\Component\Validator\Validator\ValidatorInterface;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Routing\Annotation\Route;

final class UsersController extends AbstractController
{
    public function __construct(
        private readonly UsersRepository $usersRepository,
        private readonly ValidatorInterface $validator,
    ) {
    }
    
    #[Route("/api/users/{id}", methods: ["PUT"])]
    public function __invoke(int $id, Request $req): JsonResponse
    {
        $user = $this->usersRepository->find($id);
        
        if (!$user) {
            return JsonResponse\notFound(["error" => sprintf("User with id %d was not found", $id)]);
        }
        
        $data = json_decode($req->getContent(), associative: true, falgs: JSON_THROW_ON_ERROR);
        $constraint = new Assert\Collection([
            'username' => new Assert\NotEmpty(),
            'email' => [new Assert\NotEmpty(), new Assert\Email()]
        ]);
        
        $errors = $this->validator->validate($data, $contraint);
        
        if (count($errors) > 0) {
            return JsonResponse\badRequest(
                array_reduce(
                    $errors,
                    static function (array $errors, ContraintViolation $cv): array {
                        $errors[$cv->getPropertyPath()] = $error->getMessage();
                        return $errors;
                    },
                    []
                )
            );
        }
        
        return JsonResponse\ok([
            "id" => $id,
            "username" => $user->getUsername(),
            "email" => $user->getEmail()
        ]);
    }
}