HummingBirdAnimeClient/src/Model/Anime.php

258 lines
5.6 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
*
2018-10-01 11:35:51 -04:00
* PHP version 7.1
2016-08-30 10:01:18 -04:00
*
2017-02-15 16:13:32 -05:00
* @package HummingbirdAnimeClient
2017-01-06 23:34:56 -05:00
* @author Timothy J. Warren <tim@timshomepage.net>
2018-01-15 14:43:15 -05:00
* @copyright 2015 - 2018 Timothy J. Warren
2017-01-06 23:34:56 -05:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
2018-10-01 11:35:51 -04:00
* @version 4.1
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\AnimeClient\Model;
2017-02-20 13:37:08 -05:00
use Aviat\AnimeClient\API\ParallelAPIRequest;
2017-03-01 22:07:51 -05:00
use Aviat\AnimeClient\API\Mapping\AnimeWatchingStatus;
use Aviat\AnimeClient\Types\{
Anime as AnimeType,
2018-09-27 16:45:12 -04:00
FormItem,
2018-08-08 11:18:57 -04:00
AnimeListItem
};
2016-12-21 12:46:20 -05:00
use Aviat\Ion\Di\ContainerInterface;
2016-10-20 22:32:17 -04:00
use Aviat\Ion\Json;
2015-06-26 16:39:10 -04:00
2015-05-22 12:36:26 -04:00
/**
* Model for handling requests dealing with the anime list
*/
2018-08-08 13:05:38 -04:00
class Anime extends API {
2018-09-26 22:31:04 -04:00
/**
* Is the Anilist API enabled?
*
* @var boolean
*/
protected $anilistEnabled;
/**
* Model for making requests to Anilist API
*
* @var \Aviat\AnimeClient\API\Anilist\Model
*/
protected $anilistModel;
2017-02-17 10:55:17 -05:00
/**
* Model for making requests to Kitsu API
*
2017-02-22 14:46:35 -05:00
* @var \Aviat\AnimeClient\API\Kitsu\Model
2017-02-17 10:55:17 -05:00
*/
2017-02-04 15:18:34 -05:00
protected $kitsuModel;
/**
* Anime constructor.
2017-02-17 10:55:17 -05:00
*
* @param ContainerInterface $container
*/
2017-03-01 22:07:51 -05:00
public function __construct(ContainerInterface $container)
2017-02-17 10:55:17 -05:00
{
$this->anilistModel = $container->get('anilist-model');
$this->kitsuModel = $container->get('kitsu-model');
2018-09-26 22:31:04 -04:00
$config = $container->get('config');
$this->anilistEnabled = (bool) $config->get(['anilist', 'enabled']);
2016-12-21 12:46:20 -05:00
}
2015-05-22 12:36:26 -04:00
/**
* Get a category out of the full list
*
* @param string $status
2015-05-22 12:36:26 -04:00
* @return array
*/
public function getList($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 array
*/
public function getAllLists(): array
2017-03-07 17:51:08 -05:00
{
$data = $this->kitsuModel->getFullOrganizedAnimeList();
foreach($data as $section => &$list)
{
$this->sortByName($list, 'anime');
}
return $data;
}
/**
2017-01-16 13:49:51 -05:00
* Get information about an anime from its slug
*
2017-01-16 13:49:51 -05:00
* @param string $slug
* @return AnimeType
*/
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 anime by its kitsu id
*
* @param string $animeId
2018-08-20 13:01:16 -04:00
* @return AnimeType
*/
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);
}
/**
* Search for anime by name
*
* @param string $name
* @return array
*/
public function search(string $name): array
{
return $this->kitsuModel->search('anime', urldecode($name));
}
/**
* Get information about a specific list item
* for editing/updating that item
*
* @param string $itemId
* @return AnimeListItem
*/
public function getLibraryItem(string $itemId): AnimeListItem
{
$item = $this->kitsuModel->getListItem($itemId);
$array = $item->toArray();
2018-11-09 10:38:35 -05:00
if (\is_array($array['notes']))
{
$array['notes'] = '';
}
return new AnimeListItem($array);
}
2017-02-04 15:18:34 -05:00
/**
* Add an anime to your list
*
* @param array $data
* @return bool
*/
public function createLibraryItem(array $data): bool
{
2017-02-20 13:37:08 -05:00
$requester = new ParallelAPIRequest();
$requester->addRequest($this->kitsuModel->createListItem($data), 'kitsu');
2017-02-04 15:18:34 -05:00
2018-09-26 22:31:04 -04:00
if (array_key_exists('mal_id', $data) && $this->anilistEnabled)
{
$requester->addRequest($this->anilistModel->createListItem($data, 'ANIME'), 'anilist');
}
$results = $requester->makeRequests();
return count($results) > 0;
}
/**
* Increment progress for the specified anime
*
2018-09-27 16:45:12 -04:00
* @param FormItem $data
* @return array
*/
2018-09-27 16:45:12 -04:00
public function incrementLibraryItem(FormItem $data): array
{
$requester = new ParallelAPIRequest();
$requester->addRequest($this->kitsuModel->incrementListItem($data), 'kitsu');
$array = $data->toArray();
2018-09-26 22:31:04 -04:00
if (array_key_exists('mal_id', $array) && $this->anilistEnabled)
{
$requester->addRequest($this->anilistModel->incrementListItem($data, 'ANIME'), 'anilist');
}
$results = $requester->makeRequests();
$body = Json::decode($results['kitsu']);
$statusCode = array_key_exists('error', $body) ? 400 : 200;
return [
'body' => Json::decode($results['kitsu']),
'statusCode' => $statusCode
];
}
/**
* Update a list entry
*
2018-09-27 16:45:12 -04:00
* @param FormItem $data
* @return array
*/
2018-09-27 16:45:12 -04:00
public function updateLibraryItem(FormItem $data): array
{
2017-03-01 22:07:51 -05:00
$requester = new ParallelAPIRequest();
2017-02-20 13:37:08 -05:00
$requester->addRequest($this->kitsuModel->updateListItem($data), 'kitsu');
$array = $data->toArray();
2018-09-26 22:31:04 -04:00
if (array_key_exists('mal_id', $array) && $this->anilistEnabled)
{
2018-09-26 22:31:04 -04:00
$requester->addRequest($this->anilistModel->updateListItem($data, 'ANIME'), 'anilist');
}
$results = $requester->makeRequests();
$body = Json::decode($results['kitsu']);
$statusCode = array_key_exists('error', $body) ? 400: 200;
2017-03-01 22:07:51 -05:00
return [
'body' => Json::decode($results['kitsu']),
'statusCode' => $statusCode
];
}
2017-02-04 15:18:34 -05:00
/**
* Delete a list entry
*
* @param string $id
* @param string|null $malId
* @return bool
*/
2017-02-17 10:55:17 -05:00
public function deleteLibraryItem(string $id, string $malId = NULL): bool
{
2017-02-20 13:37:08 -05:00
$requester = new ParallelAPIRequest();
$requester->addRequest($this->kitsuModel->deleteListItem($id), 'kitsu');
2018-09-26 22:31:04 -04:00
if ($malId !== null && $this->anilistEnabled)
{
$requester->addRequest($this->anilistModel->deleteListItem($malId, 'ANIME'), 'anilist');
}
$results = $requester->makeRequests();
return count($results) > 0;
}
2017-03-07 17:51:08 -05:00
}