2016-10-20 22:09:36 -04:00
|
|
|
<?php declare(strict_types=1);
|
2015-06-16 11:11:35 -04:00
|
|
|
/**
|
2017-02-15 16:13:32 -05:00
|
|
|
* Hummingbird Anime List Client
|
2015-11-16 11:40:01 -05:00
|
|
|
*
|
2016-12-20 12:58:37 -05:00
|
|
|
* An API client for Kitsu and MyAnimeList to manage anime and manga watch lists
|
2015-11-16 11:40:01 -05:00
|
|
|
*
|
2016-10-20 22:09:36 -04:00
|
|
|
* PHP version 7
|
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
|
|
|
|
* @version 4.0
|
2017-03-07 20:53:58 -05:00
|
|
|
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
|
2017-01-11 10:34:24 -05:00
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Aviat\AnimeClient\Model;
|
2015-09-14 10:54:50 -04:00
|
|
|
|
2017-03-28 14:36:23 -04:00
|
|
|
use Aviat\AnimeClient\API\{
|
|
|
|
Enum\MangaReadingStatus\Title,
|
|
|
|
Mapping\MangaReadingStatus,
|
|
|
|
ParallelAPIRequest
|
|
|
|
};
|
2018-08-08 13:05:38 -04:00
|
|
|
use Aviat\AnimeClient\Types\{
|
|
|
|
MangaFormItem,
|
|
|
|
MangaListItem,
|
|
|
|
MangaPage
|
|
|
|
};
|
2017-01-03 21:06:49 -05:00
|
|
|
use Aviat\Ion\Di\ContainerInterface;
|
2017-03-29 13:29:03 -04:00
|
|
|
use Aviat\Ion\Json;
|
2015-06-16 11:11:35 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Model for handling requests dealing with the manga list
|
|
|
|
*/
|
2018-08-08 13:05:38 -04:00
|
|
|
class Manga extends API {
|
2017-01-10 12:35:46 -05:00
|
|
|
/**
|
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-01-10 12:35:46 -05:00
|
|
|
*/
|
|
|
|
protected $kitsuModel;
|
2017-03-01 21:52:30 -05:00
|
|
|
|
2017-02-22 14:46:35 -05:00
|
|
|
/**
|
|
|
|
* Model for making requests to MAL API
|
|
|
|
* @var \Aviat\AnimeClient\API\MAL\Model
|
|
|
|
*/
|
|
|
|
protected $malModel;
|
2017-01-10 12:35:46 -05:00
|
|
|
|
2017-02-17 10:55:17 -05:00
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*
|
|
|
|
* @param ContainerInterface $container
|
2018-02-02 09:50:58 -05:00
|
|
|
* @throws \Aviat\Ion\Di\ContainerException
|
|
|
|
* @throws \Aviat\Ion\Di\NotFoundException
|
2017-02-17 10:55:17 -05:00
|
|
|
*/
|
2017-01-03 21:06:49 -05:00
|
|
|
public function __construct(ContainerInterface $container)
|
2017-01-04 13:16:58 -05:00
|
|
|
{
|
|
|
|
$this->kitsuModel = $container->get('kitsu-model');
|
2017-02-22 14:46:35 -05:00
|
|
|
$this->malModel = $container->get('mal-model');
|
2017-03-28 14:36:23 -04:00
|
|
|
|
|
|
|
$config = $container->get('config');
|
|
|
|
$this->useMALAPI = $config->get(['use_mal_api']) === TRUE;
|
2017-01-04 13:16:58 -05:00
|
|
|
}
|
2015-06-16 11:11:35 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a category out of the full list
|
|
|
|
*
|
|
|
|
* @param string $status
|
|
|
|
* @return array
|
|
|
|
*/
|
2018-02-02 09:50:58 -05:00
|
|
|
public function getList($status): array
|
2015-06-16 11:11:35 -04:00
|
|
|
{
|
2017-03-07 18:41:51 -05:00
|
|
|
if ($status === 'All')
|
|
|
|
{
|
2018-08-10 20:10:19 -04:00
|
|
|
$data = $this->kitsuModel->getFullOrganizedMangaList();
|
|
|
|
foreach($data as &$section)
|
|
|
|
{
|
|
|
|
$this->sortByName($section, 'manga');
|
|
|
|
}
|
|
|
|
|
|
|
|
return $data;
|
2017-03-07 18:41:51 -05:00
|
|
|
}
|
2017-03-28 14:36:23 -04:00
|
|
|
|
2017-03-01 21:52:30 -05:00
|
|
|
$APIstatus = MangaReadingStatus::TITLE_TO_KITSU[$status];
|
2018-08-10 20:10:19 -04:00
|
|
|
$data = $this->mapByStatus($this->kitsuModel->getMangaList($APIstatus));
|
|
|
|
$this->sortByName($data[$status], 'manga');
|
2018-08-08 13:05:38 -04:00
|
|
|
return $data[$status];
|
2015-10-05 16:54:25 -04:00
|
|
|
}
|
|
|
|
|
2016-04-14 17:51:00 -04:00
|
|
|
/**
|
|
|
|
* Get the details of a manga
|
|
|
|
*
|
|
|
|
* @param string $manga_id
|
2018-08-08 13:05:38 -04:00
|
|
|
* @return MangaPage
|
2016-04-14 17:51:00 -04:00
|
|
|
*/
|
2018-08-08 13:05:38 -04:00
|
|
|
public function getManga($manga_id): MangaPage
|
2016-04-14 17:51:00 -04:00
|
|
|
{
|
2017-01-04 13:16:58 -05:00
|
|
|
return $this->kitsuModel->getManga($manga_id);
|
2016-04-14 17:51:00 -04:00
|
|
|
}
|
|
|
|
|
2017-09-15 15:05:35 -04:00
|
|
|
/**
|
|
|
|
* Get anime by its kitsu id
|
|
|
|
*
|
|
|
|
* @param string $animeId
|
2018-08-08 13:05:38 -04:00
|
|
|
* @return MangaPage
|
2017-09-15 15:05:35 -04:00
|
|
|
*/
|
2018-08-08 13:05:38 -04:00
|
|
|
public function getMangaById(string $animeId): MangaPage
|
2017-09-15 15:05:35 -04:00
|
|
|
{
|
|
|
|
return $this->kitsuModel->getMangaById($animeId);
|
|
|
|
}
|
|
|
|
|
2017-01-05 22:24:45 -05:00
|
|
|
/**
|
|
|
|
* Get information about a specific list item
|
|
|
|
* for editing/updating that item
|
|
|
|
*
|
|
|
|
* @param string $itemId
|
2018-08-08 13:05:38 -04:00
|
|
|
* @return MangaListItem
|
2017-01-05 22:24:45 -05:00
|
|
|
*/
|
2018-08-08 13:05:38 -04:00
|
|
|
public function getLibraryItem(string $itemId): MangaListItem
|
2017-01-05 22:24:45 -05:00
|
|
|
{
|
|
|
|
return $this->kitsuModel->getListItem($itemId);
|
|
|
|
}
|
|
|
|
|
2017-03-29 13:29:03 -04:00
|
|
|
/**
|
|
|
|
* Create a new manga list item
|
|
|
|
*
|
|
|
|
* @param array $data
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function createLibraryItem(array $data): bool
|
|
|
|
{
|
|
|
|
$requester = new ParallelAPIRequest();
|
|
|
|
|
|
|
|
if ($this->useMALAPI)
|
|
|
|
{
|
|
|
|
$malData = $data;
|
|
|
|
$malId = $this->kitsuModel->getMalIdForManga($malData['id']);
|
|
|
|
|
2018-02-02 09:50:58 -05:00
|
|
|
if ($malId !== NULL)
|
2017-03-29 13:29:03 -04:00
|
|
|
{
|
|
|
|
$malData['id'] = $malId;
|
|
|
|
$requester->addRequest($this->malModel->createListItem($malData, 'manga'), 'mal');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$requester->addRequest($this->kitsuModel->createListItem($data), 'kitsu');
|
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
$results = $requester->makeRequests();
|
2017-03-29 13:29:03 -04:00
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
return count($results) > 0;
|
2017-03-29 13:29:03 -04:00
|
|
|
}
|
|
|
|
|
2017-01-09 20:36:48 -05:00
|
|
|
/**
|
|
|
|
* Update a list entry
|
|
|
|
*
|
2018-08-08 13:05:38 -04:00
|
|
|
* @param MangaFormItem $data
|
2017-01-09 20:36:48 -05:00
|
|
|
* @return array
|
|
|
|
*/
|
2018-08-08 13:05:38 -04:00
|
|
|
public function updateLibraryItem(MangaFormItem $data): array
|
2017-01-09 20:36:48 -05:00
|
|
|
{
|
2017-03-29 13:29:03 -04:00
|
|
|
$requester = new ParallelAPIRequest();
|
|
|
|
|
|
|
|
if ($this->useMALAPI)
|
|
|
|
{
|
|
|
|
$requester->addRequest($this->malModel->updateListItem($data, 'manga'), 'mal');
|
|
|
|
}
|
|
|
|
|
|
|
|
$requester->addRequest($this->kitsuModel->updateListItem($data), 'kitsu');
|
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
$results = $requester->makeRequests();
|
|
|
|
$body = Json::decode($results['kitsu']);
|
2018-02-02 09:50:58 -05:00
|
|
|
$statusCode = array_key_exists('error', $body) ? 400: 200;
|
2017-03-29 13:29:03 -04:00
|
|
|
|
|
|
|
return [
|
2017-12-08 22:32:00 -05:00
|
|
|
'body' => Json::decode($results['kitsu']),
|
|
|
|
'statusCode' => $statusCode
|
2017-03-29 13:29:03 -04:00
|
|
|
];
|
2017-01-09 20:36:48 -05:00
|
|
|
}
|
|
|
|
|
2017-01-10 12:35:46 -05:00
|
|
|
/**
|
2017-03-29 13:29:03 -04:00
|
|
|
* Delete a list entry
|
2017-01-10 12:35:46 -05:00
|
|
|
*
|
2017-03-29 13:29:03 -04:00
|
|
|
* @param string $id
|
|
|
|
* @param string|null $malId
|
2017-01-10 12:35:46 -05:00
|
|
|
* @return bool
|
|
|
|
*/
|
2017-03-29 13:29:03 -04:00
|
|
|
public function deleteLibraryItem(string $id, string $malId = NULL): bool
|
2017-01-10 12:35:46 -05:00
|
|
|
{
|
2017-03-29 13:29:03 -04:00
|
|
|
$requester = new ParallelAPIRequest();
|
|
|
|
|
2018-02-02 09:50:58 -05:00
|
|
|
if ($this->useMALAPI && $malId !== NULL)
|
2017-03-29 13:29:03 -04:00
|
|
|
{
|
|
|
|
$requester->addRequest($this->malModel->deleteListItem($malId, 'manga'), 'MAL');
|
|
|
|
}
|
|
|
|
|
|
|
|
$requester->addRequest($this->kitsuModel->deleteListItem($id), 'kitsu');
|
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
$results = $requester->makeRequests();
|
2017-03-29 13:29:03 -04:00
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
return count($results) > 0;
|
2017-01-10 12:35:46 -05:00
|
|
|
}
|
|
|
|
|
2017-01-09 20:36:48 -05:00
|
|
|
/**
|
|
|
|
* Search for anime by name
|
|
|
|
*
|
|
|
|
* @param string $name
|
|
|
|
* @return array
|
|
|
|
*/
|
2018-02-02 09:50:58 -05:00
|
|
|
public function search($name): array
|
2017-01-09 20:36:48 -05:00
|
|
|
{
|
|
|
|
return $this->kitsuModel->search('manga', $name);
|
|
|
|
}
|
|
|
|
|
2015-10-05 16:54:25 -04:00
|
|
|
/**
|
|
|
|
* Map transformed anime data to be organized by reading status
|
|
|
|
*
|
|
|
|
* @param array $data
|
|
|
|
* @return array
|
|
|
|
*/
|
2018-02-02 09:50:58 -05:00
|
|
|
private function mapByStatus(array $data): array
|
2015-10-05 16:54:25 -04:00
|
|
|
{
|
|
|
|
$output = [
|
2017-03-01 21:52:30 -05:00
|
|
|
Title::READING => [],
|
|
|
|
Title::PLAN_TO_READ => [],
|
|
|
|
Title::ON_HOLD => [],
|
|
|
|
Title::DROPPED => [],
|
|
|
|
Title::COMPLETED => [],
|
2015-06-16 11:11:35 -04:00
|
|
|
];
|
|
|
|
|
2017-01-05 13:41:32 -05:00
|
|
|
foreach ($data as &$entry) {
|
2017-03-01 21:52:30 -05:00
|
|
|
$statusMap = MangaReadingStatus::KITSU_TO_TITLE;
|
|
|
|
$key = $statusMap[$entry['reading_status']];
|
2015-10-05 16:54:25 -04:00
|
|
|
$output[$key][] = $entry;
|
2015-06-16 11:11:35 -04:00
|
|
|
}
|
|
|
|
|
2018-08-08 13:05:38 -04:00
|
|
|
unset($entry);
|
|
|
|
|
2015-10-05 16:54:25 -04:00
|
|
|
return $output;
|
2015-06-16 11:11:35 -04:00
|
|
|
}
|
|
|
|
}
|
2015-10-05 16:54:25 -04:00
|
|
|
// End of MangaModel.php
|