Upgraded URL Alias Doctrine Gateway to doctrine/dbal v3 and improved code quality

Author: alongosz

src/lib/Persistence/Legacy/Content/UrlAlias/Gateway.php

@@ -18,13 +18,13 @@ abstract class Gateway
     /**
      * Default database table.
      */
-    public const TABLE = 'ezurlalias_ml';
+    public const string TABLE = 'ezurlalias_ml';
 
-    public const INCR_TABLE = 'ezurlalias_ml_incr';
-    public const INCR_TABLE_SEQ = 'ezurlalias_ml_incr_id_seq';
+    public const string INCR_TABLE = 'ezurlalias_ml_incr';
+    public const string INCR_TABLE_SEQ = 'ezurlalias_ml_incr_id_seq';
 
-    public const NOP = 'nop';
-    public const NOP_ACTION = self::NOP . ':';
+    public const string NOP = 'nop';
+    public const string NOP_ACTION = self::NOP . ':';
 
     /**
      * Changes the gateway database table.
@@ -37,11 +37,15 @@ abstract public function setTable(string $name): void;
 
     /**
      * Loads all list of aliases by given $locationId.
+     *
+     * @phpstan-return list<array<string,mixed>>
      */
     abstract public function loadAllLocationEntries(int $locationId): array;
 
     /**
      * Load list of aliases by given $locationId.
+     *
+     * @phpstan-return list<array<string,mixed>>
      */
     abstract public function loadLocationEntries(
         int $locationId,
@@ -52,6 +56,8 @@ abstract public function loadLocationEntries(
     /**
      * Load paged list of global aliases.
      *
+     * @phpstan-return list<array<string,mixed>>
+     *
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException if the given language doesn't exist
      */
     abstract public function listGlobalEntries(
@@ -63,27 +69,29 @@ abstract public function listGlobalEntries(
     /**
      * Return boolean indicating if the row with given $id is special root entry.
      *
-     * Special root entry entry will have parentId=0 and text=''.
+     * Special root entry will have parentId=0 and text=''.
      * In standard installation this entry will point to location with id=2.
      */
     abstract public function isRootEntry(int $id): bool;
 
     /**
      * Update single row data matched by composite primary key.
      *
-     * @param array $values associative array with column names as keys and column values as values
+     * @param array<string, mixed> $values associative array with column names as keys and column values as values
      */
     abstract public function updateRow(int $parentId, string $textMD5, array $values): void;
 
     /**
      * Insert new row into urlalias_ml table.
      *
-     * @param array $values
+     * @param array<string, mixed> $values
      */
     abstract public function insertRow(array $values): int;
 
     /**
      * Load single row matched by composite primary key.
+     *
+     * @return array<string, mixed>
      */
     abstract public function loadRow(int $parentId, string $textMD5): array;
 
@@ -92,7 +100,7 @@ abstract public function loadRow(int $parentId, string $textMD5): array;
      * composite primary key.
      *
      * If language mask of the found entry is composite (meaning it consists of multiple language ids) given
-     * $languageId will be removed from mask. Otherwise entry will be marked as history.
+     * $languageId will be removed from mask. Otherwise, entry will be marked as history.
      */
     abstract public function cleanupAfterPublish(
         string $action,
@@ -128,6 +136,8 @@ abstract public function reparent(int $oldParentId, int $newParentId): void;
     /**
      * Load path data identified by given $id.
      *
+     * @phpstan-return list<list<array<string,mixed>>>
+     *
      * @throws \Ibexa\Contracts\Core\Repository\Exceptions\BadStateException
      */
     abstract public function loadPathData(int $id): array;
@@ -140,19 +150,25 @@ abstract public function loadPathData(int $id): array;
      * This method is faster than self::getPath() since it can fetch all elements using only one query, but can be used
      * only for autogenerated paths.
      *
-     * @param array $hierarchyData hierarchy-ordered URL alias entries data
+     * @phpstan-param list<array{id: int, parent: int, action: string}> $hierarchyData hierarchy-ordered URL alias entries data
+     *
+     * @phpstan-return list<list<array<string, mixed>>>
      */
     abstract public function loadPathDataByHierarchy(array $hierarchyData): array;
 
     /**
      * Load complete URL alias data by given array of path hashes.
      *
      * @param string[] $urlHashes URL string hashes
+     *
+     * @return array<string, mixed>
      */
     abstract public function loadUrlAliasData(array $urlHashes): array;
 
     /**
      * Load autogenerated entry id by given $action and optionally $parentId.
+     *
+     * @return array<string, mixed>
      */
     abstract public function loadAutogeneratedEntry(string $action, ?int $parentId = null): array;
 
@@ -170,6 +186,8 @@ abstract public function remove(string $action, ?int $id = null): void;
 
     /**
      * Load all autogenerated entries with given $parentId with optionally included history entries.
+     *
+     * @phpstan-return list<array<string,mixed>>
      */
     abstract public function loadAutogeneratedEntries(
         int $parentId,
@@ -235,6 +253,8 @@ abstract public function deleteUrlNopAliasesWithoutChildren(): int;
 
     /**
      * Return aliases which are connected with provided parentId.
+     *
+     * @phpstan-return list<array<string,mixed>>
      */
     abstract public function getAllChildrenAliases(int $parentId): array;