diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[OptionsResolver] clarify phpdoc

Browse Source
This commit is contained in:
Tobias Schultze 2012-05-25 23:40:38 +02:00
parent 0cac4049f7
commit e673a041be
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/Symfony/Component/OptionsResolver/OptionsResolverInterface.php
View File

@ -59,10 +59,11 @@ interface OptionsResolverInterface
/**
* Sets optional options.
*
* This method is identical to {@ĺink setDefaults()}, only that no default values
* are configured for the options. If these options are not passed to
* {@link resolve()}, they will be missing in the final options array. This can be
* helpful if you want to determine whether an option has been set or not.
* This method declares valid option names without setting default values for them.
* If these options are not passed to {@link resolve()} and no default has been set
* for them, they will be missing in the final options array. This can be helpful
* if you want to determine whether an option has been set or not because otherwise
* {@link resolve()} would trigger an exception for unknown options.
*
* @param array $optionNames A list of option names.
*
@ -95,8 +96,9 @@ interface OptionsResolverInterface
*
* @return OptionsResolverInterface The resolver instance.
*
* @throws Exception\InvalidOptionsException If an option has not been defined for
* which an allowed value is set.
* @throws Exception\InvalidOptionsException If an option has not been defined
* (see {@link isKnown()}) for which
* an allowed value is set.
*/
function setAllowedValues(array $allowedValues);