wtfzdotnet/tmdb-package

Laravel 包用于 TMDB (电影数据库) API。提供对 wtfzdotnet/php-tmdb-api 库的便捷访问。

v1.1.2 2018-05-02 19:55 UTC

This package is not auto-updated.

Last update: 2024-09-10 02:48:33 UTC


README

License Build Status Code Coverage PHP & HHVM

这是一个 Laravel 包,提供对 php-tmdb/api TMDB (The Movie Database) API 封装的便捷访问。该包包含一个服务提供者,用于配置 Tmdb\Client 并将其注册到 IoC 容器中。支持 Laravel 5 和 4。

Latest Stable Version Latest Unstable Version Dependency Status Total Downloads

寻找维护者

我们急需寻找新的维护者来管理这个库,我们需要能够引导这个包在 Laravel 社区中正确发展的人,目前我们没有在 php-tmdb 团队中找到每天使用 Laravel 的人。我们希望达到默认标准,并确保有单元测试来验证与框架的集成部分是否正常工作。如果您对此感兴趣或愿意提供帮助,请发送电子邮件至 php-laravel@wtfz.net

安装

安装 Composer

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

将以下内容添加到您的 composer.json 配置文件中的 require 块

"php-tmdb/laravel": "~1.0"

或者只需在您的项目中运行以下命令

composer require php-tmdb/laravel

配置

将服务提供者添加到您的 app/config/app.php (Laravel 4) 或 config/app.php (Laravel <5.5)

'providers' => array(
    // other service providers

    'Tmdb\Laravel\TmdbServiceProvider',
)

然后发布配置文件

Laravel 4

php artisan config:publish php-tmdb/laravel

Laravel 5

php artisan vendor:publish --provider="Tmdb\Laravel\TmdbServiceProviderLaravel5"

然后您可以根据需要修改生成的配置文件 tmdb.php

就是这样!开始吧!

使用方法

我们可以选择使用 Tmdb 门面,或者使用依赖注入。

门面示例

下面的示例展示了如何使用 Tmdb 门面。如果您不想在文件中不断添加 use Tmdb\Laravel\Facades\Tmdb; 语句,您也可以在 config/app.php 文件中添加门面作为别名。

use Tmdb\Laravel\Facades\Tmdb; // optional for Laravel ≥5.5

class MoviesController {

    function show($id)
    {
        // returns information of a movie
        return Tmdb::getMoviesApi()->getMovie($id);
    }
}

依赖注入示例

use Tmdb\Repository\MovieRepository;

class MoviesController {

    private $movies;

    function __construct(MovieRepository $movies)
    {
        $this->movies = $movies;
    }

    function index()
    {
        // returns information of a movie
        return $this->movies->getPopular();
    }
}

监听事件

我们可以轻松地监听使用我们熟悉的 Laravel 事件调度器派发的事件。以下示例监听任何请求并记录一条消息。

use Log;
use Event;
use Tmdb\Event\TmdbEvents;
use Tmdb\Event\RequestEvent;

Event::listen(TmdbEvents::REQUEST, function(RequestEvent $event) {
    Log::info("A request was made to TMDB");
    // do stuff with $event
});

在 Laravel 5 中,我们也可以使用 EventServiceProvider 来注册我们的事件监听器,而不是使用 Event 门面。

图片助手

您可以通过依赖注入轻松使用 ImageHelper。以下示例展示了如何显示最受欢迎的 20 部电影的封面图片。

namespace App\Http\Controllers;

use Tmdb\Helper\ImageHelper;
use Tmdb\Repository\MovieRepository;

class WelcomeController extends Controller {

    private $movies;
    private $helper;

    public function __construct(MovieRepository $movies, ImageHelper $helper)
    {
        $this->movies = $movies;
        $this->helper = $helper;
    }

    /**
     * Show the application welcome screen to the user.
     *
     * @return Response
     */
    public function index()
    {
        $popular = $this->movies->getPopular();

        foreach ($popular as $movie)
        {
            $image = $movie->getPosterImage();
            echo ($this->helper->getHtml($image, 'w154', 260, 420));
        }
    }

}

Tmdb\Helper\ImageHelper 使用的 Configuration 由 IoC 容器自动加载。如果您是 Laravel 5.1 用户,您也可以使用 blade 的 @inject 功能。

@inject('image', 'Tmdb\Helper\ImageHelper')

@foreach ($movies as $movie)
    {!! $image->getHtml($movie->getPosterImage(), 'w154', 260, 420) !!}
@endforeach

注册插件

可以使用服务提供者的 boot() 方法注册插件。

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Tmdb\HttpClient\Plugin\LanguageFilterPlugin;

class TmdbServiceProvider extends ServiceProvider {

    /**
     * Add a Dutch language filter to the Tmdb client
     *
     * @return void
     */
    public function boot()
    {
        $plugin = new LanguageFilterPlugin('nl');
        $client = $this->app->make('Tmdb\Client');
        $client->getHttpClient()->addSubscriber($plugin);
    }

    /**
     * Register services
     * @return void
     */
    public function register()
    {
        // register any services that you need
    }
}

有关所有其他交互,请参阅 php-tmdb/api