refactor: Rename OpenAPI type aliases to their namespaces

Signed-off-by: jld3103 <[email protected]>

Author: provokateurin

apps/cloud_federation_api/lib/Controller/RequestHandlerController.php

@@ -51,9 +51,9 @@
  *
  * @package OCA\CloudFederationAPI\Controller
  *
- * @psalm-import-type CloudFederationApiAddShare from ResponseDefinitions
- * @psalm-import-type CloudFederationApiValidationError from ResponseDefinitions
- * @psalm-import-type CloudFederationApiError from ResponseDefinitions
+ * @psalm-import-type CloudFederationAPIAddShare from ResponseDefinitions
+ * @psalm-import-type CloudFederationAPIValidationError from ResponseDefinitions
+ * @psalm-import-type CloudFederationAPIError from ResponseDefinitions
  */
 class RequestHandlerController extends Controller {
 	public function __construct(
@@ -90,7 +90,7 @@ public function __construct(
 	 * @param string $shareType 'group' or 'user' share
 	 * @param string $resourceType 'file', 'calendar',...
 	 *
-	 * @return JSONResponse<Http::STATUS_CREATED, CloudFederationApiAddShare, array{}>|JSONResponse<Http::STATUS_BAD_REQUEST, CloudFederationApiValidationError, array{}>|JSONResponse<Http::STATUS_NOT_IMPLEMENTED, CloudFederationApiError, array{}>
+	 * @return JSONResponse<Http::STATUS_CREATED, CloudFederationAPIAddShare, array{}>|JSONResponse<Http::STATUS_BAD_REQUEST, CloudFederationAPIValidationError, array{}>|JSONResponse<Http::STATUS_NOT_IMPLEMENTED, CloudFederationAPIError, array{}>
 	 * 201: The notification was successfully received. The display name of the recipient might be returned in the body
 	 * 400: Bad request due to invalid parameters, e.g. when `shareWith` is not found or required properties are missing
 	 * 501: Share type or the resource type is not supported
@@ -213,7 +213,7 @@ public function addShare($shareWith, $name, $description, $providerId, $owner, $
 	 * @param string|null $providerId ID of the share
 	 * @param array<string, mixed>|null $notification The actual payload of the notification
 	 *
-	 * @return JSONResponse<Http::STATUS_CREATED, array<string, mixed>, array{}>|JSONResponse<Http::STATUS_BAD_REQUEST, CloudFederationApiValidationError, array{}>|JSONResponse<Http::STATUS_FORBIDDEN|Http::STATUS_NOT_IMPLEMENTED, CloudFederationApiError, array{}>
+	 * @return JSONResponse<Http::STATUS_CREATED, array<string, mixed>, array{}>|JSONResponse<Http::STATUS_BAD_REQUEST, CloudFederationAPIValidationError, array{}>|JSONResponse<Http::STATUS_FORBIDDEN|Http::STATUS_NOT_IMPLEMENTED, CloudFederationAPIError, array{}>
 	 * 201: The notification was successfully received
 	 * 400: Bad request due to invalid parameters, e.g. when `type` is invalid or missing
 	 * 403: Getting resource is not allowed

apps/cloud_federation_api/lib/ResponseDefinitions.php

@@ -26,15 +26,15 @@
 namespace OCA\CloudFederationAPI;
 
 /**
- * @psalm-type CloudFederationApiAddShare = array{
+ * @psalm-type CloudFederationAPIAddShare = array{
  *     recipientDisplayName: string,
  * }
  *
- * @psalm-type CloudFederationApiError = array{
+ * @psalm-type CloudFederationAPIError = array{
  *     message: string,
  * }
  *
- * @psalm-type CloudFederationApiValidationError = CloudFederationApiError&array{
+ * @psalm-type CloudFederationAPIValidationError = CloudFederationAPIError&array{
  *     validationErrors: array{
  *          name: string,
  *          message: string|null,

apps/files_external/lib/Controller/ApiController.php

@@ -40,7 +40,7 @@
 use OCP\IRequest;
 
 /**
- * @psalm-import-type FilesExternalMount from ResponseDefinitions
+ * @psalm-import-type Files_ExternalMount from ResponseDefinitions
  */
 class ApiController extends OCSController {
 
@@ -64,7 +64,7 @@ public function __construct(
 	 * @param string $mountPoint mount point name, relative to the data dir
 	 * @param StorageConfig $mountConfig mount config to format
 	 *
-	 * @return FilesExternalMount
+	 * @return Files_ExternalMount
 	 */
 	private function formatMount(string $mountPoint, StorageConfig $mountConfig): array {
 		// split path from mount point
@@ -100,7 +100,7 @@ private function formatMount(string $mountPoint, StorageConfig $mountConfig): ar
 	 *
 	 * Get the mount points visible for this user
 	 *
-	 * @return DataResponse<Http::STATUS_OK, FilesExternalMount[], array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_ExternalMount[], array{}>
 	 *
 	 * 200: User mounts returned
 	 */

apps/files_external/lib/Lib/StorageConfig.php

@@ -36,7 +36,7 @@
 /**
  * External storage configuration
  *
- * @psalm-import-type FilesExternalStorageConfig from ResponseDefinitions
+ * @psalm-import-type Files_ExternalStorageConfig from ResponseDefinitions
  */
 class StorageConfig implements \JsonSerializable {
 	public const MOUNT_TYPE_ADMIN = 1;
@@ -399,7 +399,7 @@ public function setType($type) {
 
 	/**
 	 * Serialize config to JSON
-	 * @return FilesExternalStorageConfig
+	 * @return Files_ExternalStorageConfig
 	 */
 	public function jsonSerialize(bool $obfuscate = false): array {
 		$result = [];

apps/files_external/lib/ResponseDefinitions.php

@@ -26,7 +26,7 @@
 namespace OCA\Files_External;
 
 /**
- * @psalm-type FilesExternalStorageConfig = array{
+ * @psalm-type Files_ExternalStorageConfig = array{
  *     applicableGroups?: string[],
  *     applicableUsers?: string[],
  *     authMechanism: string,
@@ -42,7 +42,7 @@
  *     userProvided: bool,
  * }
  *
- * @psalm-type FilesExternalMount = array{
+ * @psalm-type Files_ExternalMount = array{
  *     name: string,
  *     path: string,
  *     type: 'dir',
@@ -51,7 +51,7 @@
  *     permissions: int,
  *     id: int,
  *     class: string,
- *     config: FilesExternalStorageConfig,
+ *     config: Files_ExternalStorageConfig,
  * }
  */
 class ResponseDefinitions {

apps/files_sharing/lib/Controller/DeletedShareAPIController.php

@@ -51,7 +51,7 @@
 use OCP\Share\IShare;
 
 /**
- * @psalm-import-type FilesSharingDeletedShare from ResponseDefinitions
+ * @psalm-import-type Files_SharingDeletedShare from ResponseDefinitions
  */
 class DeletedShareAPIController extends OCSController {
 
@@ -99,7 +99,7 @@ public function __construct(string $appName,
 	/**
 	 * @suppress PhanUndeclaredClassMethod
 	 *
-	 * @return FilesSharingDeletedShare
+	 * @return Files_SharingDeletedShare
 	 */
 	private function formatShare(IShare $share): array {
 		$result = [
@@ -187,7 +187,7 @@ private function formatShare(IShare $share): array {
 	 *
 	 * Get a list of all deleted shares
 	 *
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingDeletedShare[], array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingDeletedShare[], array{}>
 	 *
 	 * 200: Deleted shares returned
 	 */

apps/files_sharing/lib/Controller/RemoteController.php

@@ -35,7 +35,7 @@
 use Psr\Log\LoggerInterface;
 
 /**
- * @psalm-import-type FilesSharingRemoteShare from ResponseDefinitions
+ * @psalm-import-type Files_SharingRemoteShare from ResponseDefinitions
  */
 class RemoteController extends OCSController {
 	/**
@@ -61,7 +61,7 @@ public function __construct(
 	 *
 	 * Get list of pending remote shares
 	 *
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingRemoteShare[], array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingRemoteShare[], array{}>
 	 *
 	 * 200: Pending remote shares returned
 	 */
@@ -139,7 +139,7 @@ private static function extendShareInfo($share) {
 	 *
 	 * Get a list of accepted remote shares
 	 *
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingRemoteShare[], array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingRemoteShare[], array{}>
 	 *
 	 * 200: Accepted remote shares returned
 	 */
@@ -156,7 +156,7 @@ public function getShares() {
 	 * Get info of a remote share
 	 *
 	 * @param int $id ID of the share
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingRemoteShare, array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingRemoteShare, array{}>
 	 * @throws OCSNotFoundException Share not found
 	 *
 	 * 200: Share returned

apps/files_sharing/lib/Controller/ShareAPIController.php

@@ -91,7 +91,7 @@
 /**
  * @package OCA\Files_Sharing\API
  *
- * @psalm-import-type FilesSharingShare from ResponseDefinitions
+ * @psalm-import-type Files_SharingShare from ResponseDefinitions
  */
 class ShareAPIController extends OCSController {
 
@@ -177,7 +177,7 @@ public function __construct(
 	 *
 	 * @param \OCP\Share\IShare $share
 	 * @param Node|null $recipientNode
-	 * @return FilesSharingShare
+	 * @return Files_SharingShare
 	 * @throws NotFoundException In case the node can't be resolved.
 	 *
 	 * @suppress PhanUndeclaredClassMethod
@@ -508,7 +508,7 @@ private function getCachedFederatedDisplayName(string $userId, bool $cacheOnly =
 	 *
 	 * @param string $id ID of the share
 	 * @param bool $include_tags Include tags in the share
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingShare, array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingShare, array{}>
 	 * @throws OCSNotFoundException Share not found
 	 *
 	 * 200: Share returned
@@ -602,7 +602,7 @@ public function deleteShare(string $id): DataResponse {
 	 * @param string $label Label for the share (only used in link and email)
 	 * @param string|null $attributes Additional attributes for the share
 	 *
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingShare, array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingShare, array{}>
 	 * @throws OCSBadRequestException Unknown share type
 	 * @throws OCSException
 	 * @throws OCSForbiddenException Creating the share is not allowed
@@ -879,7 +879,7 @@ public function createShare(
 	 * @param null|Node $node
 	 * @param boolean $includeTags
 	 *
-	 * @return FilesSharingShare[]
+	 * @return Files_SharingShare[]
 	 */
 	private function getSharedWithMe($node, bool $includeTags): array {
 		$userShares = $this->shareManager->getSharedWith($this->currentUser, IShare::TYPE_USER, $node, -1, 0);
@@ -916,7 +916,7 @@ private function getSharedWithMe($node, bool $includeTags): array {
 	/**
 	 * @param \OCP\Files\Node $folder
 	 *
-	 * @return FilesSharingShare[]
+	 * @return Files_SharingShare[]
 	 * @throws OCSBadRequestException
 	 * @throws NotFoundException
 	 */
@@ -978,7 +978,7 @@ private function getSharesInDir(Node $folder): array {
 	 * @param string $path Get shares for a specific path
 	 * @param string $include_tags Include tags in the share
 	 *
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingShare[], array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingShare[], array{}>
 	 * @throws OCSNotFoundException The folder was not found or is inaccessible
 	 *
 	 * 200: Shares returned
@@ -1026,7 +1026,7 @@ public function getShares(
 	 * @param bool $subFiles
 	 * @param bool $includeTags
 	 *
-	 * @return FilesSharingShare[]
+	 * @return Files_SharingShare[]
 	 * @throws NotFoundException
 	 * @throws OCSBadRequestException
 	 */
@@ -1111,7 +1111,7 @@ private function getFormattedShares(
 	 *
 	 * @param string $path Path all shares will be relative to
 	 *
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingShare[], array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingShare[], array{}>
 	 * @throws InvalidPathException
 	 * @throws NotFoundException
 	 * @throws OCSNotFoundException The given path is invalid
@@ -1213,7 +1213,7 @@ private function hasPermission(int $permissionsSet, int $permissionsToCheck): bo
 	 * @param string|null $label New label
 	 * @param string|null $hideDownload New condition if the download should be hidden
 	 * @param string|null $attributes New additional attributes
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingShare, array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingShare, array{}>
 	 * @throws OCSBadRequestException Share could not be updated because the requested changes are invalid
 	 * @throws OCSForbiddenException Missing permissions to update the share
 	 * @throws OCSNotFoundException Share not found
@@ -1409,7 +1409,7 @@ public function updateShare(
 	 *
 	 * Get all shares that are still pending
 	 *
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingShare[], array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingShare[], array{}>
 	 *
 	 * 200: Pending shares returned
 	 */

apps/files_sharing/lib/Controller/ShareInfoController.php

@@ -38,7 +38,7 @@
 use OCP\Share\IManager;
 
 /**
- * @psalm-import-type FilesSharingShareInfo from ResponseDefinitions
+ * @psalm-import-type Files_SharingShareInfo from ResponseDefinitions
  */
 class ShareInfoController extends ApiController {
 
@@ -71,7 +71,7 @@ public function __construct(string $appName,
 	 * @param string|null $password Password of the share
 	 * @param string|null $dir Subdirectory to get info about
 	 * @param int $depth Maximum depth to get info about
-	 * @return JSONResponse<Http::STATUS_OK, FilesSharingShareInfo, array{}>|JSONResponse<Http::STATUS_FORBIDDEN|Http::STATUS_NOT_FOUND, array<empty>, array{}>
+	 * @return JSONResponse<Http::STATUS_OK, Files_SharingShareInfo, array{}>|JSONResponse<Http::STATUS_FORBIDDEN|Http::STATUS_NOT_FOUND, array<empty>, array{}>
 	 *
 	 * 200: Share info returned
 	 * 403: Getting share info is not allowed
@@ -112,7 +112,7 @@ public function info(string $t, ?string $password = null, ?string $dir = null, i
 	}
 
 	/**
-	 * @return FilesSharingShareInfo
+	 * @return Files_SharingShareInfo
 	 */
 	private function parseNode(Node $node, int $permissionMask, int $depth): array {
 		if ($node instanceof File) {
@@ -123,14 +123,14 @@ private function parseNode(Node $node, int $permissionMask, int $depth): array {
 	}
 
 	/**
-	 * @return FilesSharingShareInfo
+	 * @return Files_SharingShareInfo
 	 */
 	private function parseFile(File $file, int $permissionMask): array {
 		return $this->format($file, $permissionMask);
 	}
 
 	/**
-	 * @return FilesSharingShareInfo
+	 * @return Files_SharingShareInfo
 	 */
 	private function parseFolder(Folder $folder, int $permissionMask, int $depth): array {
 		$data = $this->format($folder, $permissionMask);
@@ -150,7 +150,7 @@ private function parseFolder(Folder $folder, int $permissionMask, int $depth): a
 	}
 
 	/**
-	 * @return FilesSharingShareInfo
+	 * @return Files_SharingShareInfo
 	 */
 	private function format(Node $node, int $permissionMask): array {
 		$entry = [];

apps/files_sharing/lib/Controller/ShareesAPIController.php

@@ -59,8 +59,8 @@
 use function usort;
 
 /**
- * @psalm-import-type FilesSharingShareesSearchResult from ResponseDefinitions
- * @psalm-import-type FilesSharingShareesRecommendedResult from ResponseDefinitions
+ * @psalm-import-type Files_SharingShareesSearchResult from ResponseDefinitions
+ * @psalm-import-type Files_SharingShareesRecommendedResult from ResponseDefinitions
  */
 class ShareesAPIController extends OCSController {
 
@@ -82,7 +82,7 @@ class ShareesAPIController extends OCSController {
 	/** @var int */
 	protected $limit = 10;
 
-	/** @var FilesSharingShareesSearchResult */
+	/** @var Files_SharingShareesSearchResult */
 	protected $result = [
 		'exact' => [
 			'users' => [],
@@ -145,7 +145,7 @@ public function __construct(
 	 * @param int $perPage Limit amount of search results per page
 	 * @param int|int[]|null $shareType Limit to specific share types
 	 * @param bool $lookup If a global lookup should be performed too
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingShareesSearchResult, array{Link?: string}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingShareesSearchResult, array{Link?: string}>
 	 * @throws OCSBadRequestException Invalid search parameters
 	 *
 	 * 200: Sharees search result returned
@@ -347,7 +347,7 @@ private function getAllSharees(string $user, array $shareTypes): ISearchResult {
 	 *
 	 * @param string $itemType Limit to specific item types
 	 * @param int|int[]|null $shareType Limit to specific share types
-	 * @return DataResponse<Http::STATUS_OK, FilesSharingShareesRecommendedResult, array{}>
+	 * @return DataResponse<Http::STATUS_OK, Files_SharingShareesRecommendedResult, array{}>
 	 *
 	 * 200: Recommended sharees returned
 	 */