mediaflux/php-tmdb-api

PHP 对 TMDB (TheMovieDatabase) API v3 的封装。支持两种方法:一种是通过仓库、模型和工厂建模,另一种是通过简单数组访问来自电影数据库的原始数据。

v2.1.14 2018-01-20 18:33 UTC

README

License Build Status Code Coverage PHP & HHVM

php-github-apiphp-gitlab-api 和 Symfony 社区的启发。

如果您有任何问题或功能请求,请访问 google+ 社区

稳定

Latest Stable Version Latest Unstable Version Dependency Status Total Downloads

目前单元测试在 travis 上运行,以下版本

  • 5.6
  • 7.0
  • 7.1
  • HHVM(允许失败)
  • 夜间(允许失败)

特性

主要特性

  • 完整集成所有 TMDB API 提供的功能(账户、电影、电视等。如果有什么缺失,我还没有添加更新!)。
  • 电影数据库的数组实现(原始)
  • 使用仓库的电影数据库的模型实现
  • 一个 ImageHelper 类,用于构建图片 URL 或 HTML 元素。

其他值得一提的事情

  • 默认启用重试订阅者以处理任何速率限制错误。
  • 默认启用缓存订阅者,基于 TMDB 返回的 max-age 头,需要 doctrine-cache
  • 可选的日志订阅者,需要 monolog。在开发期间可能很有用。

插件

安装

安装 Composer

$ curl -sS https://getcomposer.org/installer | php
$ sudo mv composer.phar /usr/local/bin/composer

您不必将 composer.phar 文件移动到您的 /usr/local/bin,但全球安装被认为很简单。

composer.json 配置中的 require 块中添加以下内容

"php-tmdb/api": "~2.1"

如果您对 composer 没有经验,不知道我在说什么

只需在您的文档根目录中创建一个名为 composer.json 的文件

{
    "require": {
        "php-tmdb/api": "~2.1"
    }
}

现在让我们安装并拉入依赖项!

composer install

包含 Composer 的自动加载器

require_once dirname(__DIR__).'/vendor/autoload.php';

要使用提供的示例,将 apikey.php.dist 复制到 apikey.php 并更改设置。

构建客户端

首先,我们总是必须构建客户端

$token  = new \Tmdb\ApiToken('your_tmdb_api_key_here');
$client = new \Tmdb\Client($token);

如果您想进行非安全请求(默认情况下,我们使用安全请求)。

$client = new \Tmdb\Client($token, ['secure' => false]);

默认启用缓存,并使用慢速文件系统处理程序,您可以选择

  • 通过在客户端提供选项来替换存储的 path
$client = new \Tmdb\Client($token, [
    'cache' => [
        'path' => '/tmp/php-tmdb'
    ]
]);
  • 或替换整个实现为 Doctrine 的其他 CacheStorage
use Doctrine\Common\Cache\ArrayCache;

$client = new \Tmdb\Client($token, [
        'cache' => [
            'handler' => new ArrayCache()
        ]
    ]
);

这将仅在请求长度内将缓存保留在内存中,有关可用适配器的文档,请参阅 Doctrine 缓存文档

强烈反对这一点,禁用缓存

$client = new \Tmdb\Client($token, [
    'cache' => [
        'enabled' => false
    ]
]);

如果您想添加一些日志功能(需要 monolog/monolog),默认情况下为文件系统;

$client = new \Tmdb\Client($token, [
    'log' => [
        'enabled' => true,
        'path'    => '/var/www/php-tmdb-api.log'
    ]
]);

然而,在开发期间,您可能更喜欢一些控制台魔法,如 ChromePHPFirePHP

$client = new \Tmdb\Client($token, [
    'log' => [
        'enabled' => true,
        'handler' => new \Monolog\Handler\ChromePHPHandler()
    ]
]);

一般 API 使用

如果您正在寻找简单的数组入口点,API 命名空间就是您所在之处。

$movie = $client->getMoviesApi()->getMovie(550);

如果您想提供任何其他查询参数。

$movie = $client->getMoviesApi()->getMovie(550, array('language' => 'en'));

模型使用

然而,该库也可以以面向对象的方式进行使用,我认为这是做事的首选方式。

而不是调用客户端,你可以将客户端传递给众多存储库之一,然后在上面做一些工作。

$repository = new \Tmdb\Repository\MovieRepository($client);
$movie      = $repository->load(87421);

echo $movie->getTitle();

存储库还包含通过API命名空间可用的其他API方法。

$repository = new \Tmdb\Repository\MovieRepository($client);
$topRated = $repository->getTopRated(array('page' => 3));
// or
$popular = $repository->getPopular();

一些其他有用的提示

事件分发

从2.0版本开始,请求由EventDispatcher处理,这为您提供了前后钩子,前置钩子允许事件停止请求事件的传播,这意味着您能够阻止主要请求的发生,但您需要在那个事件中设置一个Response对象。

请参阅TmdbEventsRequestSubscriber文件。

图像辅助工具

提供了一个ImageHelper类来处理图像,这需要加载配置。

$configRepository = new \Tmdb\Repository\ConfigurationRepository($client);
$config = $configRepository->load();

$imageHelper = new \Tmdb\Helper\ImageHelper($config);

echo $imageHelper->getHtml($image, 'w154', 154, 80);

插件

目前只有两个默认未启用的实用插件,您可能想使用这些插件

$plugin = new \Tmdb\HttpClient\Plugin\LanguageFilterPlugin('nl');

尝试用荷兰语获取所有内容。

$plugin = new \Tmdb\HttpClient\Plugin\AdultFilterPlugin(true);

我们喜欢不寻常的结果,如果这样配置,提供false以过滤掉这些结果。

集合过滤

我们还提供了一些简单的方法来过滤任何集合,但请注意,您可以通过使用闭包轻松实现自己的过滤。

foreach($movie->getImages()->filter(
        function($key, $value){
            if ($value instanceof \Tmdb\Model\Image\PosterImage) { return true; }
        }
    ) as $image) {

    // do something with all poster images
}

然而,这些基本过滤器已经在Images集合对象中得到了覆盖。

$backdrop = $movie
    ->getImages()
    ->filterBackdrops()
;

还有更多的集合提供过滤器,但您会在使用过程中发现这些。

GenericCollectionResultCollection

GenericCollection可以包含任何对象集合(例如电影集合)。

ResultCollectionGenericCollection的扩展,从结果集中继承响应参数(页面、总页面数、总结果数),这可以用来创建分页器。

帮助与捐赠

如果您在个人或商业项目中使用此功能,我想知道它在哪里使用,请发电子邮件给我!:-)

如果这个项目为您节省了大量工作,或者您只是简单地欣赏我的努力,请考虑捐赠一些啤酒(或者两瓶;)!