README

Introduction

A PHP wrapper for OMDb API with object-oriented approach and no dependencies.

Prerequisites

PHP >= 7.1
PHP json extension
PHP curl extension

Installation

Install omdb-php using Composer.

composer require rooxie/omdb

Quickstart

Create an instace of OMDb class, providing the API key as the constructor argument

$omdb = new Rooxie\OMDb('xxxxxxx');

Get title by IMDb ID

One gets an instance of Movie model class after fetching movie data vit HTTP request

$movie = $omdb->getByImdbId('tt0110912');

echo $movie->getTitle();        // Pulp Fiction
echo $movie->getReleased();     // 14 Oct 1994
echo $movie->getRuntime();      // 154
echo $movie->getImdbRating();   // 8.9
...

Get by title and other optional arguments

Same goes for fetching data using movie title. One can also provide optional arguments such as movie type (movie, series or episode) and the release year

$movie = $omdb->getByTitle('harry potter', 'movie', 2004);

echo $movie->getTitle();        // Harry Potter and the Prisoner of Azkaban
echo $movie->getImdbId();       // tt0304141
echo $movie->getRated();        // PG
echo $movie->getMetascore();    // 82
...

Each object also has a $movie->toArray() method

Array
(
    [ImdbId] => tt0246578
    [Title] => Donnie Darko
    [Year] => 2001
    [Rated] => R
    [Released] => 26 Oct 2001
    [Runtime] => 113
    [Genre] => Array
        (
            [0] => Drama
            [1] => Sci-Fi
            [2] => Thriller
        )

    [Director] => Array
        (
            [0] => Richard Kelly
        )

    [Writer] => Array
        (
            [0] => Richard Kelly
        )

    [Actors] => Array
        (
            [0] => Jake Gyllenhaal
            [1] => Holmes Osborne
            [2] => Maggie Gyllenhaal
            [3] => Daveigh Chase
        )

    [Plot] => A troubled teenager is plagued by visions of a man in a large rabbit suit who manipulates him to commit a series of crimes, after he narrowly escapes a bizarre accident.
    [Language] => Array
        (
            [0] => English
        )

    [Country] => Array
        (
            [0] => USA
        )

    [Awards] => 11 wins & 15 nominations.
    [Poster] => https://m.media-amazon.com/images/M/MV5BZjZlZDlkYTktMmU1My00ZDBiLWFlNjEtYTBhNjVhOTM4ZjJjXkEyXkFqcGdeQXVyMTMxODk2OTU@._V1_.jpg
    [Type] => movie
    [DVD] => 19 Mar 2002
    [BoxOffice] => N/A
    [Production] => Newmarket Film Group
    [Website] => http://www.donniedarko.com
    [Metascore] => 88
    [RottenTomatoesRating] => 87
    [IMDbRating] => 8.1
    [IMDbVotes] => 695608
    [TotalSeasons] => N/A
    [SeriesID] => N/A
    [Season] => N/A
    [Episode] => N/A
)

Search by title and other optional arguments

Movie search method returns a raw array from the API response and has an optional pagination parameter as the last argument

$movies = $omdb->search('arrival', 'movie', 2016, 1);

Result

Error Handling

The majority of basic errors have corresponding exceptions.

Invalid API key

try {
    $movies = $omdb->getByTitle('a clockwork orange');
} catch (\Rooxie\Exception\InvalidApiKeyException $e) {
    echo $e->getMessage(); // Invalid API key "Invalid or missing API key"
}

Movie not found

try {
    $movies = $omdb->getByTitle('zaqxswcde');
} catch (\Rooxie\Exception\MovieNotFoundException $e) {
    echo $e->getMessage(); // Could not find movie "zaqxswcde"
}

Incorrect IMDb ID

try {
    $movies = $omdb->getByImdbId('gj349gj349gj34');
} catch (\Rooxie\Exception\IncorrectImdbIdException $e) {
    echo $e->getMessage(); // Incorrect IMDb ID "gj349gj349gj34"
}

Should the API return a value with a wrong format, the InvalidResponseException will be thrown.

In all the other cases the ApiErrorException will be thrown.

rooxie / omdb

Maintainers

Details