定制 proklung/annotatedparamresolverbundle 二次开发

按需修改功能、优化性能、对接业务系统,提供一站式技术支持

邮箱:yvsm@zunyunkeji.com | QQ:316430983 | 微信:yvsm316

proklung/annotatedparamresolverbundle

Composer 安装命令:

composer require proklung/annotatedparamresolverbundle

包简介

Symfony bundle for transform parameters of request to DTO.

README 文档

README

За основу взят https://github.com/piku235/JungiFrameworkExtraBundle и творчески доработан под личные нужды.

Например, кроме, DTO в виде stdClass поддерживаются SpatieDTO. Кое-что выпилено за ненадобностью (куки, заголовки и тому подобное).

Установка

composer require proklung/annotatedparamresolverbundle

Аннотации:

  • RequestBody - Преобразует request body в аргумент контроллера (DTO).
  • RequestParams - Преобразует POST параметры запроса в аргумент контроллера (DTO).
  • QueryParams - Преобразует GET параметры запроса в аргумент контроллера (DTO).

Также поддерживаются аннотации PHP 8 (даже на версиях 7.2+). При использовании PHP 8 в дело пойдет нативный парсер аннотаций.

Общий принцип

RequestBodyConverted - пользовательский класс, реализующий (использующий интерфейс в качестве метки) Prokl\AnnotatedParamResolverBundle\ArgumentResolver\Contracts\UnserializableRequestInterface.

В экземпляр этого класса после всех манипуляций лягут, в зависимости от аннотации, - GET, POST параметры запроса или сконвертированный request body.

Можно использовать [https://github.com/spatie/data-transfer-object](Spatie DTO), отнаследовавшись от DataTransferObject, и реализовав интерфейс UnserializableRequestInterface.

use Prokl\AnnotatedParamResolverBundle\Annotation\RequestBody;
use Prokl\AnnotatedParamResolverBundle\Examples\RequestBodyConverted;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;

class ExampleController extends AbstractController
{
    /**
     * Параметры аннотации необязательны!
     *
     * @param RequestBodyConverted $unserialized
     *
     * @return JsonResponse $content
     * @RequestBody(
            var="unserialized",
            class="Prokl\AnnotatedParamResolverBundle\Examples\RequestBodyConverted",
            validate=true
     )
     */
    public function action(
        RequestBodyConverted $unserialized
    ): JsonResponse {
        return new JsonResponse();
    }
}

Так тоже можно (валидация по умолчанию включена):

use Prokl\AnnotatedParamResolverBundle\Annotation\RequestBody;
use Prokl\AnnotatedParamResolverBundle\Examples\RequestBodyConverted;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;

class ExampleController extends AbstractController
{
    /**
     * Параметры аннотации необязательны!
     *
     * @param RequestBodyConverted $unserialized
     *
     * @return JsonResponse $content
     * @RequestBody()
     */
    public function action(
        RequestBodyConverted $unserialized
    ): JsonResponse {
        return new JsonResponse();
    }
}

Валидация

В описании класса, реализующего UnserializableRequestInterface к свойствам класса допустимо применять любые стандартные и кастомные валидаторы Symfony.

Опция validate в аннотации управляет валидацией, вне зависимости от аннотаций свойства класса.

use Prokl\AnnotatedParamResolverBundle\ArgumentResolver\Contracts\UnserializableRequestInterface;
use Spatie\DataTransferObject\DataTransferObject;
use Symfony\Component\Validator\Constraints as Assert;

class RequestBodyConvertedSpatie extends DataTransferObject implements UnserializableRequestInterface
{
    /**
     * @var string $email
     *
     * @Assert\Length(
     *  min=3,
     *  minMessage="Email must be at least {{ limit }} characters long"
     * )
     */
    public $email;

    /**
     * @var integer
     */
    public $numeric;
}

统计信息

  • 总下载量: 71
  • 月度下载量: 0
  • 日度下载量: 0
  • 收藏数: 1
  • 点击次数: 0
  • 依赖项目数: 0
  • 推荐数: 0

GitHub 信息

  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • 开发语言: PHP

其他信息

  • 授权协议: MIT
  • 更新时间: 2021-04-20

承接程序开发

PHP开发

VUE

Vue开发

前端开发

小程序开发

公众号开发

系统定制

数据库设计

云部署

网站建设

安全加固