-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[Validator] deprecate handling options in the base Constraint class #60801
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
Open
xabbuh
wants to merge
1
commit into
symfony:7.4
Choose a base branch
from
xabbuh:issue-60029
base: 7.4
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+655
−179
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,3 +22,121 @@ HttpClient | |
---------- | ||
|
||
* Deprecate using amphp/http-client < 5 | ||
|
||
Validator | ||
--------- | ||
|
||
* Deprecate evaluating options in the base `Constraint` class. Initialize properties in the constructor of the concrete constraint | ||
class instead. | ||
|
||
Before: | ||
|
||
```php | ||
class CustomConstraint extends Constraint | ||
{ | ||
public $option1; | ||
public $option2; | ||
|
||
public function __construct(?array $options = null) | ||
{ | ||
parent::__construct($options); | ||
} | ||
} | ||
``` | ||
|
||
After: | ||
|
||
```php | ||
class CustomConstraint extends Constraint | ||
{ | ||
public $option1; | ||
public $option2; | ||
|
||
public function __construct($option1 = null, $option2 = null) | ||
{ | ||
parent::__construct(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I suggest showing passing the groups to the parent in the After code (as the Before code passing the array of options supports |
||
|
||
$this->option1 = $option1; | ||
$this->option2 = $option2; | ||
} | ||
} | ||
``` | ||
|
||
* Deprecate the `getRequiredOptions()` method of the base `Constraint` class. Use mandatory constructor arguments instead. | ||
|
||
Before: | ||
|
||
```php | ||
class CustomConstraint extends Constraint | ||
{ | ||
public $option1; | ||
public $option2; | ||
|
||
public function __construct(?array $options = null) | ||
{ | ||
parent::__construct($options); | ||
} | ||
|
||
public function getRequiredOptions() | ||
{ | ||
return ['option1']; | ||
} | ||
} | ||
``` | ||
|
||
After: | ||
|
||
```php | ||
class CustomConstraint extends Constraint | ||
{ | ||
public $option1; | ||
public $option2; | ||
|
||
public function __construct($option1, $option2 = null) | ||
{ | ||
parent::__construct(); | ||
|
||
$this->option1 = $option1; | ||
$this->option2 = $option2; | ||
} | ||
} | ||
``` | ||
* Deprecate the `normalizeOptions()` and `getDefaultOption()` methods of the base `Constraint` class without replacements. | ||
Overriding them in child constraint will not have any effects starting with Symfony 8.0. | ||
* Deprecate passing an array of options to the `Composite` constraint class. Initialize the properties referenced with `getNestedConstraints()` | ||
in child classes before calling the constructor of `Composite`. | ||
|
||
Before: | ||
|
||
```php | ||
class CustomCompositeConstraint extends Composite | ||
{ | ||
public array $constraints = []; | ||
|
||
public function __construct(?array $options = null) | ||
{ | ||
parent::__construct($options); | ||
} | ||
|
||
protected function getCompositeOption(): string | ||
{ | ||
return 'constraints'; | ||
} | ||
} | ||
``` | ||
|
||
After: | ||
|
||
```php | ||
class CustomCompositeConstraint extends Composite | ||
{ | ||
public array $constraints = []; | ||
|
||
public function __construct(array $constraints) | ||
{ | ||
$this->constraints = $constraints; | ||
|
||
parent::__construct(); | ||
} | ||
} | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this missing the
HasNamedArgument
attribute that is required to make the constraint compatible with XML and Yaml file loaders (for attributes, it depends on how the constructor is used so the component attribute is not necessary, but it does not hurt and the changelog should support both cases)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this also applies to the component changelog of course.