[ticket/17281] Update psalm config and fix issues

PHPBB3-17281

Author: marc1706

attachment/upload.php

@@ -219,6 +219,7 @@ public function upload($form_name, $forum_id, $local = false, $local_storage = '
 				$this->storage->delete($thumbnail_file);
 			}
 
+			/** @psalm-suppress NoValue */
 			$this->file_data['error'] = array_merge($this->file_data['error'], $this->file->error);
 			$this->file_data['post_attach'] = false;
 

avatar/manager.php

@@ -190,7 +190,7 @@ public function get_enabled_drivers()
 	* @param array	$row			User data or group data
 	* @param string $prefix			Prefix of data keys (e.g. user), should not include the trailing underscore
 	*
-	* @return array	User or group data with keys that have been
+	* @return array{string, string}	User or group data with keys that have been
 	*			stripped from the preceding "user_" or "group_"
 	*			Also the group id is prefixed with g, when the prefix group is removed.
 	*/
@@ -202,7 +202,7 @@ public static function clean_row($row, $prefix = '')
 			return self::$default_row;
 		}
 
-		$output = array();
+		$output = [];
 		foreach ($row as $key => $value)
 		{
 			$key = preg_replace("#^(?:{$prefix}_)#", '', $key);

captcha/non_gd.php

@@ -78,6 +78,7 @@ function execute($code, $seed)
 
 				for ($j = 0; $j < $code_len; $j++)
 				{
+					/** @psalm-suppress InvalidArrayOffset */
 					$image .= $this->randomise(substr($hold_chars[$code[$j]][$i - $offset_y - 1], 1), $char_widths[$j]);
 				}
 

config/config.php

@@ -27,7 +27,7 @@ class config implements \ArrayAccess, \IteratorAggregate, \Countable
 	/**
 	* Creates a configuration container with a default set of values
 	*
-	* @param array<string,string> $config The configuration data.
+	* @param array<string,int|string> $config The configuration data.
 	*/
 	public function __construct(array $config)
 	{
@@ -74,22 +74,22 @@ public function offsetGet($key)
 	* The configuration change will not persist. It will be lost
 	* after the request.
 	*
-	* @param string $key   The configuration option's name.
-	* @param string $value The temporary value.
+	* @param string $offset   The configuration option's name.
+	* @param int|string $value The temporary value.
 	*/
 	#[\ReturnTypeWillChange]
-	public function offsetSet($key, $value)
+	public function offsetSet($offset, $value)
 	{
-		$this->config[$key] = $value;
+		$this->config[$offset] = $value;
 	}
 
 	/**
 	* Called when deleting a configuration value directly, triggers an error.
 	*
-	* @param string $key The configuration option's name.
+	* @param string $offset The configuration option's name.
 	*/
 	#[\ReturnTypeWillChange]
-	public function offsetUnset($key)
+	public function offsetUnset($offset): never
 	{
 		trigger_error('Config values have to be deleted explicitly with the \phpbb\config\config::delete($key) method.', E_USER_ERROR);
 	}
@@ -121,7 +121,7 @@ public function delete($key, $use_cache = true)
 	* Sets a configuration option's value
 	*
 	* @param string $key       The configuration option's name
-	* @param string $value     New configuration value
+	* @param int|string $value     New configuration value
 	* @param bool   $use_cache Whether this variable should be cached or if it
 	*                          changes too frequently to be efficiently cached.
 	*/
@@ -135,8 +135,8 @@ public function set($key, $value, $use_cache = true)
 	* current configuration value or the configuration value does not exist yet.
 	*
 	* @param  string $key       The configuration option's name
-	* @param  string $old_value Current configuration value
-	* @param  string $new_value New configuration value
+	* @param  int|string $old_value Current configuration value
+	* @param  int|string $new_value New configuration value
 	* @param  bool   $use_cache Whether this variable should be cached or if it
 	*                           changes too frequently to be efficiently cached.
 	* @return bool              True if the value was changed, false otherwise.
@@ -157,7 +157,7 @@ public function set_atomic($key, $old_value, $new_value, $use_cache = true)
 	* only after set_atomic has been called.
 	*
 	* @param  string $key       The configuration option's name
-	* @param  string $new_value New configuration value
+	* @param  int|string $new_value New configuration value
 	* @throws \phpbb\exception\http_exception when config value is set and not equal to new_value.
 	* @return bool              True if the value was changed, false otherwise.
 	*/

config/db.php

@@ -127,10 +127,10 @@ public function delete($key, $use_cache = true)
 	/**
 	* Sets a configuration option's value
 	*
-	* @param string $key       The configuration option's name
-	* @param string $value     New configuration value
-	* @param bool   $use_cache Whether this variable should be cached or if it
-	*                          changes too frequently to be efficiently cached.
+	* @param	string		$key		The configuration option's name
+	* @param	int|string	$value		New configuration value
+	* @param	bool		$use_cache	Whether this variable should be cached or if it
+	*									changes too frequently to be efficiently cached.
 	*/
 	public function set($key, $value, $use_cache = true)
 	{
@@ -141,13 +141,13 @@ public function set($key, $value, $use_cache = true)
 	* Sets a configuration option's value only if the old_value matches the
 	* current configuration value or the configuration value does not exist yet.
 	*
-	* @param  string $key       The configuration option's name
-	* @param  mixed  $old_value Current configuration value or false to ignore
-	*                           the old value
-	* @param  string $new_value New configuration value
-	* @param  bool   $use_cache Whether this variable should be cached or if it
-	*                           changes too frequently to be efficiently cached
-	* @return bool              True if the value was changed, false otherwise
+	* @param	string			$key		The configuration option's name
+	* @param	false|int|string	$old_value	Current configuration value or false to ignore
+	*										the old value
+	* @param	int|string		$new_value	New configuration value
+	* @param	bool			$use_cache	Whether this variable should be cached or if it
+	*										changes too frequently to be efficiently cached
+	* @return	bool						True if the value was changed, false otherwise
 	*/
 	public function set_atomic($key, $old_value, $new_value, $use_cache = true)
 	{

cron/manager.php

@@ -86,7 +86,7 @@ public function __construct(ContainerInterface $phpbb_container, helper $routing
 	* Loads tasks given by name, wraps them
 	* and puts them into $this->tasks.
 	*
-	* @param array|\Traversable $tasks		Array of instances of \phpbb\cron\task\task
+	* @param array|\ArrayObject $tasks		Array of instances of \phpbb\cron\task\task
 	*/
 	public function load_tasks($tasks)
 	{
@@ -106,6 +106,7 @@ public function load_tasks_from_container()
 		{
 			$this->is_initialised_from_container = true;
 
+			/** @var array|\phpbb\di\service_collection $tasks */
 			$tasks = $this->phpbb_container->get('cron.task_collection');
 
 			$this->load_tasks($tasks);

cron/task/core/tidy_plupload.php

@@ -105,7 +105,7 @@ public function run()
 			));
 		}
 
-		$this->config->set('plupload_last_gc', time(), true);
+		$this->config->set('plupload_last_gc', time());
 	}
 
 	/**

db/doctrine/type_converter.php

@@ -74,7 +74,7 @@ public static function convert(string $type, string $dbms): array
 	 * @param string	$type	Legacy type name.
 	 * @param int		$length	Type length.
 	 *
-	 * @return array{string, array} Pair of type name and options.
+	 * @return array{string, array{string, ...}} Pair of type name and options.
 	 */
 	private static function mapWithLength(string $type, int $length): array
 	{

db/driver/mssql_odbc.php

@@ -279,7 +279,7 @@ public function sql_last_inserted_id()
 			{
 				$id = odbc_result($result_id, 1);
 				odbc_free_result($result_id);
-				return $id;
+				return $id ? (int) $id : false;
 			}
 			odbc_free_result($result_id);
 		}

db/migration/exception.php

@@ -44,7 +44,7 @@ public function __construct()
 	*
 	* @return string
 	*/
-	public function __toString()
+	public function __toString(): string
 	{
 		return $this->message . ': ' . var_export($this->parameters, true);
 	}

db/migration/tool/module.php

@@ -103,6 +103,7 @@ public function exists($class, $parent, $module, $lazy = false)
 
 		foreach ($parent_sqls as $parent_sql)
 		{
+			/** @psalm-suppress NoValue */
 			$sql = 'SELECT module_id
 				FROM ' . $this->modules_table . "
 				WHERE module_class = '" . $this->db->sql_escape($class) . "'

di/container_builder.php

@@ -587,7 +587,7 @@ protected function inject_dbal_driver()
 					$this->config_php_file->get('dbname'),
 					$this->config_php_file->get('dbport'),
 					false,
-					defined('PHPBB_DB_NEW_LINK') && PHPBB_DB_NEW_LINK
+					defined('PHPBB_DB_NEW_LINK') ? PHPBB_DB_NEW_LINK : false
 				);
 			}
 			$this->container->set('dbal.conn.driver', $this->dbal_connection);

di/extension/container_configuration.php

@@ -28,6 +28,7 @@ public function getConfigTreeBuilder()
 	{
 		$treeBuilder = new TreeBuilder('core');
 		$rootNode = $treeBuilder->getRootNode();
+		/** @psalm-suppress UndefinedMethod */
 		$rootNode
 			->children()
 				->booleanNode('require_dev_dependencies')->defaultValue(false)->end()

event/recursive_event_filter_iterator.php

@@ -17,6 +17,8 @@
 * This filter ignores directories and files starting with a dot.
 * It also skips some directories that do not contain events anyway,
 * such as e.g. files/, store/ and vendor/
+*
+* @psalm-suppress MissingTemplateParam
 */
 class recursive_event_filter_iterator extends \RecursiveFilterIterator
 {

extension/provider.php

@@ -23,6 +23,8 @@
 *
 * Items could be anything, for example template paths or cron task names.
 * Derived classes completely define what the items are.
+*
+* @psalm-suppress MissingTemplateParam
 */
 abstract class provider implements \IteratorAggregate
 {
@@ -60,7 +62,7 @@ abstract protected function find();
 	*
 	* @return \ArrayIterator An iterator for the array of template paths
 	*/
-	public function getIterator()
+	public function getIterator(): \ArrayIterator
 	{
 		if ($this->items === null)
 		{

feed/topics_active.php

@@ -119,7 +119,7 @@ private function get_forum_ids()
 				FROM ' . FORUMS_TABLE . '
 				WHERE forum_type = ' . FORUM_POST . '
 					AND ' . $this->db->sql_bit_and('forum_options', FORUM_OPTION_FEED_EXCLUDE, '= 0') . '
-					AND ' . $this->db->sql_bit_and('forum_flags', round(log(FORUM_FLAG_ACTIVE_TOPICS, 2)), '<> 0');
+					AND ' . $this->db->sql_bit_and('forum_flags', (int) round(log(FORUM_FLAG_ACTIVE_TOPICS, 2)), '<> 0');
 			$result = $this->db->sql_query($sql);
 
 			$forum_ids = array();

filesystem/filesystem.php

@@ -632,7 +632,7 @@ protected function phpbb_own_realpath($path)
 				else if (function_exists('debug_backtrace'))
 				{
 					$call_stack = debug_backtrace(0);
-					$this->working_directory = str_replace(DIRECTORY_SEPARATOR, '/', dirname($call_stack[count($call_stack) - 1]['file']));
+					$this->working_directory = str_replace(DIRECTORY_SEPARATOR, '/', dirname($call_stack[max(0, count($call_stack) - 1)]['file']));
 				}
 				else
 				{
@@ -686,6 +686,8 @@ protected function phpbb_own_realpath($path)
 			return false;
 		}
 
+		$resolved_path = (string) $resolved_path;
+
 		if (!@file_exists($resolved_path) || (!@is_dir($resolved_path . '/') && !is_file($resolved_path)))
 		{
 			return false;

filesystem/helper.php

@@ -97,7 +97,7 @@ protected static function phpbb_own_realpath($path)
 			else if (function_exists('debug_backtrace'))
 			{
 				$call_stack = debug_backtrace(0);
-				$working_directory = str_replace(DIRECTORY_SEPARATOR, '/', dirname($call_stack[count($call_stack) - 1]['file']));
+				$working_directory = str_replace(DIRECTORY_SEPARATOR, '/', dirname($call_stack[max(0, count($call_stack) - 1)]['file']));
 			}
 			else
 			{
@@ -156,7 +156,7 @@ protected static function phpbb_own_realpath($path)
 		}
 
 		// Return OS specific directory separators
-		$resolved = str_replace('/', DIRECTORY_SEPARATOR, $resolved_path);
+		$resolved = str_replace('/', DIRECTORY_SEPARATOR, (string) $resolved_path);
 
 		// Check for DIRECTORY_SEPARATOR at the end (and remove it!)
 		if (substr($resolved, -1) === DIRECTORY_SEPARATOR)

finder/recursive_dot_prefix_filter_iterator.php

@@ -19,6 +19,8 @@
 * This filter ignores directories starting with a dot.
 * When searching for php classes and template files of extensions
 * we don't need to look inside these directories.
+*
+* @psalm-suppress MissingTemplateParam
 */
 class recursive_dot_prefix_filter_iterator extends \RecursiveFilterIterator
 {

finder/recursive_path_iterator.php

@@ -15,6 +15,9 @@
 
 namespace phpbb\finder;
 
+/**
+ * @psalm-suppress MissingTemplateParam
+ */
 class recursive_path_iterator extends \RecursiveIteratorIterator
 {
 	/**

install/installer.php

@@ -341,11 +341,11 @@ public function run()
 	/**
 	 * Recover install progress
 	 *
-	 * @return string	Index of the next installer module to execute
+	 * @return int	Index of the next installer module to execute
 	 */
-	protected function recover_progress()
+	protected function recover_progress(): int
 	{
 		$progress_array = $this->install_config->get_progress_data();
-		return $progress_array['last_task_module_index'];
+		return (int) $progress_array['last_task_module_index'];
 	}
 }

install/installer_configuration.php

@@ -28,6 +28,7 @@ public function getConfigTreeBuilder()
 	{
 		$treeBuilder = new TreeBuilder('installer');
 		$rootNode = $treeBuilder->getRootNode();
+		/** @psalm-suppress UndefinedMethod */
 		$rootNode
 			->children()
 				->arrayNode('admin')

install/module/install_database/task/create_schema_file.php

@@ -149,7 +149,7 @@ public function run()
 			$tables = [];
 			foreach ($tables_data['parameters'] as $parameter => $table)
 			{
-				$tables[str_replace('tables.', '', $parameter)] = str_replace('%core.table_prefix%', $table_prefix, $table);
+				$tables[str_replace('tables.', '', (string) $parameter)] = str_replace('%core.table_prefix%', $table_prefix, $table);
 			}
 
 			$schema_generator = new \phpbb\db\migration\schema_generator(

install/module_base.php

@@ -186,12 +186,12 @@ public function run()
 	/**
 	 * Returns the next task's name
 	 *
-	 * @return string	Index of the array element of the next task
+	 * @return int	Index of the array element of the next task
 	 */
-	protected function recover_progress()
+	protected function recover_progress(): int
 	{
 		$progress_array = $this->install_config->get_progress_data();
-		return $progress_array['last_task_index'];
+		return (int) $progress_array['last_task_index'];
 	}
 
 	/**

install/updater_configuration.php

@@ -28,6 +28,7 @@ public function getConfigTreeBuilder()
 	{
 		$treeBuilder = new TreeBuilder('updater');
 		$rootNode = $treeBuilder->getRootNode();
+		/** @psalm-suppress UndefinedMethod */
 		$rootNode
 			->addDefaultsIfNotSet()
 			->children()

notification/manager.php

@@ -223,7 +223,7 @@ public function mark_notifications_by_parent($notification_type_name, $item_pare
 	* Mark notifications read or unread for a given method
 	*
 	* @param string $method_name
-	* @param int|array $notification_id Notification id or array of notification ids.
+	* @param array $notification_id Notification id or array of notification ids.
 	* @param bool|int $time Time at which to mark all notifications prior to as read. False to mark all as read. (Default: False)
 	* @param bool $mark_read Define if the notification as to be set to True or False. (Default: True)
 	*/