Error message

[pedrohcdo]

Sorry for opening another error, but I'll close, is there any way to set a custom error message for the parameter? Because I wanted to send the message to the user, for example:

{
"type": "string",
"error_msg": "Invalid name !!"
}

And somehow if you do not validate give to get in php and send the message to the user.

[sorinsarca]

Well, json-schema spec doesn't have something about errors, so there isn't a standard way of handling errors.

Your solution/porposal (having the error message in the schema) works only in a few cases and is very ambiguous.

Meanwhile, you can play with the ValidationError and try to format the message.

[sorinsarca]

@pedrohcdo here is an (incomplete) example of error formatter class which uses the standard title keyword.

class ErrorFormatter {
    protected $map = [
        'type' => '{title} should be a {expected}',
        'minLength' => '{title} length must be at least {min}',
        'maxLength' => '{title} length must be at most {max}',
        // TODO: other keywords...
    ];

    public function format(\Opis\JsonSchema\ValidationError $error): string
    {
        $kw = $error->keyword();
        if (!isset($this->map[$kw])) {
            return 'Unexpected error on keyword: ' . $kw;
        }

        $kw = $this->map[$kw];

        if (is_callable($kw)) {
            return $kw($error, $this);
        }

        $args = $error->keywordArgs() + ['title' => $this->fieldName($error)];

        return $this->replace($kw, $args);
    }

    public function fieldName(\Opis\JsonSchema\ValidationError $error, bool $name = true): ?string
    {
        $schema = $error->schema();

        if (is_object($schema) && isset($schema->title) && is_string($schema->title)) {
            return $schema->title;
        }

        if (!$name) {
            return null;
        }

        $title = $error->dataPointer();
        $title = array_pop($title);

        return (string) $title;
    }

    public function replace(string $str, array $args): string
    {
        return preg_replace_callback('~\{([^}]+)\}~', function ($m) use ($args) {
            return isset($args[$m[1]]) ? $args[$m[1]] : $m[0];
        }, $str);
    }
}

You can use it like so

$validator = new \Opis\JsonSchema\Validator();

// Validating an object using schema as string
$schema = <<<'JSON'
{
    "type": "object",
    "properties": {
        "name": {
            "title": "Username",       
            "type": "string",
            "minLength": 3
        }
    }
}
JSON;

$formatter = new ErrorFormatter();

$result = $validator->dataValidation((object)["name" => 123], $schema);

echo $formatter->format($result->getFirstError()), PHP_EOL; 
//> Username should be a string

$result = $validator->dataValidation((object)["name" => "a"], $schema);

echo $formatter->format($result->getFirstError()), PHP_EOL; 
//> Username length must be at least 3

[pedrohcdo]

Many thanks for the help, I'm having a problem where the minimum size does not work, eg:
{
...
"password": {
"type": "string",
"minLength": 10,
"maxLength": 64
}
}

When the object is valid:

{
..
"password": "test"
..
}

Not the error .. Only maxLength works

[sorinsarca]

In my example I used only the first error, you should iterate over all errors

$result = $validator->dataValidation((object)["password" => "test"], $schema);

if ($result->hasErrors()) {
  $formatter = new ErrorFormatter();
  $errors = [];
  foreach ($result->getErrors() as $err) {
     $errors[] = $formatter->format($err);
  }
  print_r($errors);
} else {
  echo "No errors", PHP_EOL;
}

[pedrohcdo]

Yes, but even iterating the 'minLength' does not catch.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "schema:/register_user.json#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLenght": 10,
"maxLength": 20
}
}
}

And json to validate:

{
"name": "test"
}

[sorinsarca]

There is a typo in your schema

"minLenght": 10

it should be

"minLength": 10

[pedrohcdo]

All doubts were taken, the lib is very good.