[OptionsResolver] Fixed exceptions thrown by the Options class

webmozart · webmozart · commit cf3ccc3d9047 · 2014-10-15T10:41:49.000+02:00
diff --git a/src/Symfony/Component/OptionsResolver/CHANGELOG.md b/src/Symfony/Component/OptionsResolver/CHANGELOG.md
@@ -28,3 +28,8 @@ CHANGELOG
    lazy option/normalizer closures resulted in exceptions
  * [BC BREAK] removed Options::all() since using within lazy option/normalizer
    closures resulted in exceptions
+ * [BC BREAK] OptionDefinitionException now extends LogicException instead of
+   RuntimeException
+ * [BC BREAK] the modifying methods in Options (set(), setNormalizer(), ...) now
+   throw an AccessException if they may not be accessed anymore because resolving
+   has started. Previously, they threw an OptionDefinitionException
diff --git a/src/Symfony/Component/OptionsResolver/Exception/AccessException.php b/src/Symfony/Component/OptionsResolver/Exception/AccessException.php
@@ -12,10 +12,11 @@
 namespace Symfony\Component\OptionsResolver\Exception;
 
 /**
- * Thrown when trying to read an option outside of {@link Options::resolve()}.
+ * Thrown when trying to read an option outside of or write it inside of
+ * {@link Options::resolve()}.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  */
-class ReadException extends \RuntimeException implements ExceptionInterface
+class AccessException extends \LogicException implements ExceptionInterface
 {
 }
diff --git a/src/Symfony/Component/OptionsResolver/Exception/InvalidOptionsException.php b/src/Symfony/Component/OptionsResolver/Exception/InvalidOptionsException.php
@@ -12,10 +12,12 @@
 namespace Symfony\Component\OptionsResolver\Exception;
 
 /**
- * Exception thrown when an invalid option is passed.
+ * Thrown when the value of an option does not match its validation rules.
+ *
+ * You should make sure a valid value is passed to the option.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  */
-class InvalidOptionsException extends \InvalidArgumentException implements ExceptionInterface
+class InvalidOptionsException extends InvalidArgumentException
 {
 }
diff --git a/src/Symfony/Component/OptionsResolver/Exception/MissingOptionsException.php b/src/Symfony/Component/OptionsResolver/Exception/MissingOptionsException.php
@@ -14,8 +14,10 @@
 /**
  * Exception thrown when a required option is missing.
  *
+ * Add the option to the passed options array.
+ *
  * @author Bernhard Schussek <bschussek@gmail.com>
  */
-class MissingOptionsException extends \InvalidArgumentException implements ExceptionInterface
+class MissingOptionsException extends InvalidArgumentException
 {
 }
diff --git a/src/Symfony/Component/OptionsResolver/Exception/OptionDefinitionException.php b/src/Symfony/Component/OptionsResolver/Exception/OptionDefinitionException.php
@@ -12,10 +12,10 @@
 namespace Symfony\Component\OptionsResolver\Exception;
 
 /**
- * Thrown when an option definition is invalid.
+ * Thrown when two lazy options have a cyclic dependency.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  */
-class OptionDefinitionException extends \RuntimeException implements ExceptionInterface
+class OptionDefinitionException extends \LogicException implements ExceptionInterface
 {
 }
diff --git a/src/Symfony/Component/OptionsResolver/Exception/UndefinedOptionsException.php b/src/Symfony/Component/OptionsResolver/Exception/UndefinedOptionsException.php
@@ -0,0 +1,24 @@
+<?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\Exception;
+
+/**
+ * Exception thrown when an undefined option is passed.
+ *
+ * You should remove the options in question from your code or define them
+ * beforehand.
+ *
+ * @author Bernhard Schussek <bschussek@gmail.com>
+ */
+class UndefinedOptionsException extends InvalidArgumentException
+{
+}
diff --git a/src/Symfony/Component/OptionsResolver/Options.php b/src/Symfony/Component/OptionsResolver/Options.php
