HummingBirdAnimeClient/src/Model/Anime.php

179 lines
3.8 KiB
PHP
Raw Normal View History

2016-10-20 22:09:36 -04:00
<?php declare(strict_types=1);
/**
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
*/
namespace Aviat\AnimeClient\Model;
2016-12-20 12:58:37 -05:00
use Aviat\AnimeClient\API\Kitsu\Enum\AnimeWatchingStatus;
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
*/
class Anime extends API {
2015-10-01 16:01:23 -04:00
// Display constants
const WATCHING = 'Watching';
const PLAN_TO_WATCH = 'Plan to Watch';
const DROPPED = 'Dropped';
const ON_HOLD = 'On Hold';
const COMPLETED = 'Completed';
/**
* Map of API status constants to display constants
* @var array
*/
protected $const_map = [
AnimeWatchingStatus::WATCHING => self::WATCHING,
AnimeWatchingStatus::PLAN_TO_WATCH => self::PLAN_TO_WATCH,
AnimeWatchingStatus::ON_HOLD => self::ON_HOLD,
AnimeWatchingStatus::DROPPED => self::DROPPED,
AnimeWatchingStatus::COMPLETED => self::COMPLETED,
];
2017-02-04 15:18:34 -05:00
protected $kitsuModel;
protected $malModel;
protected $useMALAPI;
/**
* Anime constructor.
* @param ContainerInterface $container
*/
2016-12-21 12:46:20 -05:00
public function __construct(ContainerInterface $container) {
parent::__construct($container);
2017-02-04 15:18:34 -05:00
$config = $container->get('config');
$this->kitsuModel = $container->get('kitsu-model');
2017-02-04 15:18:34 -05:00
$this->malModel = $container->get('mal-model');
$this->useMALAPI = $config->get(['use_mal_api']) === TRUE;
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)
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
$output = [];
$output[$this->const_map[$status]] = $data;
2015-05-22 12:36:26 -04:00
return $output;
}
/**
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 array
*/
2017-01-16 13:49:51 -05:00
public function getAnime($slug)
{
2017-01-16 13:49:51 -05:00
return $this->kitsuModel->getAnime($slug);
}
2017-02-04 15:18:34 -05:00
2017-01-16 13:49:51 -05:00
public function getAnimeById($anime_id)
{
return $this->kitsuModel->getAnimeById($anime_id);
}
/**
* Search for anime by name
*
* @param string $name
* @return array
*/
public function search($name)
{
// $raw = $this->kitsuModel->search('anime', $name);
return $this->kitsuModel->search('anime', $name);
}
/**
* 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-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-04 15:18:34 -05:00
if ($this->useMALAPI)
{
$malData = $data;
$malId = $this->kitsuModel->getMalIdForAnime($malData['id']);
if ( ! is_null($malId))
{
$malData['id'] = $malId;
$this->malModel->createListItem($malData);
}
}
return $this->kitsuModel->createListItem($data);
}
/**
* Update a list entry
*
* @param array $data
* @return array
*/
public function updateLibraryItem(array $data): array
{
2017-02-04 15:18:34 -05:00
if ($this->useMALAPI)
{
$this->malModel->updateListItem($data);
}
return $this->kitsuModel->updateListItem($data);
}
2017-02-04 15:18:34 -05:00
/**
* Delete a list entry
*
* @param string $id
* @param string|null $malId
* @return bool
*/
public function deleteLibraryItem(string $id, string $malId = null): bool
{
2017-02-04 15:18:34 -05:00
if ($this->useMALAPI && ! is_null($malId))
{
$this->malModel->deleteListItem($malId);
}
return $this->kitsuModel->deleteListItem($id);
}
2015-05-22 12:36:26 -04:00
}
// End of AnimeModel.php