2016-10-20 22:09:36 -04:00
|
|
|
<?php declare(strict_types=1);
|
2015-06-16 11:11:35 -04:00
|
|
|
/**
|
2016-12-20 12:58:37 -05:00
|
|
|
* 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-01-06 23:34:56 -05:00
|
|
|
* @package AnimeListClient
|
|
|
|
* @author Timothy J. Warren <tim@timshomepage.net>
|
2017-01-11 10:30:53 -05:00
|
|
|
* @copyright 2015 - 2017 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://github.com/timw4mail/HummingBirdAnimeClient
|
2017-01-11 10:30:53 -05:00
|
|
|
*/namespace Aviat\AnimeClient\Model;
|
2015-09-14 10:54:50 -04:00
|
|
|
|
2016-12-20 12:58:37 -05:00
|
|
|
use Aviat\AnimeClient\API\Kitsu\Enum\MangaReadingStatus;
|
|
|
|
use Aviat\AnimeClient\API\Kitsu\Transformer;
|
2017-01-03 21:06:49 -05:00
|
|
|
use Aviat\Ion\Di\ContainerInterface;
|
2015-06-16 11:11:35 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Model for handling requests dealing with the manga list
|
|
|
|
*/
|
2017-01-05 13:41:32 -05:00
|
|
|
class Manga extends API
|
|
|
|
{
|
2015-06-16 11:11:35 -04:00
|
|
|
|
2015-10-05 16:54:25 -04:00
|
|
|
const READING = 'Reading';
|
|
|
|
const PLAN_TO_READ = 'Plan to Read';
|
|
|
|
const DROPPED = 'Dropped';
|
|
|
|
const ON_HOLD = 'On Hold';
|
|
|
|
const COMPLETED = 'Completed';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Map API constants to display constants
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $const_map = [
|
|
|
|
MangaReadingStatus::READING => self::READING,
|
|
|
|
MangaReadingStatus::PLAN_TO_READ => self::PLAN_TO_READ,
|
|
|
|
MangaReadingStatus::ON_HOLD => self::ON_HOLD,
|
|
|
|
MangaReadingStatus::DROPPED => self::DROPPED,
|
|
|
|
MangaReadingStatus::COMPLETED => self::COMPLETED
|
|
|
|
];
|
|
|
|
|
2017-01-04 13:16:58 -05:00
|
|
|
protected $status_map = [
|
|
|
|
'current' => self::READING,
|
|
|
|
'planned' => self::PLAN_TO_READ,
|
|
|
|
'completed' => self::COMPLETED,
|
|
|
|
'on_hold' => self::ON_HOLD,
|
|
|
|
'dropped' => self::DROPPED
|
|
|
|
];
|
|
|
|
|
2017-01-10 12:35:46 -05:00
|
|
|
/**
|
|
|
|
* @var Aviat\AnimeClient\API\Kitsu\KitsuModel
|
|
|
|
*/
|
|
|
|
protected $kitsuModel;
|
|
|
|
|
2017-01-03 21:06:49 -05:00
|
|
|
public function __construct(ContainerInterface $container)
|
2017-01-04 13:16:58 -05:00
|
|
|
{
|
|
|
|
parent::__construct($container);
|
2017-01-03 21:06:49 -05:00
|
|
|
|
2017-01-04 13:16:58 -05:00
|
|
|
$this->kitsuModel = $container->get('kitsu-model');
|
|
|
|
}
|
2015-06-16 11:11:35 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a category out of the full list
|
|
|
|
*
|
|
|
|
* @param string $status
|
|
|
|
* @return array
|
|
|
|
*/
|
2017-01-05 13:41:32 -05:00
|
|
|
public function getList($status)
|
2015-06-16 11:11:35 -04:00
|
|
|
{
|
2017-01-04 13:16:58 -05:00
|
|
|
$APIstatus = array_flip($this->const_map)[$status];
|
|
|
|
$data = $this->kitsuModel->getMangaList($APIstatus);
|
2017-01-05 13:41:32 -05:00
|
|
|
return $this->mapByStatus($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
|
|
|
|
* @return array
|
|
|
|
*/
|
2017-01-05 13:41:32 -05:00
|
|
|
public function getManga($manga_id)
|
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-01-10 12:35:46 -05:00
|
|
|
/**
|
|
|
|
* Create a new manga list item
|
|
|
|
*
|
|
|
|
* @param array $data
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function createLibraryItem(array $data): bool
|
|
|
|
{
|
|
|
|
return $this->kitsuModel->createListItem($data);
|
|
|
|
}
|
|
|
|
|
2017-01-05 22:24:45 -05:00
|
|
|
/**
|
|
|
|
* Get information about a specific list item
|
|
|
|
* for editing/updating that item
|
|
|
|
*
|
|
|
|
* @param string $itemId
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getLibraryItem(string $itemId): array
|
|
|
|
{
|
|
|
|
return $this->kitsuModel->getListItem($itemId);
|
|
|
|
}
|
|
|
|
|
2017-01-09 20:36:48 -05:00
|
|
|
/**
|
|
|
|
* Update a list entry
|
|
|
|
*
|
|
|
|
* @param array $data
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function updateLibraryItem(array $data): array
|
|
|
|
{
|
|
|
|
return $this->kitsuModel->updateListItem($data);
|
|
|
|
}
|
|
|
|
|
2017-01-10 12:35:46 -05:00
|
|
|
/**
|
|
|
|
* Remove a list entry
|
|
|
|
*
|
|
|
|
* @param string $itemId
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function deleteLibraryItem(string $itemId): bool
|
|
|
|
{
|
|
|
|
return $this->kitsuModel->deleteListItem($itemId);
|
|
|
|
}
|
|
|
|
|
2017-01-09 20:36:48 -05:00
|
|
|
/**
|
|
|
|
* Search for anime by name
|
|
|
|
*
|
|
|
|
* @param string $name
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function search($name)
|
|
|
|
{
|
|
|
|
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
|
|
|
|
*/
|
2017-01-05 13:41:32 -05:00
|
|
|
private function mapByStatus($data)
|
2015-10-05 16:54:25 -04:00
|
|
|
{
|
|
|
|
$output = [
|
|
|
|
self::READING => [],
|
|
|
|
self::PLAN_TO_READ => [],
|
|
|
|
self::ON_HOLD => [],
|
|
|
|
self::DROPPED => [],
|
|
|
|
self::COMPLETED => [],
|
2015-06-16 11:11:35 -04:00
|
|
|
];
|
|
|
|
|
2017-01-05 13:41:32 -05:00
|
|
|
foreach ($data as &$entry) {
|
2017-01-04 13:16:58 -05:00
|
|
|
$key = $this->status_map[$entry['reading_status']];
|
2015-10-05 16:54:25 -04:00
|
|
|
$output[$key][] = $entry;
|
2015-06-16 11:11:35 -04:00
|
|
|
}
|
|
|
|
|
2017-01-05 13:41:32 -05:00
|
|
|
foreach ($output as &$val) {
|
|
|
|
$this->sortByName($val, 'manga');
|
2016-04-12 13:41:03 -04:00
|
|
|
}
|
|
|
|
|
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
|