Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rewrite documentation #38

Open
xepozz opened this issue Apr 13, 2024 · 4 comments
Open

Rewrite documentation #38

xepozz opened this issue Apr 13, 2024 · 4 comments
Labels
type:docs Documentation

Comments

@xepozz
Copy link
Member

xepozz commented Apr 13, 2024

No description provided.

@xepozz xepozz added the type:docs Documentation label Apr 13, 2024
@vjik
Copy link
Member

vjik commented Apr 13, 2024

What exactly? More info, please

@xepozz
Copy link
Member Author

xepozz commented Apr 13, 2024

Just make it from the bottom

@gfsx0259
Copy link

gfsx0259 commented Apr 26, 2024

Парни, привет! Обновляюсь с RequestModel решения. По поводу документации, вот здесь у меня вопросик есть по поводу использования валидации вместе с заполнением свойств через конструктор.

#[FromBody]
final class UpdatePostInput extends AbstractInput
{
    public function __construct(
        #[Required]
        public int $id;
     )  {
     }
}

https://github.com/yiisoft/input-http/blob/master/docs/guide/en/request-input.md#combining-with-validation

Например, у меня есть модель:

#[FromBody]
final class LogRequestForm extends AbstractInput
{
    public function __construct(
        #[Required]
        private readonly string $message,
        private readonly array $payload,
    ) {
    }

    public function getMessage(): string
    {
        return $this->message;
    }

    public function getPayload(): array
    {
        return $this->payload;
    }
}

Допустим, параметр $message обязательный, а $payload опциональный. Предположим, я отправляю следующий запрос:

{
  "payload": {
    "for": "bar"
  }
}

Ожидаемый результат: возможность получить результат валидации в клиентском коде, либо исключение.
Актуальный результат: гидратор не может создать объект из-за разного числа доступных и обязательных аргументов:

{
  "type": "Yiisoft\\Hydrator\\Exception\\WrongConstructorArgumentsCountException",
  "message": "Class \"App\\Render\\Form\\LogRequestForm\" cannot be instantiated because it has 2 required parameters in constructor, but passed only 1.",
  "code": 0,
  "file": "/app/vendor/yiisoft/hydrator/src/ObjectFactory/ReflectionObjectFactory.php",
  "line": 42,
  "trace": [
    {
      "file": "/app/vendor/yiisoft/hydrator/src/Hydrator.php",
      "line": 107,
      "function": "create",
      "class": "Yiisoft\\Hydrator\\ObjectFactory\\ReflectionObjectFactory",
      "type": "->",
      "args": [
        {
          "name": "App\\Render\\Form\\LogRequestForm"
        },
        {
          "payload": {
            "for": "bar"
          }
        }
      ]
    },

Окей, допустим я чуть редактирую правило и ставлю в конструкторе значение по-умолчанию:

private readonly array $payload = [],

Отправляю тот же запрос.
Ожидаемый результат: возможность получить результат валидации в клиентском коде, либо исключение.
Актуальный результат: теперь количество аргументов сходится, но гидратор не может создать обьект, так как параметр $message обязательный, а его нету.

{
  "type": "ArgumentCountError",
  "message": "App\\Render\\Form\\LogRequestForm::__construct(): Argument #1 ($message) not passed",
  "code": 0,
  "file": "/app/src/Render/Form/LogRequestForm.php",
  "line": 22,
  "trace": [
    {
      "function": "__construct",
      "class": "App\\Render\\Form\\LogRequestForm",
      "type": "->",
      "args": [
        null,
        {
          "for": "bar"
        }
      ]
    }
}

Я думаю, что если нам всё равно нужно получить объект перед его валидацией и мы не можем создать его без необходимых параметров, что логично. То чтобы использовать так валидацию, как предполагается, нужно в документации в примере отметить, что все параметры должны иметь значение по-умолчанию.

@vjik
Copy link
Member

vjik commented Apr 26, 2024

Я думаю, что если нам всё равно нужно получить объект перед его валидацией и мы не можем создать его без необходимых параметров, что логично. То чтобы использовать так валидацию, как предполагается, нужно в документации в примере отметить, что все параметры должны иметь значение по-умолчанию.

Agree.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs Documentation
Projects
None yet
Development

No branches or pull requests

3 participants