From 698025146f5a00d97b357e677b795d62537c6ba3 Mon Sep 17 00:00:00 2001 From: Timothy J Warren Date: Mon, 9 Dec 2019 14:41:04 -0500 Subject: [PATCH] Automatically fix some docblocks --- build/update_header_comments.php | 4 ++-- src/API/Anilist/Model.php | 3 ++- src/API/Kitsu/Transformer/CharacterTransformer.php | 5 ++++- src/API/Kitsu/Transformer/PersonTransformer.php | 2 +- src/API/Kitsu/Transformer/UserTransformer.php | 4 ++-- src/Model/AnimeCollection.php | 7 +++++++ 6 files changed, 18 insertions(+), 7 deletions(-) diff --git a/build/update_header_comments.php b/build/update_header_comments.php index 58e9c9eb..e5bf9191 100644 --- a/build/update_header_comments.php +++ b/build/update_header_comments.php @@ -29,7 +29,7 @@ if ( ! function_exists('glob_recursive')) } } -function get_text_to_replace($tokens) +function get_text_to_replace(array $tokens): string { $output = ''; @@ -57,7 +57,7 @@ function get_text_to_replace($tokens) return $output; } -function get_tokens($source) +function get_tokens($source): array { return token_get_all($source); } diff --git a/src/API/Anilist/Model.php b/src/API/Anilist/Model.php index e8a78578..62aebb93 100644 --- a/src/API/Anilist/Model.php +++ b/src/API/Anilist/Model.php @@ -179,7 +179,8 @@ final class Model * * @param string $malId - The unique identifier of that list item * @param string $type - Them media type (anime/manga) - * @return mixed + * + * @return array */ public function getListItem(string $malId, string $type): array { diff --git a/src/API/Kitsu/Transformer/CharacterTransformer.php b/src/API/Kitsu/Transformer/CharacterTransformer.php index c6d6ebd5..963fcf03 100644 --- a/src/API/Kitsu/Transformer/CharacterTransformer.php +++ b/src/API/Kitsu/Transformer/CharacterTransformer.php @@ -26,7 +26,10 @@ use Aviat\Ion\Transformer\AbstractTransformer; */ final class CharacterTransformer extends AbstractTransformer { - public function transform($characterData): Character + /** + * @param array $characterData + */ + public function transform(array $characterData): Character { $data = JsonAPI::organizeData($characterData); $attributes = $data[0]['attributes']; diff --git a/src/API/Kitsu/Transformer/PersonTransformer.php b/src/API/Kitsu/Transformer/PersonTransformer.php index b83fa6b9..e07876f0 100644 --- a/src/API/Kitsu/Transformer/PersonTransformer.php +++ b/src/API/Kitsu/Transformer/PersonTransformer.php @@ -25,7 +25,7 @@ use Aviat\Ion\Transformer\AbstractTransformer; */ final class PersonTransformer extends AbstractTransformer { - public function transform($personData): Person + public function transform(array $personData): Person { $data = JsonAPI::organizeData($personData); $included = JsonAPI::organizeIncludes($personData['included']); diff --git a/src/API/Kitsu/Transformer/UserTransformer.php b/src/API/Kitsu/Transformer/UserTransformer.php index 051d40c3..96e58578 100644 --- a/src/API/Kitsu/Transformer/UserTransformer.php +++ b/src/API/Kitsu/Transformer/UserTransformer.php @@ -26,7 +26,7 @@ use Aviat\Ion\Transformer\AbstractTransformer; * Transform user profile data for display */ final class UserTransformer extends AbstractTransformer { - public function transform($profileData): User + public function transform(array $profileData): User { $orgData = JsonAPI::organizeData($profileData)[0]; $attributes = $orgData['attributes']; @@ -132,7 +132,7 @@ final class UserTransformer extends AbstractTransformer { return $output; } - private function organizeStats($stats, $data = []): array + private function organizeStats(array $stats, $data = []): array { $animeStats = []; $mangaStats = []; diff --git a/src/Model/AnimeCollection.php b/src/Model/AnimeCollection.php index 8cbb7d28..3fa620b8 100644 --- a/src/Model/AnimeCollection.php +++ b/src/Model/AnimeCollection.php @@ -167,6 +167,8 @@ final class AnimeCollection extends Collection { * Verify that an item was added * * @param $data + * @param array|null|object $data + * * @return bool */ public function wasAdded($data): bool @@ -205,6 +207,8 @@ final class AnimeCollection extends Collection { * Verify that the collection item was updated * * @param $data + * @param array|null|object $data + * * @return bool */ public function wasUpdated($data): bool @@ -243,6 +247,9 @@ final class AnimeCollection extends Collection { ->delete('anime_set'); } + /** + * @param array|null|object $data + */ public function wasDeleted($data): bool { $animeRow = $this->get($data['hummingbird_id']);