Fix PHP deprecations on ArrayAccess and additional classes

FriendsOfSymfony1 · Jan 17, 2024 · 20ab05f · 20ab05f
1 parent 5ec53b7
commit 20ab05f
Show file tree

Hide file tree

Showing 15 changed files with 128 additions and 111 deletions.
diff --git a/lib/Doctrine/Access.php b/lib/Doctrine/Access.php
@@ -96,10 +96,7 @@ public function __unset($name)
     }
 
     /**
-     * Check if an offset axists
-     *
-     * @param   mixed $offset
-     * @return  boolean Whether or not this object contains $offset
+     * @return bool
      */
     #[\ReturnTypeWillChange]
     public function offsetExists($offset)
@@ -108,10 +105,6 @@ public function offsetExists($offset)
     }
 
     /**
-     * An alias of get()
-     *
-     * @see     get, __get
-     * @param   mixed $offset
      * @return  mixed
      */
     #[\ReturnTypeWillChange]
@@ -127,11 +120,6 @@ public function offsetGet($offset)
     }
 
     /**
-     * Sets $offset to $value
-     *
-     * @see     set, __set
-     * @param   mixed $offset
-     * @param   mixed $value
      * @return  void
      */
     #[\ReturnTypeWillChange]
@@ -145,22 +133,19 @@ public function offsetSet($offset, $value)
     }
 
     /**
-     * Unset a given offset
-     *
-     * @see   set, offsetSet, __set
-     * @param mixed $offset
+     * @return void
      */
     #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
-        return $this->remove($offset);
+        $this->remove($offset);
     }
 
     /**
      * Remove the element with the specified offset
      *
      * @param mixed $offset The offset to remove
-     * @return boolean True if removed otherwise false
+     * @return bool True if removed otherwise false
      */
     public function remove($offset)
     {
@@ -191,8 +176,8 @@ public function set($offset, $value)
     }
 
     /**
-     * Check if the specified offset exists 
-     * 
+     * Check if the specified offset exists
+     *
      * @param mixed $offset The offset to check
      * @return boolean True if exists otherwise false
      */
@@ -202,9 +187,9 @@ public function contains($offset)
     }
 
     /**
-     * Add the value  
-     * 
-     * @param mixed $value The value to add 
+     * Add the value
+     *
+     * @param mixed $value The value to add
      * @return void
      */
     public function add($value)

diff --git a/lib/Doctrine/Connection/Common.php b/lib/Doctrine/Connection/Common.php
@@ -38,12 +38,13 @@ class Doctrine_Connection_Common extends Doctrine_Connection
      * @param string $query
      * @param mixed $limit
      * @param mixed $offset
+     * @return string
      */
     public function modifyLimitQuery($query, $limit = false,$offset = false,$isManip=false)
     {
         $limit = (int) $limit;
         $offset = (int) $offset;
-        
+
         if ($limit && $offset) {
             $query .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
         } elseif ($limit && ! $offset) {
@@ -54,4 +55,4 @@ public function modifyLimitQuery($query, $limit = false,$offset = false,$isManip
 
         return $query;
     }
-}
+}
diff --git a/lib/Doctrine/Hydrator.php b/lib/Doctrine/Hydrator.php
@@ -51,7 +51,7 @@ public function __construct()
     /**
      * Set the hydration mode
      *
-     * @param mixed $hydrationMode  One of the Doctrine_Core::HYDRATE_* constants or 
+     * @param mixed $hydrationMode  One of the Doctrine_Core::HYDRATE_* constants or
      *                              a string representing the name of the hydration mode or
      *                              or an instance of the hydration class
      */
@@ -112,9 +112,9 @@ public function getHydratorDriverClassName($mode = null)
     /**
      * Get an instance of the hydration driver for the passed hydration mode
      *
-     * @param string $mode 
-     * @param array $tableAliases 
-     * @return object Doctrine_Hydrator_Abstract
+     * @param string $mode
+     * @param array $tableAliases
+     * @return Doctrine_Hydrator_Abstract
      */
     public function getHydratorDriver($mode, $tableAliases)
     {
@@ -138,8 +138,8 @@ public function getHydratorDriver($mode, $tableAliases)
      * Hydrate the query statement in to its final data structure by one of the
      * hydration drivers.
      *
-     * @param object $stmt 
-     * @param array $tableAliases 
+     * @param object $stmt
+     * @param array $tableAliases
      * @return mixed $result
      */
     public function hydrateResultSet($stmt, $tableAliases)
@@ -149,4 +149,4 @@ public function hydrateResultSet($stmt, $tableAliases)
 
         return $result;
     }
-}
+}
diff --git a/lib/Doctrine/Hydrator/Abstract.php b/lib/Doctrine/Hydrator/Abstract.php
@@ -97,11 +97,11 @@ public function onDemandReset()
      * (I.e. ORACLE limit/offset emulation adds doctrine_rownum to the result set).
      *
      * @param string $name
-     * @return boolean
+     * @return bool
      */
     protected function _isIgnoredName($name)
     {
-        return $name == 'DOCTRINE_ROWNUM';
+        return $name === 'DOCTRINE_ROWNUM';
     }
 
     /**
@@ -114,8 +114,7 @@ protected function _isIgnoredName($name)
      * The key idea is the loop over the rowset only once doing all the needed operations
      * within this massive loop.
      *
-     * @param mixed $stmt
      * @return mixed
      */
     abstract public function hydrateResultSet($stmt);
-}
+}
diff --git a/lib/Doctrine/Hydrator/ArrayHierarchyDriver.php b/lib/Doctrine/Hydrator/ArrayHierarchyDriver.php
@@ -32,6 +32,9 @@
  */
 class Doctrine_Hydrator_ArrayHierarchyDriver extends Doctrine_Hydrator_ArrayDriver
 {
+    /**
+     * @return array
+     */
     public function hydrateResultSet($stmt)
     {
         $collection = parent::hydrateResultSet($stmt);
@@ -80,4 +83,4 @@ public function hydrateResultSet($stmt)
         }
         return $trees;
     }
-}
+}
diff --git a/lib/Doctrine/Hydrator/ArrayShallowDriver.php b/lib/Doctrine/Hydrator/ArrayShallowDriver.php
@@ -32,6 +32,9 @@
  */
 class Doctrine_Hydrator_ArrayShallowDriver extends Doctrine_Hydrator_ScalarDriver
 {
+    /**
+     * @return array
+     */
     public function hydrateResultSet($stmt)
     {
         $cache = array();
@@ -41,4 +44,4 @@ public function hydrateResultSet($stmt)
         }
         return $result;
     }
-}
+}
diff --git a/lib/Doctrine/Hydrator/Graph.php b/lib/Doctrine/Hydrator/Graph.php
@@ -50,6 +50,9 @@ protected function _getCustomIndexField($alias)
         return isset($this->_queryComponents[$alias]['map']) ? $this->_queryComponents[$alias]['map'] : null;
     }
 
+    /**
+     * @return Doctrine_Collection|mixed
+     */
     public function hydrateResultSet($stmt)
     {
         // Used variables during hydration

diff --git a/lib/Doctrine/Hydrator/NoneDriver.php b/lib/Doctrine/Hydrator/NoneDriver.php
@@ -33,8 +33,11 @@
  */
 class Doctrine_Hydrator_NoneDriver extends Doctrine_Hydrator_Abstract
 {
+    /**
+     * @return mixed
+     */
     public function hydrateResultSet($stmt)
     {
         return $stmt->fetchAll(PDO::FETCH_NUM);
     }
-}
+}
diff --git a/lib/Doctrine/Hydrator/RecordHierarchyDriver.php b/lib/Doctrine/Hydrator/RecordHierarchyDriver.php
@@ -32,8 +32,11 @@
  */
 class Doctrine_Hydrator_RecordHierarchyDriver extends Doctrine_Hydrator_RecordDriver
 {
+    /**
+     * @return Doctrine_Collection
+     */
     public function hydrateResultSet($stmt)
     {
         return parent::hydrateResultSet($stmt)->toHierarchy();
     }
-}
+}
diff --git a/lib/Doctrine/Hydrator/ScalarDriver.php b/lib/Doctrine/Hydrator/ScalarDriver.php
@@ -32,6 +32,9 @@
  */
 class Doctrine_Hydrator_ScalarDriver extends Doctrine_Hydrator_Abstract
 {
+    /**
+     * @return array
+     */
     public function hydrateResultSet($stmt)
     {
         $cache = array();
@@ -55,7 +58,7 @@ protected function _gatherRowData($data, &$cache, $aliasPrefix = true)
                 }
                 // cache general information like the column name <-> field name mapping
                 $e = explode('__', $key);
-                $columnName = strtolower(array_pop($e)); 
+                $columnName = strtolower(array_pop($e));
                 $cache[$key]['dqlAlias'] = $this->_tableAliases[strtolower(implode('__', $e))];
                 $table = $this->_queryComponents[$cache[$key]['dqlAlias']]['table'];
                 // check whether it's an aggregate value or a regular field
@@ -84,7 +87,7 @@ protected function _gatherRowData($data, &$cache, $aliasPrefix = true)
             $fieldName = $cache[$key]['fieldName'];
 
             $rowDataKey = $aliasPrefix ? $dqlAlias . '_' . $fieldName:$fieldName;
-            
+
             if ($cache[$key]['isSimpleType'] || $cache[$key]['isAgg']) {
                 $rowData[$rowDataKey] = $value;
             } else {
@@ -94,4 +97,4 @@ protected function _gatherRowData($data, &$cache, $aliasPrefix = true)
         }
         return $rowData;
     }
-}
+}
diff --git a/lib/Doctrine/Hydrator/SingleScalarDriver.php b/lib/Doctrine/Hydrator/SingleScalarDriver.php
@@ -32,6 +32,10 @@
  */
 class Doctrine_Hydrator_SingleScalarDriver extends Doctrine_Hydrator_Abstract
 {
+    /**
+     * @param mixed $stmt
+     * @return array|mixed
+     */
     public function hydrateResultSet($stmt)
     {
         $result = array();
@@ -44,4 +48,4 @@ public function hydrateResultSet($stmt)
             return $result;
         }
     }
-}
+}
diff --git a/lib/Doctrine/Locator/Injectable.php b/lib/Doctrine/Locator/Injectable.php
@@ -66,7 +66,7 @@ public function setLocator(Doctrine_Locator $locator)
     /**
      * getLocator
      * returns the locator associated with this object
-     * 
+     *
      * if there are no locator locally associated then
      * this method tries to fetch the current global locator
      *
@@ -101,7 +101,7 @@ public function locate($name)
             } else {
                 // get the name of the concrete implementation
                 $concreteImpl = $this->_resources[$name];
-                
+
                 return $this->getLocator()->locate($concreteImpl);
             }
         } else {
@@ -115,13 +115,11 @@ public function locate($name)
      *
      * @param string $name      the name of the resource to bind
      * @param mixed $value      the value of the resource
-     * @return Doctrine_Locator   this object
+     * @return void
      */
-    public function bind($name, $resource)
+    public function bind($name, $value)
     {
-        $this->_resources[$name] = $resource;
-
-        return $this;    
+        $this->_resources[$name] = $value;
     }
 
     /**
@@ -146,4 +144,4 @@ public static function getNullObject()
     {
         return self::$_null;
     }
-}
+}