test: Upgrade to Psalm 6

Author: distantnative

.github/workflows/backend.yml

@@ -104,7 +104,7 @@ jobs:
           extensions: ${{ env.extensions }}
           ini-values: ${{ env.ini }}
           coverage: pcov
-          tools: phpunit:11.5.44, psalm:5.26.1
+          tools: phpunit:11.5.44, psalm:6.13.1
 
       - name: Setup problem matchers
         run: |
@@ -127,7 +127,7 @@ jobs:
         run: phpunit -c phpunit.ci.xml --coverage-clover ${{ github.workspace }}/clover.xml
 
       - name: Statically analyze using Psalm
-        if: always() && steps.finishPrepare.outcome == 'success' && matrix.php != '8.4' && matrix.php != '8.5'
+        if: always() && steps.finishPrepare.outcome == 'success' && matrix.php != '8.5'
         run: psalm --output-format=github --php-version=${{ matrix.php }} --report=sarif/psalm.sarif --report-show-info=false
 
       - name: Upload coverage results to Codecov
@@ -144,7 +144,7 @@ jobs:
           env_vars: PHP
 
       - name: Upload code scanning results to GitHub
-        if: always() && steps.finishPrepare.outcome == 'success' && github.repository == 'getkirby/kirby' && matrix.php != '8.4'  && matrix.php != '8.5'
+        if: always() && steps.finishPrepare.outcome == 'success' && github.repository == 'getkirby/kirby' && matrix.php != '8.5'
         uses: github/codeql-action/upload-sarif@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # pin@v3
         with:
           sarif_file: sarif

psalm.xml.dist

@@ -25,18 +25,25 @@
 			</errorLevel>
 		</InvalidScope>
 
-		<!-- TODO: This check gets flagged by Psalm for unknown reasons in PHP 8.2 -->
-		<MethodSignatureMismatch>
-			<errorLevel type="suppress">
-				<file name="src/Toolkit/Date.php" />
-			</errorLevel>
-		</MethodSignatureMismatch>
-
 		<!-- Don't warn about duplicate array keys as Psalm will throw false positive when unpacking arrays -->
 		<DuplicateArrayKey errorLevel="suppress" />
 
 		<!-- Don't warn about missing template params as Psalm does not recognize this correctly when using `@uses` for traits in class docblock -->
 		<MissingTemplateParam errorLevel="suppress" />
+
+		<!-- Don't warn about missing override attribute -->
+		<MissingOverrideAttribute errorLevel="suppress" />
+
+		<!-- Don't warn about possibly unused parts, Psalm cannot know what Kirby parts are used by developers -->
+		<PossiblyUnusedMethod errorLevel="suppress" />
+		<PossiblyUnusedParam errorLevel="suppress" />
+		<PossiblyUnusedProperty errorLevel="suppress" />
+		<PossiblyUnusedReturnValue errorLevel="suppress" />
+		<UnusedClass errorLevel="suppress" />
+		<UnusedClosureParam errorLevel="suppress" />
+		<UnusedForeachValue errorLevel="suppress" />
+		<UnusedVariable errorLevel="suppress" />
+		<UndefinedClass errorLevel="suppress" />
 	</issueHandlers>
 
 	<plugins>

src/Cms/Pagination.php

@@ -140,8 +140,8 @@ public function pageUrl(int|null $page = null): string|null
 		}
 
 		match ($this->method) {
-			'query' => $url->query->$variable  = $page,
-			'param' => $url->params->$variable = $page
+			'query' => $url->query()->$variable  = $page,
+			'param' => $url->params()->$variable = $page
 		};
 
 		return $url->toString();

src/Cms/Url.php

@@ -41,7 +41,6 @@ public static function home(): string
 	 * @param string $separator To be used instead of space and
 	 *                          other non-word characters.
 	 * @param string $allowed List of all allowed characters (regex)
-	 * @param int $maxlength The maximum length of the slug
 	 * @return string The safe string
 	 */
 	public static function slug(

src/Content/Version.php

@@ -424,9 +424,9 @@ protected function previewTokenFromUrl(string $url): string
 	{
 		// get rid of all modifiers after the path
 		$uri = new Uri($url);
-		$uri->fragment = null;
-		$uri->params   = null;
-		$uri->query    = null;
+		$uri->setFragment(null);
+		$uri->setParams(null);
+		$uri->setQuery(null);
 
 		$data = [
 			'url'       => $uri->toString(),
@@ -676,10 +676,10 @@ protected function urlFromOption(string $url): string
 	protected function urlWithQueryParams(string $baseUrl, string $token): string
 	{
 		$uri = new Uri($baseUrl);
-		$uri->query->_token = $token;
+		$uri->query()->_token = $token;
 
 		if ($this->id->is('changes') === true) {
-			$uri->query->_version = 'changes';
+			$uri->query()->_version = 'changes';
 		}
 
 		return $uri->toString();

src/Http/Url.php

@@ -181,15 +181,15 @@ public static function short(
 	): string {
 		$uri = static::toObject($url);
 
-		$uri->fragment = null;
-		$uri->query    = null;
-		$uri->password = null;
-		$uri->port     = null;
-		$uri->scheme   = null;
-		$uri->username = null;
+		$uri->setFragment(null);
+		$uri->setQuery(null);
+		$uri->setPassword(null);
+		$uri->setPort(null);
+		$uri->setScheme(null);
+		$uri->setUsername(null);
 
 		// remove the trailing slash from the path
-		$uri->slash = false;
+		$uri->setSlash(false);
 
 		$url = $base ? $uri->base() : $uri->toString();
 		$url = str_replace('www.', '', $url ?? '');

src/Panel/Home.php

@@ -228,8 +228,8 @@ public static function url(): string
 
 		// remove all params to avoid
 		// possible attack vectors
-		$uri->params = '';
-		$uri->query  = '';
+		$uri->setParams('');
+		$uri->setQuery('');
 
 		// get a clean version of the URL
 		$url = $uri->toString();

src/Session/FileSessionStore.php

@@ -371,15 +371,15 @@ public function collectGarbage(): void
 	public function __destruct()
 	{
 		// unlock all locked files
-		foreach ($this->isLocked as $name => $locked) {
+		foreach (array_keys($this->isLocked) as $name) {
 			$expiryTime = (int)Str::before($name, '.');
 			$id         = Str::after($name, '.');
 
 			$this->unlock($expiryTime, $id);
 		}
 
 		// close all file handles
-		foreach ($this->handles as $name => $handle) {
+		foreach (array_keys($this->handles) as $name) {
 			$this->closeHandle($name);
 		}
 	}

src/Toolkit/A.php

@@ -911,7 +911,7 @@ public static function sort(
 		}
 
 		// rebuild the original array
-		foreach ($helper as $key => $val) {
+		foreach (array_keys($helper) as $key) {
 			$result[$key] = $array[$key];
 		}
 

src/Toolkit/Collection.php

@@ -967,6 +967,8 @@ public static function sortArgs(string $sort): array
 	 * @param string|null $direction asc or desc
 	 * @param int|null $method The sort flag, SORT_REGULAR, SORT_NUMERIC etc.
 	 * @return $this|static
+	 *
+	 * @psalm-suppress UnusedVariable
 	 */
 	public function sort(...$args): static
 	{