Fix PHP deprecations on Doctrine_Record_Filter::filterSet() and ::filterGet() and sub-classes

thePanz · thePanz · commit a9a1f10c7c5c · 2024-10-26T00:53:02.000+02:00
diff --git a/lib/Doctrine/Record/Filter.php b/lib/Doctrine/Record/Filter.php
@@ -33,6 +33,9 @@
  */
 abstract class Doctrine_Record_Filter
 {
+    /**
+     * @var Doctrine_Table|null
+     */
     protected $_table;
 
     public function setTable(Doctrine_Table $table)
@@ -56,7 +59,7 @@ public function init()
      *
      * @return Doctrine_Record the given record
      *
-     * @thrown Doctrine_Exception when this way is not available
+     * @throws Doctrine_Exception when this way is not available
      */
     abstract public function filterSet(Doctrine_Record $record, $propertyOrRelation, $value);
 
@@ -67,7 +70,7 @@ abstract public function filterSet(Doctrine_Record $record, $propertyOrRelation,
      *
      * @return mixed
      *
-     * @thrown Doctrine_Exception when this way is not available
+     * @throws Doctrine_Exception when this way is not available
      */
     abstract public function filterGet(Doctrine_Record $record, $propertyOrRelation);
 }
diff --git a/lib/Doctrine/Record/Filter/Compound.php b/lib/Doctrine/Record/Filter/Compound.php
@@ -56,15 +56,6 @@ public function init()
         }
     }
 
-    /**
-     * Provides a way for setting property or relation value to the given record.
-     *
-     * @param string $propertyOrRelation
-     *
-     * @return Doctrine_Record the given record
-     *
-     * @thrown Doctrine_Record_UnknownPropertyException when this way is not available
-     */
     public function filterSet(Doctrine_Record $record, $propertyOrRelation, $value)
     {
         foreach ($this->_aliases as $alias) {
@@ -89,15 +80,6 @@ public function filterSet(Doctrine_Record $record, $propertyOrRelation, $value)
         throw new Doctrine_Record_UnknownPropertyException(sprintf('Unknown record property / related component "%s" on "%s"', $propertyOrRelation, get_class($record)));
     }
 
-    /**
-     * Provides a way for getting property or relation value from the given record.
-     *
-     * @param string $propertyOrRelation
-     *
-     * @return mixed
-     *
-     * @thrown Doctrine_Record_UnknownPropertyException when this way is not available
-     */
     public function filterGet(Doctrine_Record $record, $propertyOrRelation)
     {
         foreach ($this->_aliases as $alias) {
diff --git a/lib/Doctrine/Record/Filter/Standard.php b/lib/Doctrine/Record/Filter/Standard.php
@@ -33,21 +33,11 @@
  */
 class Doctrine_Record_Filter_Standard extends Doctrine_Record_Filter
 {
-    /**
-     * @param string $propertyOrRelation
-     *
-     * @thrown Doctrine_Record_UnknownPropertyException
-     */
     public function filterSet(Doctrine_Record $record, $propertyOrRelation, $value)
     {
         throw new Doctrine_Record_UnknownPropertyException(sprintf('Unknown record property / related component "%s" on "%s"', $propertyOrRelation, get_class($record)));
     }
 
-    /**
-     * @param string $propertyOrRelation
-     *
-     * @thrown Doctrine_Record_UnknownPropertyException
-     */
     public function filterGet(Doctrine_Record $record, $propertyOrRelation)
     {
         throw new Doctrine_Record_UnknownPropertyException(sprintf('Unknown record property / related component "%s" on "%s"', $propertyOrRelation, get_class($record)));

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,9 @@`
`33`	`33`	`*/`
`34`	`34`	`abstract class Doctrine_Record_Filter`
`35`	`35`	`{`
	`36`	`+ /**`
	`37`	`+ * @var Doctrine_Table\|null`
	`38`	`+ */`
`36`	`39`	`protected $_table;`
`37`	`40`
`38`	`41`	`public function setTable(Doctrine_Table $table)`
`@@ -56,7 +59,7 @@ public function init()`
`56`	`59`	`*`
`57`	`60`	`* @return Doctrine_Record the given record`
`58`	`61`	`*`
`59`		`- * @thrown Doctrine_Exception when this way is not available`
	`62`	`+ * @throws Doctrine_Exception when this way is not available`
`60`	`63`	`*/`
`61`	`64`	`abstract public function filterSet(Doctrine_Record $record, $propertyOrRelation, $value);`
`62`	`65`
`@@ -67,7 +70,7 @@ abstract public function filterSet(Doctrine_Record $record, $propertyOrRelation,`
`67`	`70`	`*`
`68`	`71`	`* @return mixed`
`69`	`72`	`*`
`70`		`- * @thrown Doctrine_Exception when this way is not available`
	`73`	`+ * @throws Doctrine_Exception when this way is not available`
`71`	`74`	`*/`
`72`	`75`	`abstract public function filterGet(Doctrine_Record $record, $propertyOrRelation);`
`73`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,15 +56,6 @@ public function init()`
`56`	`56`	`}`
`57`	`57`	`}`
`58`	`58`
`59`		`- /**`
`60`		`- * Provides a way for setting property or relation value to the given record.`
`61`		`- *`
`62`		`- * @param string $propertyOrRelation`
`63`		`- *`
`64`		`- * @return Doctrine_Record the given record`
`65`		`- *`
`66`		`- * @thrown Doctrine_Record_UnknownPropertyException when this way is not available`
`67`		`- */`
`68`	`59`	`public function filterSet(Doctrine_Record $record, $propertyOrRelation, $value)`
`69`	`60`	`{`
`70`	`61`	`foreach ($this->_aliases as $alias) {`
`@@ -89,15 +80,6 @@ public function filterSet(Doctrine_Record $record, $propertyOrRelation, $value)`
`89`	`80`	`throw new Doctrine_Record_UnknownPropertyException(sprintf('Unknown record property / related component "%s" on "%s"', $propertyOrRelation, get_class($record)));`
`90`	`81`	`}`
`91`	`82`
`92`		`- /**`
`93`		`- * Provides a way for getting property or relation value from the given record.`
`94`		`- *`
`95`		`- * @param string $propertyOrRelation`
`96`		`- *`
`97`		`- * @return mixed`
`98`		`- *`
`99`		`- * @thrown Doctrine_Record_UnknownPropertyException when this way is not available`
`100`		`- */`
`101`	`83`	`public function filterGet(Doctrine_Record $record, $propertyOrRelation)`
`102`	`84`	`{`
`103`	`85`	`foreach ($this->_aliases as $alias) {`
Original file line number	Diff line number	Diff line change
`@@ -33,21 +33,11 @@`
`33`	`33`	`*/`
`34`	`34`	`class Doctrine_Record_Filter_Standard extends Doctrine_Record_Filter`
`35`	`35`	`{`
`36`		`- /**`
`37`		`- * @param string $propertyOrRelation`
`38`		`- *`
`39`		`- * @thrown Doctrine_Record_UnknownPropertyException`
`40`		`- */`
`41`	`36`	`public function filterSet(Doctrine_Record $record, $propertyOrRelation, $value)`
`42`	`37`	`{`
`43`	`38`	`throw new Doctrine_Record_UnknownPropertyException(sprintf('Unknown record property / related component "%s" on "%s"', $propertyOrRelation, get_class($record)));`
`44`	`39`	`}`
`45`	`40`
`46`		`- /**`
`47`		`- * @param string $propertyOrRelation`
`48`		`- *`
`49`		`- * @thrown Doctrine_Record_UnknownPropertyException`
`50`		`- */`
`51`	`41`	`public function filterGet(Doctrine_Record $record, $propertyOrRelation)`
`52`	`42`	`{`
`53`	`43`	`throw new Doctrine_Record_UnknownPropertyException(sprintf('Unknown record property / related component "%s" on "%s"', $propertyOrRelation, get_class($record)));`