Fix comments for record filter

Author: alquerci

lib/Doctrine/Record/Filter.php

@@ -45,23 +45,28 @@ public function getTable()
         return $this->_table;
     }
 
+    /**
+     * @throws Doctrine_Table_Exception
+     */
     public function init()
     {
     }
 
     /**
-     * filterSet
-     * defines an implementation for filtering the set() method of Doctrine_Record
+     * Provides fallback for setting value.
      *
-     * @param mixed $name                       name of the property or related component
+     * @return Doctrine_Record the given record
+     *
+     * @thrown Doctrine_Exception
      */
     abstract public function filterSet(Doctrine_Record $record, $name, $value);
 
     /**
-     * filterGet
-     * defines an implementation for filtering the get() method of Doctrine_Record
+     * Provides fallback for getting value.
+     *
+     * @return mixed The value of the given property
      *
-     * @param mixed $name                       name of the property or related component
+     * @thrown Doctrine_Exception
      */
     abstract public function filterGet(Doctrine_Record $record, $name);
-}
+}

lib/Doctrine/Record/Filter/Compound.php

@@ -32,38 +32,48 @@
  */
 class Doctrine_Record_Filter_Compound extends Doctrine_Record_Filter
 {
+    /**
+     * @var string[]
+     */
     protected $_aliases = array();
 
+    /**
+     * @param string[] $aliases A list of relation name
+     */
     public function __construct(array $aliases)
     {
         $this->_aliases = $aliases;
     }
 
+    /**
+     * @throws Doctrine_Table_Exception
+     */
     public function init()
     {
-    	// check that all aliases exist
-    	foreach ($this->_aliases as $alias) {
+        // check that all aliases exist
+        foreach ($this->_aliases as $alias) {
             $this->_table->getRelation($alias);
-    	}
+        }
     }
 
     /**
-     * filterSet
-     * defines an implementation for filtering the set() method of Doctrine_Record
+     * Provides fallback for setting value.
+     *
+     * @return Doctrine_Record the given record
      *
-     * @param mixed $name                       name of the property or related component
+     * @thrown Doctrine_Record_UnknownPropertyException
      */
     public function filterSet(Doctrine_Record $record, $name, $value)
     {
         foreach ($this->_aliases as $alias) {
-            // The relationship must be fetched in order to check the field existance.
+            // The relationship must be fetched in order to check the field existence.
             // Related to PHP-7.0 compatibility so an explicit call to method get is required.
             $record[$alias];
 
             if ( ! $record->exists()) {
                 if (isset($record[$alias][$name])) {
                     $record[$alias][$name] = $value;
-                    
+
                     return $record;
                 }
             } else {
@@ -78,15 +88,16 @@ public function filterSet(Doctrine_Record $record, $name, $value)
     }
 
     /**
-     * filterGet
-     * defines an implementation for filtering the get() method of Doctrine_Record
+     * Provides fallback for getting value.
+     *
+     * @return mixed The value of the given property
      *
-     * @param mixed $name                       name of the property or related component
+     * @thrown Doctrine_Record_UnknownPropertyException
      */
     public function filterGet(Doctrine_Record $record, $name)
     {
         foreach ($this->_aliases as $alias) {
-            // The relationship must be fetched in order to check the field existance.
+            // The relationship must be fetched in order to check the field existence.
             // Related to PHP-7.0 compatibility so an explicit call to method get is required.
             $record[$alias];
 
@@ -102,4 +113,4 @@ public function filterGet(Doctrine_Record $record, $name)
         }
         throw new Doctrine_Record_UnknownPropertyException(sprintf('Unknown record property / related component "%s" on "%s"', $name, get_class($record)));
     }
-}
+}

lib/Doctrine/Record/Filter/Standard.php

@@ -34,21 +34,15 @@
 class Doctrine_Record_Filter_Standard extends Doctrine_Record_Filter
 {
     /**
-     * filterSet
-     * defines an implementation for filtering the set() method of Doctrine_Record
-     *
-     * @param mixed $name                       name of the property or related component
+     * @thrown Doctrine_Record_UnknownPropertyException
      */
     public function filterSet(Doctrine_Record $record, $name, $value)
     {
         throw new Doctrine_Record_UnknownPropertyException(sprintf('Unknown record property / related component "%s" on "%s"', $name, get_class($record)));
     }
 
     /**
-     * filterGet
-     * defines an implementation for filtering the get() method of Doctrine_Record
-     *
-     * @param mixed $name                       name of the property or related component
+     * @thrown Doctrine_Record_UnknownPropertyException
      */
     public function filterGet(Doctrine_Record $record, $name)
     {