Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[Form] Fixed some PHPDoc

  • Loading branch information...
commit 602e391d6c20145a0bb64484ae78a030fa31af86 1 parent 970fd29
@pborreli pborreli authored Tobion committed
View
2  AbstractRendererEngine.php
@@ -22,7 +22,7 @@
* The variable in {@link FormView} used as cache key.
*/
const CACHE_KEY_VAR = 'cache_key';
-
+
/**
* @var array
*/
View
4 Extension/Core/DataTransformer/ChoiceToBooleanArrayTransformer.php
@@ -77,7 +77,9 @@ public function transform($choice)
*
* @return mixed A scalar value
*
- * @throws new UnexpectedTypeException if the given value is not an array
+ * @throws UnexpectedTypeException if the given value is not an array
+ * @throws TransformationFailedException if the recuperation of the choices fails or
+ * if some choice can't be found
*/
public function reverseTransform($values)
{
View
6 Extension/Core/DataTransformer/ChoicesToBooleanArrayTransformer.php
@@ -40,7 +40,7 @@ public function __construct(ChoiceListInterface $choiceList)
*
* @return mixed An array
*
- * @throws UnexpectedTypeException if the given value is not an array
+ * @throws UnexpectedTypeException if the given value is not an array
* @throws TransformationFailedException if the choices can not be retrieved
*/
public function transform($array)
@@ -79,7 +79,9 @@ public function transform($array)
*
* @return mixed An array
*
- * @throws UnexpectedTypeException if the given value is not an array
+ * @throws UnexpectedTypeException if the given value is not an array
+ * @throws TransformationFailedException if the recuperation of the choices fails or
+ * if some choice can't be found
*/
public function reverseTransform($values)
{
View
3  Extension/Core/DataTransformer/ChoicesToValuesTransformer.php
@@ -59,7 +59,8 @@ public function transform($array)
*
* @return array
*
- * @throws UnexpectedTypeException if the given value is not an array
+ * @throws UnexpectedTypeException if the given value is not an array
+ * @throws TransformationFailedException if could not find all matching choices for the given values
*/
public function reverseTransform($array)
{
View
2  Extension/Core/DataTransformer/PercentToLocalizedStringTransformer.php
@@ -42,6 +42,8 @@ class PercentToLocalizedStringTransformer implements DataTransformerInterface
*
* @param integer $precision The precision
* @param string $type One of the supported types
+ *
+ * @throws UnexpectedTypeException if the given value of type is unknown
*/
public function __construct($precision = null, $type = null)
{
View
2  Form.php
@@ -143,6 +143,8 @@ class Form implements \IteratorAggregate, FormInterface
* Creates a new form based on the given configuration.
*
* @param FormConfigInterface $config The form configuration.
+ *
+ * @throws FormException if a data mapper is not provided for a compound form
*/
public function __construct(FormConfigInterface $config)
{
View
12 FormConfigBuilder.php
@@ -244,6 +244,8 @@ public function resetViewTransformers()
*
* @return FormConfigBuilder The configuration object.
*
+ * @throws FormException if the form configuration is locked
+ *
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
* {@link addViewTransformer()} instead.
*/
@@ -263,6 +265,8 @@ public function appendClientTransformer(DataTransformerInterface $viewTransforme
*
* @return FormConfigBuilder The configuration object.
*
+ * @throws FormException if the form configuration is locked
+ *
* @deprecated Deprecated since version 2.1, to be removed in 2.3.
*/
public function prependClientTransformer(DataTransformerInterface $viewTransformer)
@@ -279,6 +283,8 @@ public function prependClientTransformer(DataTransformerInterface $viewTransform
*
* @return FormConfigBuilder The configuration object.
*
+ * @throws FormException if the form configuration is locked
+ *
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
* {@link resetViewTransformers()} instead.
*/
@@ -330,6 +336,8 @@ public function resetModelTransformers()
*
* @return FormConfigBuilder The configuration object.
*
+ * @throws FormException if the form configuration is locked
+ *
* @deprecated Deprecated since version 2.1, to be removed in 2.3.
*/
public function appendNormTransformer(DataTransformerInterface $modelTransformer)
@@ -348,6 +356,8 @@ public function appendNormTransformer(DataTransformerInterface $modelTransformer
*
* @return FormConfigBuilder The configuration object.
*
+ * @throws FormException if the form configuration is locked
+ *
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
* {@link addModelTransformer()} instead.
*/
@@ -365,6 +375,8 @@ public function prependNormTransformer(DataTransformerInterface $modelTransforme
*
* @return FormConfigBuilder The configuration object.
*
+ * @throws FormException if the form configuration is locked
+ *
* @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
* {@link resetModelTransformers()} instead.
*/
View
2  Guess/Guess.php
@@ -96,6 +96,8 @@ public static function getBestGuess(array $guesses)
* Constructor
*
* @param integer $confidence The confidence
+ *
+ * @throws \UnexpectedValueException if the given value of confidence is unknown
*/
public function __construct($confidence)
{
View
2  Util/PropertyPathBuilder.php
@@ -89,6 +89,8 @@ public function appendProperty($name)
*
* @param integer $offset The offset at which to remove.
* @param integer $length The length of the removed piece.
+ *
+ * @throws \OutOfBoundsException if offset is invalid
*/
public function remove($offset, $length = 1)
{
Please sign in to comment.
Something went wrong with that request. Please try again.