Merge pull request #174 from amboss-mededu/phpdoc-fixes

Fixes in php doc blocks

Author: j0k3r

lib/form/sfForm.class.php

@@ -476,7 +476,7 @@ public function embedForm($name, sfForm $form, $decorator = null)
   /**
    * Gets the list of embedded forms.
    *
-   * @return array An array of embedded forms
+   * @return sfForm[] An array of embedded forms
    */
   public function getEmbeddedForms()
   {
@@ -1074,7 +1074,7 @@ public function offsetExists($name)
    *
    * @param  string $name  The offset of the value to get
    *
-   * @return sfFormField   A form field instance
+   * @return sfFormField|sfFormFieldSchema A form field instance
    */
   public function offsetGet($name)
   {

lib/i18n/sfChoiceFormat.class.php

@@ -85,7 +85,9 @@ public function __construct()
    *
    * @param  float  $number the number to test.
    * @param  string $set    the set, in set notation.
-   * @return boolean true if number is in the set, false otherwise.
+   *
+   * @return bool true if number is in the set, false otherwise.
+   * @throws sfException
    */
   public function isValid($number, $set)
   {
@@ -176,6 +178,7 @@ protected function isValidSetNotation($number, $set)
    * Parses a choice string and get a list of sets and a list of strings corresponding to the sets.
    *
    * @param  string $string the string containing the choices
+   *
    * @return array array($sets, $strings)
    */
   public function parse($string)
@@ -205,7 +208,8 @@ public function parse($string)
    *
    * @param  string $string   the choices string.
    * @param  float  $number   the number to test.
-   * @return string the choosen string.
+   *
+   * @return string the chosen string.
    */
   public function format($string, $number)
   {

lib/plugins/sfDoctrinePlugin/lib/form/sfFormDoctrine.class.php

@@ -25,10 +25,11 @@ abstract class sfFormDoctrine extends sfFormObject
   /**
    * Constructor.
    *
-   * @param mixed  A object used to initialize default values
-   * @param array  An array of options
-   * @param string A CSRF secret (false to disable CSRF protection, null to use the global CSRF secret)
+   * @param mixed  $object     A object used to initialize default values
+   * @param array  $options    An array of options
+   * @param string $CSRFSecret A CSRF secret (false to disable CSRF protection, null to use the global CSRF secret)
    *
+   * @throws sfException
    * @see sfForm
    */
   public function __construct($object = null, $options = array(), $CSRFSecret = null)
@@ -66,8 +67,10 @@ public function getConnection()
   /**
    * Embeds i18n objects into the current form.
    *
-   * @param array   $cultures   An array of cultures
-   * @param string  $decorator  A HTML decorator for the embedded form
+   * @param array  $cultures  An array of cultures
+   * @param string $decorator A HTML decorator for the embedded form
+   *
+   * @throws sfException
    */
   public function embedI18n($cultures, $decorator = null)
   {
@@ -98,11 +101,11 @@ public function embedI18n($cultures, $decorator = null)
    *     $userForm = new UserForm($user);
    *     $userForm->embedRelation('Groups AS groups');
    *
-   * @param  string $relationName  The name of the relation and an optional alias
-   * @param  string $formClass     The name of the form class to use
-   * @param  array  $formArguments Arguments to pass to the constructor (related object will be shifted onto the front)
-   * @param string  $innerDecorator A HTML decorator for each embedded form
-   * @param string  $decorator      A HTML decorator for the main embedded form
+   * @param string $relationName   The name of the relation and an optional alias
+   * @param string $formClass      The name of the form class to use
+   * @param array  $formArgs       Arguments to pass to the constructor (related object will be shifted onto the front)
+   * @param string $innerDecorator A HTML decorator for each embedded form
+   * @param string $decorator      A HTML decorator for the main embedded form
    *
    * @throws InvalidArgumentException If the relationship is not a collection
    */
@@ -161,6 +164,10 @@ protected function doUpdateObject($values)
    * from the array of cleaned up values.
    *
    * @see sfFormObject
+   *
+   * @param array $values
+   *
+   * @return array
    */
   public function processValues($values)
   {
@@ -228,6 +235,7 @@ public function getI18nFormClass()
    * Returns the primary key name of the i18n model.
    *
    * @return string The primary key name of the i18n model
+   * @throws sfException
    */
   public function getI18nModelPrimaryKeyName()
   {

lib/plugins/sfDoctrinePlugin/lib/form/sfFormFilterDoctrine.class.php

@@ -75,7 +75,8 @@ public function setQuery($query)
   /**
    * Returns a Doctrine Query based on the current values form the form.
    *
-   * @return Query A Doctrine Query object
+   * @throws sfValidatorErrorSchema
+   * @return Doctrine_Query A Doctrine Query object
    */
   public function getQuery()
   {
@@ -97,7 +98,7 @@ public function getQuery()
    * The method must return the processed value or false to remove the value
    * from the array of cleaned up values.
    *
-   * @param  array An array of cleaned up values to process
+   * @param  array $values An array of cleaned up values to process
    *
    * @return array An array of cleaned up values processed by the user defined methods
    */
@@ -126,9 +127,9 @@ public function processValues($values)
   /**
    * Builds a Doctrine Query based on the passed values.
    *
-   * @param  array    An array of parameters to build the Query object
+   * @param  array $values An array of parameters to build the Query object
    *
-   * @return Query A Doctrine Query object
+   * @return Doctrine_Query A Doctrine Query object
    */
   public function buildQuery(array $values)
   {
@@ -141,8 +142,9 @@ public function buildQuery(array $values)
    * Overload this method instead of {@link buildQuery()} to avoid running
    * {@link processValues()} multiple times.
    *
-   * @param  array $values
+   * @throws LogicException
    *
+   * @param  array $values
    * @return Doctrine_Query
    */
   protected function doBuildQuery(array $values)

lib/validator/sfValidatorErrorSchema.class.php

@@ -130,7 +130,7 @@ public function getErrors()
   /**
    * Gets an array of all named errors
    *
-   * @return array An array of sfValidatorError instances
+   * @return sfValidatorError[] An array of sfValidatorError instances
    */
   public function getNamedErrors()
   {

lib/validator/sfValidatorSchema.class.php

@@ -355,7 +355,7 @@ public function offsetUnset($name)
   /**
    * Returns an array of fields.
    *
-   * @return sfValidatorBase An array of sfValidatorBase instances
+   * @return sfValidatorBase[] An array of sfValidatorBase instances
    */
   public function getFields()
   {