From 95454f5f6b7a3c929cdb6ff8c838f3f436d281ac Mon Sep 17 00:00:00 2001 From: Bernhard Schussek Date: Thu, 10 May 2012 19:26:05 +0200 Subject: [PATCH] [OptionsResolver] Fixed typos --- .../OptionsResolver/OptionsResolver.php | 25 ++++++++++--------- .../Component/OptionsResolver/README.md | 4 +-- .../Tests/OptionResolverTest.php | 5 +++- 3 files changed, 19 insertions(+), 15 deletions(-) diff --git a/src/Symfony/Component/OptionsResolver/OptionsResolver.php b/src/Symfony/Component/OptionsResolver/OptionsResolver.php index 2f4d8d2031..1f7c14a46b 100644 --- a/src/Symfony/Component/OptionsResolver/OptionsResolver.php +++ b/src/Symfony/Component/OptionsResolver/OptionsResolver.php @@ -57,12 +57,12 @@ class OptionsResolver /** * Sets default option values. * - * @param array $options A list of option names as keys and default values - * as values. The option values may be closures - * of the following signatures: + * @param array $defaultValues A list of option names as keys and default values + * as values. The option values may be closures + * of the following signatures: * - * - function (Options $options) - * - function (Options $options, $previousValue) + * - function (Options $options) + * - function (Options $options, $previousValue) */ public function setDefaults(array $defaultValues) { @@ -80,11 +80,11 @@ class OptionsResolver * performance if the previous default value is calculated by an expensive * closure. * - * @param array $options A list of option names as keys and default values - * as values. The option values may be closures - * of the following signature: + * @param array $defaultValues A list of option names as keys and default values + * as values. The option values may be closures + * of the following signature: * - * - function (Options $options) + * - function (Options $options) */ public function replaceDefaults(array $defaultValues) { @@ -214,10 +214,11 @@ class OptionsResolver * Validates that the given option names exist and throws an exception * otherwise. * - * @param array $optionNames A list of option names. + * @param array $optionNames A list of option names. * - * @throws InvalidOptionsException If any of the options has not been - * defined. + * @throws InvalidOptionsException If any of the options has not been + * defined. + * @throws MissingOptionsException If a required option is missing. */ private function validateOptionNames(array $optionNames) { diff --git a/src/Symfony/Component/OptionsResolver/README.md b/src/Symfony/Component/OptionsResolver/README.md index 5e0f08ce45..d0bfae6ef6 100644 --- a/src/Symfony/Component/OptionsResolver/README.md +++ b/src/Symfony/Component/OptionsResolver/README.md @@ -22,7 +22,7 @@ possible, and may only be one of "male" and "female". public function __construct(array $options = array()) { $resolver = new OptionsResolver(); - $this->configureOptions($resolver); + $this->configure($resolver); $this->options = $resolver->resolve($options); } @@ -53,7 +53,7 @@ possible, and may only be one of "male" and "female". We can now easily instantiate a Person object: - // 'gender' is implicitely set to 'female' + // 'gender' is implicitly set to 'female' $person = new Person(array( 'firstName' => 'Jane', 'lastName' => 'Doe', diff --git a/src/Symfony/Component/OptionsResolver/Tests/OptionResolverTest.php b/src/Symfony/Component/OptionsResolver/Tests/OptionResolverTest.php index c3acc6ceb3..84b69c1f5b 100644 --- a/src/Symfony/Component/OptionsResolver/Tests/OptionResolverTest.php +++ b/src/Symfony/Component/OptionsResolver/Tests/OptionResolverTest.php @@ -16,7 +16,10 @@ use Symfony\Component\OptionsResolver\Options; class OptionsResolverTest extends \PHPUnit_Framework_TestCase { - private $options; + /** + * @var OptionsResolver + */ + private $resolver; protected function setUp() {