File: UPGRADE-6.0.md

package info (click to toggle)
php-json-schema 6.5.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,248 kB
  • sloc: php: 9,635; makefile: 153; python: 28; sh: 13
file content (45 lines) | stat: -rw-r--r-- 1,600 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
UPGRADE FROM 5.3 to 6.0
=======================

## Introduction

We are excited to release version 6.0 of our open-source package, featuring major improvements and important updates. This release includes several breaking changes from version 5.3 aimed at enhancing performance, security, and flexibility.

Please review the following breaking changes carefully and update your implementations to ensure compatibility with version 6.0. This guide provides key modifications and instructions for a smooth transition.

Thank you for your support and contributions to the project.

## Errors
* `constraint` key is no longer the constraint name but contains more information in order to translate violations.

    *Before*
    ```php
    foreach ($validator->getErrors() as $error) {
        echo $error['constraint']; // required
    }
    ```

    *After*
    ```php
    foreach ($validator->getErrors() as $error) {
        echo $error['constraint']['name']; // required
    }
    ```

## BaseConstraint::addError signature changed

* The signature for the `BaseConstraint::AddError` method has changed.

  The `$message` parameter has been removed and replaced by the `ConstraintError` parameter. 
  The `ConstraintError` object encapsulates the error message along with additional information about the constraint violation.

    *Before*
    ```php
    public function addError(?JsonPointer $path, $message, $constraint = '', ?array $more = null)
    ```

    *After*
    ```php
    public function addError(ConstraintError $constraint, ?JsonPointer $path = null, array $more = []): void
    ```