From 8de60b332dc45313d391a95979ed070d7ce33411 Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Tue, 23 Feb 2021 17:08:16 -0500 Subject: [PATCH] Remove redundant docblocks from Type classes --- src/AnimeClient/Types/Anime.php | 3 -- src/AnimeClient/Types/AnimeListItem.php | 3 -- src/AnimeClient/Types/Character.php | 3 -- src/AnimeClient/Types/Config/Anilist.php | 10 +--- src/AnimeClient/Types/Config/Cache.php | 5 +- src/AnimeClient/Types/Config/Database.php | 24 +-------- src/AnimeClient/Types/FormItem.php | 6 --- src/AnimeClient/Types/FormItemData.php | 25 ++------- src/AnimeClient/Types/MangaListItem.php | 51 ++++--------------- src/AnimeClient/Types/MangaListItemDetail.php | 40 +++------------ src/AnimeClient/Types/MangaPage.php | 48 ----------------- tests/AnimeClient/Types/ConfigTest.php | 1 - 12 files changed, 29 insertions(+), 190 deletions(-) diff --git a/src/AnimeClient/Types/Anime.php b/src/AnimeClient/Types/Anime.php index 115be3c5..3dc52c48 100644 --- a/src/AnimeClient/Types/Anime.php +++ b/src/AnimeClient/Types/Anime.php @@ -34,9 +34,6 @@ class Anime extends AbstractType { public array $genres = []; - /** - * @var string - */ public string $id = ''; public array $included = []; diff --git a/src/AnimeClient/Types/AnimeListItem.php b/src/AnimeClient/Types/AnimeListItem.php index 56d41c2d..08477118 100644 --- a/src/AnimeClient/Types/AnimeListItem.php +++ b/src/AnimeClient/Types/AnimeListItem.php @@ -46,9 +46,6 @@ final class AnimeListItem extends AbstractType { public int $rewatched = 0; - /** - * @var string|int - */ public string|int $user_rating = ''; /** diff --git a/src/AnimeClient/Types/Character.php b/src/AnimeClient/Types/Character.php index e68c4259..252d3823 100644 --- a/src/AnimeClient/Types/Character.php +++ b/src/AnimeClient/Types/Character.php @@ -24,9 +24,6 @@ final class Character extends AbstractType { public ?string $description; - /** - * @var string - */ public string $id; public array $included = []; diff --git a/src/AnimeClient/Types/Config/Anilist.php b/src/AnimeClient/Types/Config/Anilist.php index b81be659..a44133ad 100644 --- a/src/AnimeClient/Types/Config/Anilist.php +++ b/src/AnimeClient/Types/Config/Anilist.php @@ -19,10 +19,7 @@ namespace Aviat\AnimeClient\Types\Config; use Aviat\AnimeClient\Types\AbstractType; class Anilist extends AbstractType { - /** - * @var bool|string - */ - public $enabled = FALSE; + public bool|string $enabled = FALSE; public ?string $client_id; @@ -30,10 +27,7 @@ class Anilist extends AbstractType { public ?string $access_token; - /** - * @var int|string|null - */ - public $access_token_expires; + public int|string|null $access_token_expires; public ?string $refresh_token; diff --git a/src/AnimeClient/Types/Config/Cache.php b/src/AnimeClient/Types/Config/Cache.php index c8286fab..46b85145 100644 --- a/src/AnimeClient/Types/Config/Cache.php +++ b/src/AnimeClient/Types/Config/Cache.php @@ -23,10 +23,7 @@ class Cache extends AbstractType { public ?string $host; - /** - * @var string|int|null - */ - public $port; + public string|int|null $port; public ?string $database; diff --git a/src/AnimeClient/Types/Config/Database.php b/src/AnimeClient/Types/Config/Database.php index 1785eebd..07813bd2 100644 --- a/src/AnimeClient/Types/Config/Database.php +++ b/src/AnimeClient/Types/Config/Database.php @@ -19,38 +19,18 @@ namespace Aviat\AnimeClient\Types\Config; use Aviat\AnimeClient\Types\AbstractType; class Database extends AbstractType { - /** - * @var string - */ + public string $type = 'sqlite'; - /** - * @var string|null - */ public ?string $host; - /** - * @var string|null - */ public ?string $user; - /** - * @var string|null - */ public ?string $pass; - /** - * @var string|int|null - */ - public $port; + public string|int|null $port; - /** - * @var string|null - */ public ?string $database; - /** - * @var string|null - */ public ?string $file; } \ No newline at end of file diff --git a/src/AnimeClient/Types/FormItem.php b/src/AnimeClient/Types/FormItem.php index 47a0eb5a..ad1919da 100644 --- a/src/AnimeClient/Types/FormItem.php +++ b/src/AnimeClient/Types/FormItem.php @@ -20,14 +20,8 @@ namespace Aviat\AnimeClient\Types; * Type representing an Anime object for display */ class FormItem extends AbstractType { - /** - * @var string|int - */ public string|int $id; - /** - * @var string|int|null - */ public string|int|null $mal_id; public ?FormItemData $data; diff --git a/src/AnimeClient/Types/FormItemData.php b/src/AnimeClient/Types/FormItemData.php index 6dba7bc8..ed4bf94e 100644 --- a/src/AnimeClient/Types/FormItemData.php +++ b/src/AnimeClient/Types/FormItemData.php @@ -24,32 +24,17 @@ class FormItemData extends AbstractType { public ?bool $private = FALSE; - /** - * @var int - */ - public $progress; + public ?int $progress; - /** - * @var int - */ - public $rating; + public ?int $rating; - /** - * @var int - */ - public $ratingTwenty; + public ?int $ratingTwenty = NULL; - /** - * @var string|int - */ - public $reconsumeCount; + public string|int $reconsumeCount; public bool $reconsuming = FALSE; - /** - * @var string - */ - public $status; + public string $status; /** * W3C Format Date string diff --git a/src/AnimeClient/Types/MangaListItem.php b/src/AnimeClient/Types/MangaListItem.php index 226e9c93..97925955 100644 --- a/src/AnimeClient/Types/MangaListItem.php +++ b/src/AnimeClient/Types/MangaListItem.php @@ -20,60 +20,31 @@ namespace Aviat\AnimeClient\Types; * Type representing an Anime object for display */ final class MangaListItem extends AbstractType { - /** - * @var string - */ - public $id; - /** - * @var string - */ - public $mal_id; + public string $id; - /** - * @var array - */ - public $chapters = [ + public ?string $mal_id; + + public array $chapters = [ 'read' => 0, 'total' => 0, ]; - /** - * @var array - */ - public $volumes = [ + public array $volumes = [ 'read' => '-', 'total' => 0, ]; - /** - * @var object - */ - public $manga; + public object $manga; - /** - * @var string - */ - public $reading_status; + public string $reading_status; - /** - * @var string - */ - public $notes; + public ?string $notes; - /** - * @var bool - */ - public $rereading; + public bool $rereading = false; - /** - * @var int - */ - public $reread; + public ?int $reread; - /** - * @var int - */ - public $user_rating; + public string|int|null $user_rating; } diff --git a/src/AnimeClient/Types/MangaListItemDetail.php b/src/AnimeClient/Types/MangaListItemDetail.php index 07a8e1bc..e8c19980 100644 --- a/src/AnimeClient/Types/MangaListItemDetail.php +++ b/src/AnimeClient/Types/MangaListItemDetail.php @@ -20,43 +20,19 @@ namespace Aviat\AnimeClient\Types; * Type representing the manga represented by the list item */ final class MangaListItemDetail extends AbstractType { - /** - * @var array - */ - public $genres; + public array $genres = []; - /** - * @var string - */ - public $id; + public string $id; - /** - * @var string - */ - public $image; + public string $image; - /** - * @var string - */ - public $slug; + public string $slug; - /** - * @var string - */ - public $title; + public string $title; - /** - * @var array - */ - public $titles; + public array $titles; - /** - * @var string - */ - public $type; + public ?string $type; - /** - * @var string - */ - public $url; + public string $url; } diff --git a/src/AnimeClient/Types/MangaPage.php b/src/AnimeClient/Types/MangaPage.php index 08972090..48969b85 100644 --- a/src/AnimeClient/Types/MangaPage.php +++ b/src/AnimeClient/Types/MangaPage.php @@ -22,74 +22,32 @@ use Aviat\AnimeClient\API\Kitsu\Enum\MangaPublishingStatus; * Type representing an Anime object for display */ final class MangaPage extends AbstractType { - /** - * @var string|null - */ public ?string $age_rating; - /** - * @var string|null - */ public ?string $age_rating_guide; - /** - * @var array - */ public array $characters; - /** - * @var int|null - */ public ?int $chapter_count; - /** - * @var string|null - */ public ?string $cover_image; - /** - * @var array - */ public array $genres; - /** - * @var array - */ public array $links; - /** - * @var string - */ public string $id; - /** - * @var string - */ public string $manga_type; - /** - * @var string - */ public string $status = MangaPublishingStatus::FINISHED; - /** - * @var array - */ public array $staff; - /** - * @var string - */ public string $synopsis; - /** - * @var string - */ public string $title; - /** - * @var array - */ public array $titles; /** @@ -97,13 +55,7 @@ final class MangaPage extends AbstractType { */ public array $titles_more; - /** - * @var string - */ public string $url; - /** - * @var int|null - */ public ?int $volume_count; } diff --git a/tests/AnimeClient/Types/ConfigTest.php b/tests/AnimeClient/Types/ConfigTest.php index 76ae05e6..da1bb73d 100644 --- a/tests/AnimeClient/Types/ConfigTest.php +++ b/tests/AnimeClient/Types/ConfigTest.php @@ -17,7 +17,6 @@ namespace Aviat\AnimeClient\Tests\Types; use Aviat\AnimeClient\Types\Config; -use Aviat\AnimeClient\Types\UndefinedPropertyException; class ConfigTest extends ConfigTestCase { public function setUp(): void