Merge pull request #22272 from nextcloud/phpdoc/21787/fix-misplaced-v…

…ariable-phpdoc Fix "misplaced variables" warning of Psalm in PHPDoc statements
nextcloud · Aug 17, 2020 · d98bd17 · d98bd17
2 parents 7b8adb1 + d7f66c3
commit d98bd17
Show file tree

Hide file tree

Showing 19 changed files with 26 additions and 31 deletions.
diff --git a/apps/files_external/lib/Service/GlobalStoragesService.php b/apps/files_external/lib/Service/GlobalStoragesService.php
@@ -167,7 +167,7 @@ protected function isApplicable(StorageConfig $config) {
 	/**
 	 * Get all configured admin and personal mounts
 	 *
-	 * @return array map of storage id to storage config
+	 * @return StorageConfig[] map of storage id to storage config
 	 */
 	public function getStorageForAllUsers() {
 		$mounts = $this->dbConfig->getAllMounts();

diff --git a/apps/files_sharing/templates/public.php b/apps/files_sharing/templates/public.php
@@ -1,5 +1,5 @@
 <?php
-/** @var \OCP\IL10N $_ */
+/** @var \OCP\IL10N $l */
 /** @var array $_ */
 ?>
 <div id="app-content">

diff --git a/apps/files_trashbin/templates/index.php b/apps/files_trashbin/templates/index.php
@@ -1,4 +1,4 @@
-<?php /** @var $l \OCP\IL10N */ ?>
+<?php /** @var \OCP\IL10N $l */ ?>
 <div id="controls">
 	<div id="file_action_panel"></div>
 </div>

diff --git a/apps/settings/lib/Search/AppSearch.php b/apps/settings/lib/Search/AppSearch.php
@@ -70,7 +70,6 @@ public function getOrder(string $route, array $routeParameters): int {
 	 * @inheritDoc
 	 */
 	public function search(IUser $user, ISearchQuery $query): SearchResult {
-		/** @var  $entries */
 		$entries = $this->navigationManager->getAll('all');
 
 		$result = [];

diff --git a/apps/user_ldap/templates/renewpassword.php b/apps/user_ldap/templates/renewpassword.php
@@ -1,4 +1,4 @@
-<?php /** @var $l OC_L10N */ ?>
+<?php /** @var \OCP\IL10N $l */ ?>
 <?php
 script('user_ldap', [
 	'renewPassword',

diff --git a/core/Command/User/ResetPassword.php b/core/Command/User/ResetPassword.php
@@ -70,7 +70,6 @@ protected function configure() {
 	protected function execute(InputInterface $input, OutputInterface $output): int {
 		$username = $input->getArgument('user');
 
-		/** @var $user \OCP\IUser */
 		$user = $this->userManager->get($username);
 		if (is_null($user)) {
 			$output->writeln('<error>User does not exist</error>');

diff --git a/core/register_command.php b/core/register_command.php
@@ -42,7 +42,7 @@
  *
  */
 
-/** @var $application Symfony\Component\Console\Application */
+/** @var Symfony\Component\Console\Application $application */
 $application->add(new \Stecman\Component\Symfony\Console\BashCompletion\CompletionCommand());
 $application->add(new OC\Core\Command\Status);
 $application->add(new OC\Core\Command\Check(\OC::$server->getSystemConfig()));

diff --git a/core/templates/404.php b/core/templates/404.php
@@ -1,7 +1,7 @@
 <?php
-/** @var $_ array */
-/** @var $l \OCP\IL10N */
-/** @var $theme OCP\Defaults */
+/** @var array $_ */
+/** @var \OCP\IL10N $l */
+/** @var \OCP\Defaults $theme */
 // @codeCoverageIgnoreStart
 if (!isset($_)) {//standalone  page is not supported anymore - redirect to /
 	require_once '../../lib/base.php';

diff --git a/core/templates/login.php b/core/templates/login.php
@@ -1,4 +1,4 @@
-<?php /** @var $l \OCP\IL10N */ ?>
+<?php /** @var \OCP\IL10N $l */ ?>
 <?php
 script('core', 'dist/login');
 ?>

diff --git a/core/templates/publicshareauth.php b/core/templates/publicshareauth.php
@@ -1,6 +1,6 @@
 <?php
-	/** @var $_ array */
-	/** @var $l \OCP\IL10N */
+	/** @var array $_ */
+	/** @var \OCP\IL10N $l */
 	style('core', 'guest');
 	style('core', 'publicshareauth');
 	script('core', 'publicshareauth');

diff --git a/core/templates/twofactorsetupchallenge.php b/core/templates/twofactorsetupchallenge.php
@@ -1,9 +1,9 @@
 <?php
-/** @var $l \OCP\IL10N */
-/** @var $_ array */
-/* @var $provider OCP\Authentication\TwoFactorAuth\IProvider */
+/** @var \OCP\IL10N $l */
+/** @var array $_ */
+/** @var \OCP\Authentication\TwoFactorAuth\IProvider $provider */
 $provider = $_['provider'];
-/* @var $template string */
+/* @var string $template */
 $template = $_['template'];
 ?>
 

diff --git a/core/templates/twofactorshowchallenge.php b/core/templates/twofactorshowchallenge.php
@@ -1,7 +1,7 @@
 <?php
-/** @var $l \OCP\IL10N */
-/** @var $_ array */
-/* @var $error boolean */
+/** @var \OCP\IL10N $l */
+/** @var array $_*/
+/** @var boolean $error */
 $error = $_['error'];
 /* @var $error_message string */
 $error_message = $_['error_message'];

diff --git a/core/templates/untrustedDomain.php b/core/templates/untrustedDomain.php
@@ -1,4 +1,4 @@
-<?php /** @var $_ array */ ?>
+<?php /** @var array $_ */ ?>
 
 <div class="error">
 	<h2><?php p($l->t('Access through untrusted domain')); ?></h2>

diff --git a/lib/private/DB/MDB2SchemaManager.php b/lib/private/DB/MDB2SchemaManager.php
@@ -145,7 +145,6 @@ public function removeDBStructure($file) {
 		$toSchema = new Schema([], [], $this->conn->getSchemaManager()->createSchemaConfig());
 		$fromSchema = $schemaReader->loadSchemaFromFile($file, $toSchema);
 		$toSchema = clone $fromSchema;
-		/** @var $table \Doctrine\DBAL\Schema\Table */
 		foreach ($toSchema->getTables() as $table) {
 			$toSchema->dropTable($table->getName());
 		}

diff --git a/lib/private/DB/Migrator.php b/lib/private/DB/Migrator.php
@@ -226,7 +226,6 @@ protected function getDiff(Schema $targetSchema, \Doctrine\DBAL\Connection $conn
 		$sourceSchema = $connection->getSchemaManager()->createSchema();
 
 		// remove tables we don't know about
-		/** @var $table \Doctrine\DBAL\Schema\Table */
 		foreach ($sourceSchema->getTables() as $table) {
 			if (!$targetSchema->hasTable($table->getName())) {
 				$sourceSchema->dropTable($table->getName());

diff --git a/lib/private/PreviewManager.php b/lib/private/PreviewManager.php
@@ -261,7 +261,6 @@ public function isAvailable(\OCP\Files\FileInfo $file) {
 						continue;
 					}
 
-					/** @var $provider IProvider */
 					if ($provider->isAvailable($file)) {
 						return true;
 					}

diff --git a/lib/private/Search.php b/lib/private/Search.php
@@ -36,6 +36,7 @@
  * Provide an interface to all search providers
  */
 class Search implements ISearch {
+	/** @var Provider[] */
 	private $providers = [];
 	private $registeredProviders = [];
 
@@ -51,7 +52,6 @@ public function searchPaged($query, array $inApps = [], $page = 1, $size = 30) {
 		$this->initProviders();
 		$results = [];
 		foreach ($this->providers as $provider) {
-			/** @var $provider Provider */
 			if (! $provider->providesResultsFor($inApps)) {
 				continue;
 			}

diff --git a/lib/private/Server.php b/lib/private/Server.php
@@ -580,7 +580,7 @@ public function __construct($webRoot, \OC\Config $config) {
 				$dispatcher->dispatchTyped(new BeforeUserLoggedInWithCookieEvent($uid));
 			});
 			$userSession->listen('\OC\User', 'postRememberedLogin', function ($user, $password) {
-				/** @var $user \OC\User\User */
+				/** @var \OC\User\User $user */
 				\OC_Hook::emit('OC_User', 'post_login', ['run' => true, 'uid' => $user->getUID(), 'password' => $password]);
 
 				/** @var IEventDispatcher $dispatcher */

diff --git a/lib/private/legacy/OC_Util.php b/lib/private/legacy/OC_Util.php
@@ -555,16 +555,16 @@ private static function loadVersion() {
 
 		$timestamp = filemtime(OC::$SERVERROOT . '/version.php');
 		require OC::$SERVERROOT . '/version.php';
-		/** @var $timestamp int */
+		/** @var int $timestamp */
 		self::$versionCache['OC_Version_Timestamp'] = $timestamp;
-		/** @var $OC_Version string */
+		/** @var string $OC_Version */
 		self::$versionCache['OC_Version'] = $OC_Version;
-		/** @var $OC_VersionString string */
+		/** @var string $OC_VersionString */
 		self::$versionCache['OC_VersionString'] = $OC_VersionString;
-		/** @var $OC_Build string */
+		/** @var string $OC_Build */
 		self::$versionCache['OC_Build'] = $OC_Build;
 
-		/** @var $OC_Channel string */
+		/** @var string $OC_Channel */
 		self::$versionCache['OC_Channel'] = $OC_Channel;
 	}