Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c9b0471

Browse files
webmozartwebmozart
committed
[OptionsResolver] Merged Options and OptionsConfig and restored old OptionsResolver class
1 parent 966c586 commit c9b0471

File tree

9 files changed

+2162
-1354
lines changed

9 files changed

+2162
-1354
lines changed

‎UPGRADE-2.6.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,3 +128,67 @@ HttpFoundation
128128
- You would need to migrate the table manually if you want to keep session information of your users.
129129
- You could use `PdoSessionHandler::createTable` to initialize a correctly defined table depending on
130130
the used database vendor.
131+
132+
OptionsResolver
133+
---------------
134+
135+
* The class `OptionsResolver` and its interface `OptionsResolverInterface`
136+
were deprecated. You should use the class `Options` together with
137+
`Options::resolve()` instead.
138+
139+
In simple use cases, you don't need to instantiate a class anymore:
140+
141+
Before:
142+
143+
```php
144+
$resolver = new OptionsResolver();
145+
$resolver->setDefaults(array(
146+
'username' => 'user',
147+
'password' => 'pa$$word',
148+
'port' => 25,
149+
));
150+
$resolver->setRequired(array('host'));
151+
$resolver->setAllowedTypes(array(
152+
'port' => 'int',
153+
));
154+
155+
$options = $resolver->resolve($options);
156+
```
157+
158+
After:
159+
160+
```php
161+
Options::validateRequired($options, 'host')
162+
Options::validateTypes($options, array(
163+
'port' => 'int',
164+
));
165+
166+
$options = Options::resolve($options, array(
167+
'username' => 'user',
168+
'password' => 'pa$$word',
169+
'port' => 25,
170+
));
171+
```
172+
173+
When you want to distribute the configuration of the options and pass a
174+
configuration object around, construct a new `Options` instance. The API
175+
of that class is very similar to the `OptionsResolver`. Additionally, you
176+
can use its `ArrayAccess` interface to set default option values:
177+
178+
```php
179+
// Pass options to the constructor...
180+
$defaults = new Options(array(
181+
'username' => 'user',
182+
'password' => 'pa$$word',
183+
));
184+
185+
// ...or using array access
186+
$defaults['port'] = 25;
187+
188+
$defaults->setRequired('host');
189+
$defaults->setAllowedTypes(array(
190+
'port' => 'int',
191+
));
192+
193+
$options = Options::resolve($options, $defaults);
194+
```

‎src/Symfony/Component/OptionsResolver/CHANGELOG.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
CHANGELOG
2+
=========
3+
4+
2.6.0
5+
-----
6+
7+
* added Options::resolve()
8+
* added Options::merge()
9+
* added Options::setNormalizers()
10+
* added Options::setRequired()
11+
* added Options::isRequired()
12+
* added Options::getRequiredOptions()
13+
* added Options::isMissing()
14+
* added Options::getMissingOptions()
15+
* added Options::setDefined()
16+
* added Options::isDefined()
17+
* added Options::getDefinedOptions()
18+
* added Options::setAllowedValues()
19+
* added Options::addAllowedValues()
20+
* added Options::setAllowedTypes()
21+
* added Options::addAllowedTypes()
22+
* deprecated Options::overload() in favor of set()
23+
* deprecated OptionsResolver
24+
* deprecated OptionsResolverInterface
25+
* [BC BREAK] Options::get() can only be used within lazy option/normalizer
26+
closures now
27+
* [BC BREAK] removed Traversable interface from Options since using within
28+
lazy option/normalizer closures resulted in exceptions
29+
* [BC BREAK] removed Options::all() since using within lazy option/normalizer
30+
closures resulted in exceptions

‎src/Symfony/Component/OptionsResolver/Exception/ReadException.php

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\OptionsResolver\Exception;
13+
14+
/**
15+
* Thrown when trying to read an option outside of {@link Options::resolve()}.
16+
*
17+
* @author Bernhard Schussek <[email protected]>
18+
*/
19+
class ReadException extends \RuntimeException implements ExceptionInterface
20+
{
21+
}

0 commit comments

Comments
 (0)