HummingBirdAnimeClient/src/Model/Manga.php

240 lines
5.1 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
*
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
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\AnimeClient\Model;
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;
use Aviat\Ion\Json;
/**
* Model for handling requests dealing with the manga list
*/
2018-08-08 13:05:38 -04:00
class Manga extends API {
/**
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
*/
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-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
}
/**
* 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
{
2017-03-07 18:41:51 -05:00
if ($status === 'All')
{
$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];
$data = $this->mapByStatus($this->kitsuModel->getMangaList($APIstatus));
$this->sortByName($data[$status], 'manga');
2018-08-08 13:05:38 -04:00
return $data[$status];
}
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
}
/**
* Get anime by its kitsu id
*
* @param string $animeId
2018-08-08 13:05:38 -04:00
* @return MangaPage
*/
2018-08-08 13:05:38 -04:00
public function getMangaById(string $animeId): MangaPage
{
return $this->kitsuModel->getMangaById($animeId);
}
/**
* 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
*/
2018-08-08 13:05:38 -04:00
public function getLibraryItem(string $itemId): MangaListItem
{
return $this->kitsuModel->getListItem($itemId);
}
/**
* 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)
{
$malData['id'] = $malId;
$requester->addRequest($this->malModel->createListItem($malData, 'manga'), 'mal');
}
}
$requester->addRequest($this->kitsuModel->createListItem($data), 'kitsu');
$results = $requester->makeRequests();
return count($results) > 0;
}
/**
* Update a list entry
*
2018-08-08 13:05:38 -04:00
* @param MangaFormItem $data
* @return array
*/
2018-08-08 13:05:38 -04:00
public function updateLibraryItem(MangaFormItem $data): array
{
$requester = new ParallelAPIRequest();
if ($this->useMALAPI)
{
$requester->addRequest($this->malModel->updateListItem($data, 'manga'), 'mal');
}
$requester->addRequest($this->kitsuModel->updateListItem($data), 'kitsu');
$results = $requester->makeRequests();
$body = Json::decode($results['kitsu']);
2018-02-02 09:50:58 -05:00
$statusCode = array_key_exists('error', $body) ? 400: 200;
return [
'body' => Json::decode($results['kitsu']),
'statusCode' => $statusCode
];
}
/**
* Delete a list entry
*
* @param string $id
* @param string|null $malId
* @return bool
*/
public function deleteLibraryItem(string $id, string $malId = NULL): bool
{
$requester = new ParallelAPIRequest();
2018-02-02 09:50:58 -05:00
if ($this->useMALAPI && $malId !== NULL)
{
$requester->addRequest($this->malModel->deleteListItem($malId, 'manga'), 'MAL');
}
$requester->addRequest($this->kitsuModel->deleteListItem($id), 'kitsu');
$results = $requester->makeRequests();
return count($results) > 0;
}
/**
* Search for anime by name
*
* @param string $name
* @return array
*/
2018-02-02 09:50:58 -05:00
public function search($name): array
{
return $this->kitsuModel->search('manga', $name);
}
/**
* 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
{
$output = [
2017-03-01 21:52:30 -05:00
Title::READING => [],
Title::PLAN_TO_READ => [],
Title::ON_HOLD => [],
Title::DROPPED => [],
Title::COMPLETED => [],
];
foreach ($data as &$entry) {
2017-03-01 21:52:30 -05:00
$statusMap = MangaReadingStatus::KITSU_TO_TITLE;
$key = $statusMap[$entry['reading_status']];
$output[$key][] = $entry;
}
2018-08-08 13:05:38 -04:00
unset($entry);
return $output;
}
}
// End of MangaModel.php