[OptionsResolver] Fixed typos

webmozart · webmozart · commit 95454f5f6b7a · 2012-05-14T19:35:07.000+02:00
diff --git a/src/Symfony/Component/OptionsResolver/OptionsResolver.php b/src/Symfony/Component/OptionsResolver/OptionsResolver.php
@@ -57,12 +57,12 @@ public function __construct()
     /**
      * 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 @@ public function setDefaults(array $defaultValues)
      * 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 @@ public function resolve(array $options)
      * 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
@@ -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
@@ -16,7 +16,10 @@
 
 class OptionsResolverTest extends \PHPUnit_Framework_TestCase
 {
-    private $options;
+    /**
+     * @var OptionsResolver
+     */
+    private $resolver;
 
     protected function setUp()
     {

Original file line number	Diff line number	Diff line change
`@@ -57,12 +57,12 @@ public function __construct()`
`57`	`57`	`/**`
`58`	`58`	`* Sets default option values.`
`59`	`59`	`*`
`60`		`- * @param array $options A list of option names as keys and default values`
`61`		`- * as values. The option values may be closures`
`62`		`- * of the following signatures:`
	`60`	`+ * @param array $defaultValues A list of option names as keys and default values`
	`61`	`+ * as values. The option values may be closures`
	`62`	`+ * of the following signatures:`
`63`	`63`	`*`
`64`		`- * - function (Options $options)`
`65`		`- * - function (Options $options, $previousValue)`
	`64`	`+ * - function (Options $options)`
	`65`	`+ * - function (Options $options, $previousValue)`
`66`	`66`	`*/`
`67`	`67`	`public function setDefaults(array $defaultValues)`
`68`	`68`	`{`
`@@ -80,11 +80,11 @@ public function setDefaults(array $defaultValues)`
`80`	`80`	`* performance if the previous default value is calculated by an expensive`
`81`	`81`	`* closure.`
`82`	`82`	`*`
`83`		`- * @param array $options A list of option names as keys and default values`
`84`		`- * as values. The option values may be closures`
`85`		`- * of the following signature:`
	`83`	`+ * @param array $defaultValues A list of option names as keys and default values`
	`84`	`+ * as values. The option values may be closures`
	`85`	`+ * of the following signature:`
`86`	`86`	`*`
`87`		`- * - function (Options $options)`
	`87`	`+ * - function (Options $options)`
`88`	`88`	`*/`
`89`	`89`	`public function replaceDefaults(array $defaultValues)`
`90`	`90`	`{`
`@@ -214,10 +214,11 @@ public function resolve(array $options)`
`214`	`214`	`* Validates that the given option names exist and throws an exception`
`215`	`215`	`* otherwise.`
`216`	`216`	`*`
`217`		`- * @param array $optionNames A list of option names.`
	`217`	`+ * @param array $optionNames A list of option names.`
`218`	`218`	`*`
`219`		`- * @throws InvalidOptionsException If any of the options has not been`
`220`		`- * defined.`
	`219`	`+ * @throws InvalidOptionsException If any of the options has not been`
	`220`	`+ * defined.`
	`221`	`+ * @throws MissingOptionsException If a required option is missing.`
`221`	`222`	`*/`
`222`	`223`	`private function validateOptionNames(array $optionNames)`
`223`	`224`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ possible, and may only be one of "male" and "female".`
`22`	`22`	`public function __construct(array $options = array())`
`23`	`23`	`{`
`24`	`24`	`$resolver = new OptionsResolver();`
`25`		`- $this->configureOptions($resolver);`
	`25`	`+ $this->configure($resolver);`
`26`	`26`
`27`	`27`	`$this->options = $resolver->resolve($options);`
`28`	`28`	`}`
`@@ -53,7 +53,7 @@ possible, and may only be one of "male" and "female".`
`53`	`53`
`54`	`54`	`We can now easily instantiate a Person object:`
`55`	`55`
`56`		`- // 'gender' is implicitely set to 'female'`
	`56`	`+ // 'gender' is implicitly set to 'female'`
`57`	`57`	`$person = new Person(array(`
`58`	`58`	`'firstName' => 'Jane',`
`59`	`59`	`'lastName' => 'Doe',`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,10 @@`
`16`	`16`
`17`	`17`	`class OptionsResolverTest extends \PHPUnit_Framework_TestCase`
`18`	`18`	`{`
`19`		`- private $options;`
	`19`	`+ /**`
	`20`	`+ * @var OptionsResolver`
	`21`	`+ */`
	`22`	`+ private $resolver;`
`20`	`23`
`21`	`24`	`protected function setUp()`
`22`	`25`	`{`