From ab0f23d90c33dbae2bda7fe3ebbfd117f5209a05 Mon Sep 17 00:00:00 2001 From: Julian Date: Fri, 8 Sep 2023 12:47:29 +0200 Subject: [PATCH] Fix PHPDoc types for other enums --- lib/Api/FilesApi.php | 10 ++++----- lib/Api/ModsApi.php | 30 ++++++++++++------------- lib/Model/File.php | 2 ++ lib/Model/FileHash.php | 6 +++-- lib/Model/FileIndex.php | 8 +++++-- lib/Model/MinecraftGameVersion.php | 6 +++-- lib/Model/MinecraftModLoaderIndex.php | 6 +++-- lib/Model/MinecraftModLoaderVersion.php | 24 +++++++++++++------- lib/Model/Mod.php | 4 ++-- 9 files changed, 58 insertions(+), 38 deletions(-) diff --git a/lib/Api/FilesApi.php b/lib/Api/FilesApi.php index ca7bf18..c298571 100644 --- a/lib/Api/FilesApi.php +++ b/lib/Api/FilesApi.php @@ -1352,7 +1352,7 @@ public function getModFileDownloadURLRequest($mod_id, $file_id, string $contentT * * @param int $mod_id The mod id the files belong to (required) * @param string $game_version Filter by game version string (optional) - * @param ModLoaderType $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional) + * @param int $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional) * @param int $game_version_type_id Filter only files that are tagged with versions of the given gameVersionTypeId (optional) * @param int $index A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000). (optional) * @param int $page_size The number of items to include in the response, the default/maximum value is 50. (optional) @@ -1375,7 +1375,7 @@ public function getModFiles($mod_id, $game_version = null, $mod_loader_type = nu * * @param int $mod_id The mod id the files belong to (required) * @param string $game_version Filter by game version string (optional) - * @param ModLoaderType $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional) + * @param int $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional) * @param int $game_version_type_id Filter only files that are tagged with versions of the given gameVersionTypeId (optional) * @param int $index A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000). (optional) * @param int $page_size The number of items to include in the response, the default/maximum value is 50. (optional) @@ -1480,7 +1480,7 @@ public function getModFilesWithHttpInfo($mod_id, $game_version = null, $mod_load * * @param int $mod_id The mod id the files belong to (required) * @param string $game_version Filter by game version string (optional) - * @param ModLoaderType $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional) + * @param int $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional) * @param int $game_version_type_id Filter only files that are tagged with versions of the given gameVersionTypeId (optional) * @param int $index A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000). (optional) * @param int $page_size The number of items to include in the response, the default/maximum value is 50. (optional) @@ -1506,7 +1506,7 @@ function ($response) { * * @param int $mod_id The mod id the files belong to (required) * @param string $game_version Filter by game version string (optional) - * @param ModLoaderType $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional) + * @param int $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional) * @param int $game_version_type_id Filter only files that are tagged with versions of the given gameVersionTypeId (optional) * @param int $index A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000). (optional) * @param int $page_size The number of items to include in the response, the default/maximum value is 50. (optional) @@ -1561,7 +1561,7 @@ function ($exception) { * * @param int $mod_id The mod id the files belong to (required) * @param string $game_version Filter by game version string (optional) - * @param ModLoaderType $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional) + * @param int $mod_loader_type ModLoaderType enumeration Filter only files associated to a given modloader (Forge, Fabric ...). (optional) * @param int $game_version_type_id Filter only files that are tagged with versions of the given gameVersionTypeId (optional) * @param int $index A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000). (optional) * @param int $page_size The number of items to include in the response, the default/maximum value is 50. (optional) diff --git a/lib/Api/ModsApi.php b/lib/Api/ModsApi.php index b40de83..728af00 100644 --- a/lib/Api/ModsApi.php +++ b/lib/Api/ModsApi.php @@ -1294,9 +1294,9 @@ public function getModsRequest($get_mods_by_ids_list_request_body, string $conte * @param int $category_id Filter by category id (optional) * @param string $game_version Filter by game version string (optional) * @param string $search_filter Filter by free text search in the mod name and author (optional) - * @param ModsSearchSortField $sort_field Filter by ModsSearchSortField enumeration (optional) - * @param SortOrder $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional) - * @param ModLoaderType $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional) + * @param int $sort_field Filter by ModsSearchSortField enumeration (optional) + * @param string $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional) + * @param int $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional) * @param int $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional) * @param int $author_id Filter only mods that the given authorId is a member of. (optional) * @param string $slug Filter by slug (coupled with classId will result in a unique result). (optional) @@ -1324,9 +1324,9 @@ public function searchMods($game_id, $class_id = null, $category_id = null, $gam * @param int $category_id Filter by category id (optional) * @param string $game_version Filter by game version string (optional) * @param string $search_filter Filter by free text search in the mod name and author (optional) - * @param ModsSearchSortField $sort_field Filter by ModsSearchSortField enumeration (optional) - * @param SortOrder $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional) - * @param ModLoaderType $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional) + * @param int $sort_field Filter by ModsSearchSortField enumeration (optional) + * @param string $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional) + * @param int $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional) * @param int $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional) * @param int $author_id Filter only mods that the given authorId is a member of. (optional) * @param string $slug Filter by slug (coupled with classId will result in a unique result). (optional) @@ -1436,9 +1436,9 @@ public function searchModsWithHttpInfo($game_id, $class_id = null, $category_id * @param int $category_id Filter by category id (optional) * @param string $game_version Filter by game version string (optional) * @param string $search_filter Filter by free text search in the mod name and author (optional) - * @param ModsSearchSortField $sort_field Filter by ModsSearchSortField enumeration (optional) - * @param SortOrder $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional) - * @param ModLoaderType $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional) + * @param int $sort_field Filter by ModsSearchSortField enumeration (optional) + * @param string $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional) + * @param int $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional) * @param int $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional) * @param int $author_id Filter only mods that the given authorId is a member of. (optional) * @param string $slug Filter by slug (coupled with classId will result in a unique result). (optional) @@ -1469,9 +1469,9 @@ function ($response) { * @param int $category_id Filter by category id (optional) * @param string $game_version Filter by game version string (optional) * @param string $search_filter Filter by free text search in the mod name and author (optional) - * @param ModsSearchSortField $sort_field Filter by ModsSearchSortField enumeration (optional) - * @param SortOrder $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional) - * @param ModLoaderType $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional) + * @param int $sort_field Filter by ModsSearchSortField enumeration (optional) + * @param string $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional) + * @param int $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional) * @param int $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional) * @param int $author_id Filter only mods that the given authorId is a member of. (optional) * @param string $slug Filter by slug (coupled with classId will result in a unique result). (optional) @@ -1531,9 +1531,9 @@ function ($exception) { * @param int $category_id Filter by category id (optional) * @param string $game_version Filter by game version string (optional) * @param string $search_filter Filter by free text search in the mod name and author (optional) - * @param ModsSearchSortField $sort_field Filter by ModsSearchSortField enumeration (optional) - * @param SortOrder $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional) - * @param ModLoaderType $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional) + * @param int $sort_field Filter by ModsSearchSortField enumeration (optional) + * @param string $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional) + * @param int $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional) * @param int $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional) * @param int $author_id Filter only mods that the given authorId is a member of. (optional) * @param string $slug Filter by slug (coupled with classId will result in a unique result). (optional) diff --git a/lib/Model/File.php b/lib/Model/File.php index 839aa3a..c5de43a 100644 --- a/lib/Model/File.php +++ b/lib/Model/File.php @@ -622,6 +622,7 @@ public function setFileName($file_name) /** * Gets release_type * + * @see FileReleaseType * @return int|null */ public function getReleaseType() @@ -632,6 +633,7 @@ public function getReleaseType() /** * Sets release_type * + * @see FileReleaseType * @param int|null $release_type release_type * * @return self diff --git a/lib/Model/FileHash.php b/lib/Model/FileHash.php index 0224934..fb10ea0 100644 --- a/lib/Model/FileHash.php +++ b/lib/Model/FileHash.php @@ -326,7 +326,8 @@ public function setValue($value) /** * Gets algo * - * @return \Aternos\CurseForgeApi\Model\HashAlgo|null + * @see HashAlgo + * @return int|null */ public function getAlgo() { @@ -336,7 +337,8 @@ public function getAlgo() /** * Sets algo * - * @param \Aternos\CurseForgeApi\Model\HashAlgo|null $algo algo + * @see HashAlgo + * @param int|null $algo algo * * @return self */ diff --git a/lib/Model/FileIndex.php b/lib/Model/FileIndex.php index 48d04b5..96654ff 100644 --- a/lib/Model/FileIndex.php +++ b/lib/Model/FileIndex.php @@ -408,6 +408,7 @@ public function setFilename($filename) /** * Gets release_type * + * @see FileReleaseType * @return int|null */ public function getReleaseType() @@ -418,6 +419,7 @@ public function getReleaseType() /** * Sets release_type * + * @see FileReleaseType * @param int|null $release_type release_type * * @return self @@ -469,7 +471,8 @@ public function setGameVersionTypeId($game_version_type_id) /** * Gets mod_loader * - * @return \Aternos\CurseForgeApi\Model\ModLoaderType|null + * @see ModLoaderType + * @return int|null */ public function getModLoader() { @@ -479,7 +482,8 @@ public function getModLoader() /** * Sets mod_loader * - * @param \Aternos\CurseForgeApi\Model\ModLoaderType|null $mod_loader mod_loader + * @see ModLoaderType + * @param int|null $mod_loader mod_loader * * @return self */ diff --git a/lib/Model/MinecraftGameVersion.php b/lib/Model/MinecraftGameVersion.php index 59e76da..ecdb642 100644 --- a/lib/Model/MinecraftGameVersion.php +++ b/lib/Model/MinecraftGameVersion.php @@ -598,7 +598,8 @@ public function setGameVersionStatus($game_version_status) /** * Gets game_version_type_status * - * @return \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null + * @see GameVersionTypeStatus + * @return int|null */ public function getGameVersionTypeStatus() { @@ -608,7 +609,8 @@ public function getGameVersionTypeStatus() /** * Sets game_version_type_status * - * @param \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null $game_version_type_status game_version_type_status + * @see GameVersionTypeStatus + * @param int|null $game_version_type_status game_version_type_status * * @return self */ diff --git a/lib/Model/MinecraftModLoaderIndex.php b/lib/Model/MinecraftModLoaderIndex.php index 3da0770..86a4909 100644 --- a/lib/Model/MinecraftModLoaderIndex.php +++ b/lib/Model/MinecraftModLoaderIndex.php @@ -462,7 +462,8 @@ public function setDateModified($date_modified) /** * Gets type * - * @return \Aternos\CurseForgeApi\Model\ModLoaderType|null + * @see ModLoaderType + * @return int|null */ public function getType() { @@ -472,7 +473,8 @@ public function getType() /** * Sets type * - * @param \Aternos\CurseForgeApi\Model\ModLoaderType|null $type type + * @see ModLoaderType + * @param int|null $type type * * @return self */ diff --git a/lib/Model/MinecraftModLoaderVersion.php b/lib/Model/MinecraftModLoaderVersion.php index 122ea82..93e5877 100644 --- a/lib/Model/MinecraftModLoaderVersion.php +++ b/lib/Model/MinecraftModLoaderVersion.php @@ -609,7 +609,8 @@ public function setName($name) /** * Gets type * - * @return \Aternos\CurseForgeApi\Model\ModLoaderType|null + * @see ModLoaderType + * @return int|null */ public function getType() { @@ -619,7 +620,8 @@ public function getType() /** * Sets type * - * @param \Aternos\CurseForgeApi\Model\ModLoaderType|null $type type + * @see ModLoaderType + * @param int|null $type type * * @return self */ @@ -690,7 +692,8 @@ public function setFilename($filename) /** * Gets install_method * - * @return \Aternos\CurseForgeApi\Model\ModLoaderInstallMethod|null + * @see ModLoaderInstallMethod + * @return int|null */ public function getInstallMethod() { @@ -700,7 +703,8 @@ public function getInstallMethod() /** * Sets install_method * - * @param \Aternos\CurseForgeApi\Model\ModLoaderInstallMethod|null $install_method install_method + * @see ModLoaderInstallMethod + * @param int|null $install_method install_method * * @return self */ @@ -1041,7 +1045,8 @@ public function setModLoaderGameVersionStatus($mod_loader_game_version_status) /** * Gets mod_loader_game_version_type_status * - * @return \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null + * @see GameVersionTypeStatus + * @return int|null */ public function getModLoaderGameVersionTypeStatus() { @@ -1051,7 +1056,8 @@ public function getModLoaderGameVersionTypeStatus() /** * Sets mod_loader_game_version_type_status * - * @param \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null $mod_loader_game_version_type_status mod_loader_game_version_type_status + * @see GameVersionTypeStatus + * @param int|null $mod_loader_game_version_type_status mod_loader_game_version_type_status * * @return self */ @@ -1149,7 +1155,8 @@ public function setMcGameVersionStatus($mc_game_version_status) /** * Gets mc_game_version_type_status * - * @return \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null + * @see GameVersionTypeStatus + * @return int|null */ public function getMcGameVersionTypeStatus() { @@ -1159,7 +1166,8 @@ public function getMcGameVersionTypeStatus() /** * Sets mc_game_version_type_status * - * @param \Aternos\CurseForgeApi\Model\GameVersionTypeStatus|null $mc_game_version_type_status mc_game_version_type_status + * @see GameVersionTypeStatus + * @param int|null $mc_game_version_type_status mc_game_version_type_status * * @return self */ diff --git a/lib/Model/Mod.php b/lib/Model/Mod.php index 3a51a82..4236821 100644 --- a/lib/Model/Mod.php +++ b/lib/Model/Mod.php @@ -622,7 +622,7 @@ public function setSummary($summary) /** * Gets status * - * @return \Aternos\CurseForgeApi\Model\ModStatus|null + * @return int|null */ public function getStatus() { @@ -632,7 +632,7 @@ public function getStatus() /** * Sets status * - * @param \Aternos\CurseForgeApi\Model\ModStatus|null $status status + * @param int|null $status status * * @return self */