-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[POC] [OptionsResolver] Support nested options #11509
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
Closed
Closed
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
26 changes: 26 additions & 0 deletions
26
src/Symfony/Component/OptionsResolver/NestableOptionsResolverInterface.php
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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\OptionsResolver; | ||
|
||
/** | ||
* @author Wouter J <wouter@wouterj.nl> | ||
*/ | ||
interface NestableOptionsResolverInterface extends OptionsResolverInterface | ||
{ | ||
/** | ||
* Sets nested options resolvers. | ||
* | ||
* @param array $options A list of option names as keys and instances of | ||
* OptionsResolverInterface as values. | ||
*/ | ||
public function setNestedOptionsResolver(array $options); | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -717,4 +717,54 @@ public function testClone() | |
'three' => '3', | ||
), $clone->resolve()); | ||
} | ||
|
||
public function testNestedResolversForRequiredOption() | ||
{ | ||
$this->resolver->setRequired(array('db')); | ||
$this->resolver->setNestedOptionsResolver(array( | ||
'db' => $this->getNestedResolver(), | ||
)); | ||
|
||
$this->assertEquals(array( | ||
'db' => array( | ||
'dsn' => 'sqlite:app.sqlite', | ||
'user' => 'root', | ||
'password' => '', | ||
'port' => 3306, | ||
), | ||
), $this->resolver->resolve(array( | ||
'db' => array( | ||
'dsn' => 'sqlite:app.sqlite', | ||
), | ||
))); | ||
} | ||
|
||
/** | ||
* @expectedException Symfony\Component\OptionsResolver\Exception\MissingOptionsException | ||
* | ||
* Nested options resolvers will always be executed, eventhough the option | ||
* is missing. See {@link https://github.com/symfony/symfony/issues/9174} | ||
*/ | ||
public function testNestedResolversForOptionalOption() | ||
{ | ||
$this->resolver->setOptional(array('db')); | ||
$this->resolver->setNestedOptionsResolver(array( | ||
'db' => $this->getNestedResolver(), | ||
)); | ||
|
||
$this->assertEquals(array(), $this->resolver->resolve(array())); | ||
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. The assert is actually not needed as your expecting an exception. |
||
} | ||
|
||
private function getNestedResolver() | ||
{ | ||
$nestedResolver = new OptionsResolver(); | ||
$nestedResolver->setDefaults(array( | ||
'user' => 'root', | ||
'password' => '', | ||
'port' => 3306, | ||
)); | ||
$nestedResolver->setRequired(array('dsn')); | ||
|
||
return $nestedResolver; | ||
} | ||
} |
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.
missing return doc. also this method is only for internal purposes. and manually calling it can result in php error (when option is not set in optionResolvers).
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.
So I should tag it with
@internal
?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.
Yes, mark it with
@internal
.