[Form] Fixed some PHPDoc

This commit is contained in:
Pascal Borreli 2012-08-27 00:03:52 +00:00 committed by Tobias Schultze
parent 596bbb1327
commit 83dc966f1c
9 changed files with 30 additions and 5 deletions

View File

@ -77,7 +77,9 @@ class ChoiceToBooleanArrayTransformer implements DataTransformerInterface
* *
* @return mixed A scalar value * @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) public function reverseTransform($values)
{ {

View File

@ -80,6 +80,8 @@ class ChoicesToBooleanArrayTransformer implements DataTransformerInterface
* @return mixed An 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) public function reverseTransform($values)
{ {

View File

@ -60,6 +60,7 @@ class ChoicesToValuesTransformer implements DataTransformerInterface
* @return 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) public function reverseTransform($array)
{ {

View File

@ -42,6 +42,8 @@ class PercentToLocalizedStringTransformer implements DataTransformerInterface
* *
* @param integer $precision The precision * @param integer $precision The precision
* @param string $type One of the supported types * @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) public function __construct($precision = null, $type = null)
{ {

View File

@ -143,6 +143,8 @@ class Form implements \IteratorAggregate, FormInterface
* Creates a new form based on the given configuration. * Creates a new form based on the given configuration.
* *
* @param FormConfigInterface $config The form 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) public function __construct(FormConfigInterface $config)
{ {

View File

@ -244,6 +244,8 @@ class FormConfigBuilder implements FormConfigBuilderInterface
* *
* @return FormConfigBuilder The configuration object. * @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 * @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
* {@link addViewTransformer()} instead. * {@link addViewTransformer()} instead.
*/ */
@ -263,6 +265,8 @@ class FormConfigBuilder implements FormConfigBuilderInterface
* *
* @return FormConfigBuilder The configuration object. * @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. * @deprecated Deprecated since version 2.1, to be removed in 2.3.
*/ */
public function prependClientTransformer(DataTransformerInterface $viewTransformer) public function prependClientTransformer(DataTransformerInterface $viewTransformer)
@ -279,6 +283,8 @@ class FormConfigBuilder implements FormConfigBuilderInterface
* *
* @return FormConfigBuilder The configuration object. * @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 * @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
* {@link resetViewTransformers()} instead. * {@link resetViewTransformers()} instead.
*/ */
@ -330,6 +336,8 @@ class FormConfigBuilder implements FormConfigBuilderInterface
* *
* @return FormConfigBuilder The configuration object. * @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. * @deprecated Deprecated since version 2.1, to be removed in 2.3.
*/ */
public function appendNormTransformer(DataTransformerInterface $modelTransformer) public function appendNormTransformer(DataTransformerInterface $modelTransformer)
@ -348,6 +356,8 @@ class FormConfigBuilder implements FormConfigBuilderInterface
* *
* @return FormConfigBuilder The configuration object. * @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 * @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
* {@link addModelTransformer()} instead. * {@link addModelTransformer()} instead.
*/ */
@ -365,6 +375,8 @@ class FormConfigBuilder implements FormConfigBuilderInterface
* *
* @return FormConfigBuilder The configuration object. * @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 * @deprecated Deprecated since version 2.1, to be removed in 2.3. Use
* {@link resetModelTransformers()} instead. * {@link resetModelTransformers()} instead.
*/ */

View File

@ -96,6 +96,8 @@ abstract class Guess
* Constructor * Constructor
* *
* @param integer $confidence The confidence * @param integer $confidence The confidence
*
* @throws \UnexpectedValueException if the given value of confidence is unknown
*/ */
public function __construct($confidence) public function __construct($confidence)
{ {

View File

@ -89,6 +89,8 @@ class PropertyPathBuilder
* *
* @param integer $offset The offset at which to remove. * @param integer $offset The offset at which to remove.
* @param integer $length The length of the removed piece. * @param integer $length The length of the removed piece.
*
* @throws \OutOfBoundsException if offset is invalid
*/ */
public function remove($offset, $length = 1) public function remove($offset, $length = 1)
{ {