Get a nested key as id while validating a nested array

[berrymore]

<?php

use Respect\Validation\Validator as v;
use Respect\Validation\Exceptions\ValidationException;

$data = [
    'user' => [
       'name' => 'this is a too long name for a user',
    ]
];

try {
    v::key('user', v::key('name', v::stringType()->length(1, 30)))->check($data);
} catch (ValidationException $e) {
    var_dump($e->getId()); // name
}

In the exception it returns name while I expect user.name. Is it possible to achieve this behavior?

[berrymore]

// ...

try {
    v::allOf(
        v::keyNested('user.name', v::stringType()->length(1, 30))
    )->check($data);
} catch (ValidationException $e) {
    var_dump($e->getId()); // user.name
}

As a workaround, I use this solution

[henriquemoody]

Hi @berrymore! Nice that you found a solution for your problem. Could you tell me what's your use case, though?

Asking because keyNested() will be deprecated in version 3.0.

[berrymore]

Hi @henriquemoody! In my projects, when a validation error happens during the request execution, I usually return a model that contains an array of violations, where a violation has path and message fields. Since there are nested structures in a request, I'd like to respond with nested paths in violations. For example:

Request

{
  "address": {
    "countryCode": "123"
  }
}

Response

{
  "violations": [
    {"path": "address.countryCode", "message": "You should specify a valid ISO-3166 country code"}
  ]
}

This way it becomes easy to handle the response on the frontend side to address the error message to the specific input control.

[henriquemoody]

Thanks for your answer!

[henriquemoody]

Thanks to your comments, I thought better about the error messages and came to the conclusion they were not so helpful when dealing with nested structure. I've been working on some changes, there are a couple of challenges to make it work, I thought I would let you know what I'm doing: #1507 (comment)

I will take a break in the next weeks, I will get back next year, and will try to get the version 3.0 out at the beginning of the year!