HummingBirdAnimeClient/src/AnimeClient/Model/Anime.php

98 lines
1.9 KiB
PHP
Raw Normal View History

2016-10-20 22:09:36 -04:00
<?php declare(strict_types=1);
/**
2017-02-15 16:13:32 -05:00
* Hummingbird Anime List Client
2015-11-16 11:40:01 -05:00
*
2018-08-22 13:48:27 -04:00
* An API client for Kitsu to manage anime and manga watch lists
2015-11-16 11:40:01 -05:00
*
2021-02-04 11:57:01 -05:00
* PHP version 8
2016-08-30 10:01:18 -04:00
*
2022-03-04 15:50:35 -05:00
* @copyright 2015 - 2022 Timothy J. Warren <tim@timshome.page>
2017-01-06 23:34:56 -05:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
2020-12-10 17:06:50 -05:00
* @version 5.2
2022-03-04 15:50:35 -05:00
* @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\AnimeClient\Model;
2017-03-01 22:07:51 -05:00
use Aviat\AnimeClient\API\Mapping\AnimeWatchingStatus;
2022-01-07 12:33:01 -05:00
use Aviat\AnimeClient\Types\Anime as AnimeType;
2019-12-09 14:34:23 -05:00
2015-05-22 12:36:26 -04:00
/**
* Model for handling requests dealing with the anime list
*/
class Anime extends API
{
use MediaTrait;
protected string $type = 'anime';
2016-12-21 12:46:20 -05:00
2015-05-22 12:36:26 -04:00
/**
* Get a category out of the full list
*
* @return array<string, mixed>
2015-05-22 12:36:26 -04:00
*/
2020-10-21 18:52:12 -04:00
public function getList(string $status): array
2015-05-22 12:36:26 -04:00
{
$data = $this->kitsuModel->getAnimeList($status);
$this->sortByName($data, 'anime');
2015-05-22 12:36:26 -04:00
2017-03-01 22:07:51 -05:00
$key = AnimeWatchingStatus::KITSU_TO_TITLE[$status];
2015-05-22 12:36:26 -04:00
$output = [];
2017-03-01 22:07:51 -05:00
$output[$key] = $data;
2015-05-22 12:36:26 -04:00
return $output;
}
/**
* Get data for the 'all' anime page
*
* @return mixed[]
*/
public function getAllLists(): array
2017-03-07 17:51:08 -05:00
{
$data = $this->kitsuModel->getFullOrganizedAnimeList();
2017-03-07 17:51:08 -05:00
foreach ($data as &$list)
2017-03-07 17:51:08 -05:00
{
$this->sortByName($list, 'anime');
}
return $data;
}
/**
2017-01-16 13:49:51 -05:00
* Get information about an anime from its slug
*/
2018-11-09 10:38:35 -05:00
public function getAnime(string $slug): AnimeType
{
2017-01-16 13:49:51 -05:00
return $this->kitsuModel->getAnime($slug);
}
2017-02-04 15:18:34 -05:00
/**
* Get information about a random anime
*/
public function getRandomAnime(): AnimeType
{
return $this->kitsuModel->getRandomAnime();
}
/**
* Get anime by its kitsu id
*/
2018-08-20 13:01:16 -04:00
public function getAnimeById(string $animeId): AnimeType
2017-01-16 13:49:51 -05:00
{
return $this->kitsuModel->getAnimeById($animeId);
}
2020-04-21 19:22:56 -04:00
/**
* Get recent watch history
*
* @return mixed[]
2020-04-21 19:22:56 -04:00
*/
public function getHistory(): array
{
return $this->kitsuModel->getAnimeHistory();
}
}