refactor(php): Use DTO to represent a workspace

Author: zak39

lib/Controller/WorkspaceController.php

@@ -144,7 +144,8 @@ public function findAll(): JSONResponse {
 				continue;
 			}
 
-			$spaces[$workspace['name']] = $this->workspaceFormatter->format($workspace, $folderInfo);
+			$workspaceDto = $this->workspaceFormatter->format($workspace, $folderInfo);
+			$spaces[$workspace['name']] = $workspaceDto->jsonSerialize();
 		}
 
 		// We only want to return those workspaces for which the connected user is a manager

lib/Service/Dto/WorkspaceDto.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace OCA\Workspace\Service\Dto;
+
+class WorkspaceDto implements \JsonSerializable {
+	public function __construct(
+		public readonly ?int $id,
+		public readonly ?string $color,
+		public readonly ?int $groupfolderId,
+		public readonly bool $isOpen = false,
+		public readonly ?string $name,
+		public readonly int|string|null $quota,
+		public readonly ?int $size,
+		public readonly mixed $managers,
+		public readonly object $users,
+		public readonly ?int $usersCount,
+		public readonly array $groups,
+		public readonly object $addedGroups,
+	) {
+	}
+
+	public function jsonSerialize(): array {
+		return [
+			'id' => $this->id,
+			'color' => $this->color,
+			'groupfolderId' => $this->groupfolderId,
+			'isOpen' => $this->isOpen,
+			'name' => $this->name,
+			'quota' => $this->quota,
+			'size' => $this->size,
+			'managers' => $this->managers,
+			'users' => $this->users,
+			'usersCount' => $this->usersCount,
+			'groups' => $this->groups,
+			'added_groups' => $this->addedGroups,
+		];
+	}
+}

lib/Service/Formatter/WorkspaceFormatter.php

@@ -2,6 +2,7 @@
 
 namespace OCA\Workspace\Service\Formatter;
 
+use OCA\Workspace\Service\Dto\WorkspaceDto;
 use OCA\Workspace\Service\Group\GroupFormatter;
 use OCA\Workspace\Service\Group\UserGroup;
 use OCP\IGroupManager;
@@ -20,25 +21,13 @@ public function __construct(
 	/**
 	 * @param array $workspace
 	 * @param array $folderInfo
-	 * @return array
+	 * @return WorkspaceDto
 	 */
-	public function format(array $workspace, array $folderInfo): array {
-		$space = [
-			'id' => $workspace['id'] ?? null,
-			'color' => $workspace['color_code'] ?? null,
-			'groupfolderId' => $workspace['groupfolder_id'] ?? null,
-			'isOpen' => false,
-			'name' => $workspace['name'] ?? null,
-			'quota' => $folderInfo['quota'] ?? null,
-			'size' => $folderInfo['size'] ?? null,
-			'managers' => null,
-			'users' => (object)[],
-			'usersCount' => self::NO_USERS,
-		];
-
+	public function format(array $workspace, array $folderInfo): WorkspaceDto {
 		$wsGroups = [];
 		$addedGroups = [];
 		$gids = array_keys($folderInfo['groups'] ?? []);
+		$usersCount = self::NO_USERS;
 
 		foreach ($gids as $gid) {
 			$group = $this->groupManager->get($gid);
@@ -59,13 +48,23 @@ public function format(array $workspace, array $folderInfo): array {
 			}
 
 			if (UserGroup::isWorkspaceUserGroupId($gid)) {
-				$space['usersCount'] = $group->count();
+				$usersCount = $group->count();
 			}
 		}
 
-		$space['groups'] = GroupFormatter::formatGroups($wsGroups);
-		$space['added_groups'] = (object)GroupFormatter::formatGroups($addedGroups);
-
-		return $space;
+		return new WorkspaceDto(
+			id: $workspace['id'] ?? null,
+			color: $workspace['color_code'] ?? null,
+			groupfolderId: $workspace['groupfolder_id'] ?? null,
+			isOpen: false,
+			name: $workspace['name'] ?? null,
+			quota: $folderInfo['quota'] ?? null,
+			size: $folderInfo['size'] ?? null,
+			managers: null,
+			users: (object)[],
+			usersCount: $usersCount,
+			groups: GroupFormatter::formatGroups($wsGroups),
+			addedGroups: (object)GroupFormatter::formatGroups($addedGroups)
+		);
 	}
 }