PHP 8.4 compatibility updates

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
 
     strategy:
       matrix:
-        php-version: ['7.2', '7.3', '7.4', '8.0', '8.1']
+        php-version: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
 
     steps:
       - name: Checkout

_build/lexicon/checklexicon.php

@@ -14,7 +14,7 @@
 /* get rid of time limit */
 set_time_limit(0);
 
-error_reporting(E_ALL | E_STRICT);
+error_reporting(E_ALL);
 ini_set('display_errors', true);
 
 $buildConfig = dirname(dirname(__FILE__)) . '/build.config.php';

_build/transport.core.php

@@ -12,7 +12,7 @@
 /* get rid of time limit */
 set_time_limit(0);
 
-error_reporting(E_ALL | E_STRICT);
+error_reporting(E_ALL);
 ini_set('display_errors', true);
 
 /* buildImage can be defined for running against a specific build image

core/src/Revolution/Error/modErrorHandler.php

@@ -1,4 +1,4 @@
 <?php
 /*
  * This file is part of the MODX Revolution package.
  *
@@ -8,7 +8,7 @@
  * file that was distributed with this source code.
  */
 
 namespace MODX\Revolution\Error;
 
 
 use MODX\Revolution\modX;
@@ -37,7 +37,7 @@
      * @param array $stack A stack of errors that can be passed in.  Send a non-array value to
      *                     prevent any errors from being recorded in the stack.
      */
-    function __construct(modX &$modx, array $stack = [])
+    public function __construct(modX &$modx, array $stack = [])
     {
         $this->modx = &$modx;
         $this->stack = $stack;
@@ -94,13 +94,6 @@
                 $errmsg = 'User notice: ' . $errstr;
                 $this->modx->log(modX::LOG_LEVEL_WARN, $errmsg, '', '', $errfile, $errline);
                 break;
-            case E_STRICT:
-                $handled = true;
-                $errmsg = 'E_STRICT information: ' . $errstr;
-                $this->modx->log(modX::LOG_LEVEL_INFO, $errmsg, '', '', $errfile, $errline);
-
-                return $handled;
-                break;
             case E_RECOVERABLE_ERROR:
                 $handled = true;
                 $errmsg = 'Recoverable error: ' . $errstr;
@@ -117,6 +110,13 @@
                 $this->modx->log(modX::LOG_LEVEL_WARN, $errmsg, '', '', $errfile, $errline);
                 break;
             default:
+                if (version_compare(PHP_VERSION, '8.4.0', '<') && $errno == E_STRICT) {
+                    $handled = true;
+                    $errmsg = 'E_STRICT information: ' . $errstr;
+                    $this->modx->log(modX::LOG_LEVEL_INFO, $errmsg, '', '', $errfile, $errline);
+                    break;
+                }
+
                 $handled = false;
                 $errmsg = 'Un-recoverable error ' . $errno . ': ' . $errstr;
                 $this->modx->log(modX::LOG_LEVEL_ERROR, $errmsg, '', '', $errfile, $errline);

core/src/Revolution/Sources/modMediaSource.php

@@ -1,4 +1,4 @@
 <?php
 namespace MODX\Revolution\Sources;
 
 use Exception;
@@ -360,7 +360,7 @@
 
         $directories = $dirNames = $files = $fileNames = [];
 
         if (!empty($path)) {
 
             // Ensure the provided path can be read.
             try {
@@ -420,7 +420,7 @@
                     $directories[$file_name]['menu'] = [
                         'items' => $this->getListDirContextMenu(),
                     ];
 
                 }
                 elseif ($object instanceof FileAttributes) {
                     // @TODO review/refactor extension and mime_type would be better for filesystems that
@@ -434,7 +434,7 @@
                         continue;
                     }
                     $fileNames[] = strtoupper($file_name);
                     $files[$file_name] = $this->buildFileList($object['path'], $ext, $imageExtensions, $bases, $properties);
                 }
             }
 
@@ -511,13 +511,13 @@
             return [];
         }
         foreach ($contents as $object) {
             if (in_array($object['path'], $skipFiles) || in_array(trim($object['path'], DIRECTORY_SEPARATOR), $skipFiles) || (in_array($fullPath . $object['path'], $skipFiles))) {
                 continue;
             }
             if ($object instanceof DirectoryAttributes && !$this->hasPermission('directory_list')) {
                 continue;
             } elseif ($object['type'] == 'file' && !$properties['hideFiles'] && $this->hasPermission('file_list')) {
                 // @TODO review/refactor ext and mime_type would be better for filesystems that may not always have an extension on it
                 // example would be S3 and you have an HTML file but the name is just myPage
                 //$this->filesystem->getMimetype($object['path']);
                 $ext = pathinfo($object['path'], PATHINFO_EXTENSION);
@@ -529,7 +529,7 @@
                 }
                 $fileNames[] = strtoupper($object['path']);
 
                 $files[$object['path']] = $this->buildFileBrowserViewList($object['path'], $ext, $imageExtensions, $bases, $properties);
             }
         }
 
@@ -1173,7 +1173,7 @@
                     $this->xpdo->log(modX::LOG_LEVEL_ERROR, $e->getMessage());
                 }
             }
-            
+
             $objects[$key] = $file;
         }
 
@@ -1636,7 +1636,7 @@
                 $accessTable = $this->xpdo->getTableName(modAccessMediaSource::class);
                 $sourceTable = $this->xpdo->getTableName(modMediaSource::class);
                 $policyTable = $this->xpdo->getTableName(modAccessPolicy::class);
                 $sql = "SELECT Acl.target, Acl.principal, Acl.authority, Acl.policy, Policy.data FROM {$accessTable} Acl " .
                     "LEFT JOIN {$policyTable} Policy ON Policy.id = Acl.policy " .
                     "JOIN {$sourceTable} Source ON Acl.principal_class = {$this->xpdo->quote(modUserGroup::class)} " .
                     "AND (Acl.context_key = :context OR Acl.context_key IS NULL OR Acl.context_key = '') " .
@@ -1672,11 +1672,11 @@
      *
      * @param string|array $criteria
      * @param array $targets
-     * @param modUser $user
+     * @param modUser|null $user
      *
      * @return bool
      */
-    public function checkPolicy($criteria, $targets = null, modUser $user = null)
+    public function checkPolicy($criteria, $targets = null, ?modUser $user = null)
     {
         if ($criteria == 'load') {
             $success = true;
@@ -1725,10 +1725,10 @@
         $c->select($this->xpdo->escape('key'));
 
         $options[xPDO::OPT_CACHE_KEY] = $this->getOption('cache_media_sources_key', $options, 'media_sources');
         $options[xPDO::OPT_CACHE_HANDLER] = $this->getOption('cache_media_sources_handler', $options, $this->getOption(xPDO::OPT_CACHE_HANDLER, $options));
         $options[xPDO::OPT_CACHE_FORMAT] = (integer)$this->getOption('cache_media_sources_format', $options, $this->getOption(xPDO::OPT_CACHE_FORMAT, $options, xPDOCacheManager::CACHE_PHP));
         $options[xPDO::OPT_CACHE_ATTEMPTS] = (integer)$this->getOption('cache_media_sources_attempts', $options, $this->getOption(xPDO::OPT_CACHE_ATTEMPTS, $options, 10));
         $options[xPDO::OPT_CACHE_ATTEMPT_DELAY] = (integer)$this->getOption('cache_media_sources_attempt_delay', $options, $this->getOption(xPDO::OPT_CACHE_ATTEMPT_DELAY, $options, 1000));
 
         if ($c->prepare() && $c->stmt->execute()) {
             while ($row = $c->stmt->fetch(PDO::FETCH_ASSOC)) {
@@ -1843,7 +1843,7 @@
             $fullPath = $bases['pathAbsolute'] . ltrim($path, DIRECTORY_SEPARATOR);
         }
 
         if (!empty($properties['currentFile']) && rawurldecode($properties['currentFile']) == $fullPath . $path && $properties['currentAction'] == $editAction) {
             $cls[] = 'active-node';
         }
         if ($this->hasPermission('file_remove') && $canRemove) {

core/src/Revolution/modAccessibleObject.php

@@ -242,12 +242,12 @@ public function remove(array $ancestors = [])
      *                               class names to limit the check. In most cases, this does not need to be
      *                               set; derivatives should typically determine what targets to include in
      *                               the findPolicy() implementation.
-     * @param modUser      $user
+     * @param modUser|null $user
      *
      * @return boolean Returns true if the policy is satisfied or no policy
      * exists.
      */
-    public function checkPolicy($criteria, $targets = null, modUser $user = null)
+    public function checkPolicy($criteria, $targets = null, ?modUser $user = null)
     {
         if ($criteria && $this->xpdo instanceof modX && $this->xpdo->getSessionState() == modX::SESSION_STATE_INITIALIZED) {
             if (!$user) {

core/src/Revolution/modDeprecatedMethod.php

@@ -17,7 +17,7 @@ class modDeprecatedMethod extends \xPDO\Om\xPDOSimpleObject
 {
     private $callers = [];
 
-    public function addCaller(string $class, string $function, string $file = null, int $line = null)
+    public function addCaller(string $class, string $function, ?string $file = null, ?int $line = null)
     {
         $def = "{$class}::{$function}::{$file}::{$line}";
 

core/src/Revolution/modNamespace.php

@@ -108,7 +108,7 @@ public static function translatePath(xPDO &$xpdo, $path)
         ], $path);
     }
 
-    public function checkPolicy($criteria, $targets = null, modUser $user = null)
+    public function checkPolicy($criteria, $targets = null, ?modUser $user = null)
     {
         return parent::checkPolicy($criteria, $targets, $user);
     }

core/src/Revolution/modSessionHandler.php

@@ -16,7 +16,7 @@
  *
  * @package MODX\Revolution
  */
-class modSessionHandler
+class modSessionHandler implements \SessionHandlerInterface
 {
     /**
      * @var modX A reference to the modX instance controlling this session
@@ -42,7 +42,7 @@ class modSessionHandler
      *
      * @param modX &$modx A reference to a {@link modX} instance.
      */
-    function __construct(modX &$modx)
+    public function __construct(modX &$modx)
     {
         $this->modx = &$modx;
         $gcMaxlifetime = (integer)$this->modx->getOption('session_gc_maxlifetime');
@@ -64,11 +64,14 @@ function __construct(modX &$modx)
     /**
      * Opens the connection for the session handler.
      *
+     * @param $path
+     * @param $name
      * @access public
      * @return boolean Always returns true; actual connection is managed by
      * {@link modX}.
      */
-    public function open()
+    #[\ReturnTypeWillChange]
+    public function open($path, $name)
     {
         return true;
     }
@@ -80,6 +83,7 @@ public function open()
      * @return boolean Always returns true; actual connection is managed by
      * {@link modX}
      */
+    #[\ReturnTypeWillChange]
     public function close()
     {
         return true;
@@ -94,6 +98,7 @@ public function close()
      *
      * @return string The data read from the {@link modSession} object.
      */
+    #[\ReturnTypeWillChange]
     public function read($id)
     {
         if ($this->_getSession($id)) {
@@ -115,6 +120,7 @@ public function read($id)
      *
      * @return boolean True if successfully written.
      */
+    #[\ReturnTypeWillChange]
     public function write($id, $data)
     {
         $written = false;
@@ -138,6 +144,7 @@ public function write($id, $data)
      *
      * @return boolean True if the session record was destroyed.
      */
+    #[\ReturnTypeWillChange]
     public function destroy($id)
     {
         if ($this->_getSession($id)) {
@@ -159,6 +166,7 @@ public function destroy($id)
      *
      * @return boolean True if session records were removed.
      */
+    #[\ReturnTypeWillChange]
     public function gc($max)
     {
         $maxtime = time() - $this->gcMaxLifetime;

core/src/Revolution/modX.php

@@ -29,6 +29,7 @@
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\ServerRequestFactoryInterface;
 use Psr\Http\Message\StreamFactoryInterface;
+use SessionHandlerInterface;
 use xPDO\Cache\xPDOFileCache;
 use xPDO\xPDO;
 use xPDO\xPDOException;
@@ -2754,14 +2755,18 @@ protected function _initSession($options = null) {
                 if ($sessionHandlerClass = $this->getOption('session_handler_class', $options)) {
                     if ($shClass = $this->loadClass($sessionHandlerClass, '', false, true)) {
                         if ($sh = new $shClass($this)) {
-                            session_set_save_handler(
-                                [& $sh, 'open'],
-                                [& $sh, 'close'],
-                                [& $sh, 'read'],
-                                [& $sh, 'write'],
-                                [& $sh, 'destroy'],
-                                [& $sh, 'gc']
-                            );
+                            if ($sh instanceof SessionHandlerInterface) {
+                                session_set_save_handler($sh);
+                            } else {
+                                session_set_save_handler(
+                                    [& $sh, 'open'],
+                                    [& $sh, 'close'],
+                                    [& $sh, 'read'],
+                                    [& $sh, 'write'],
+                                    [& $sh, 'destroy'],
+                                    [& $sh, 'gc']
+                                );
+                            }
                         }
                     }
                 }