https://github.com/lsv/tvmazeapi
PHP Wrapper for TV Maze API
https://github.com/lsv/tvmazeapi
Last synced: 4 months ago
JSON representation
PHP Wrapper for TV Maze API
- Host: GitHub
- URL: https://github.com/lsv/tvmazeapi
- Owner: lsv
- License: mit
- Created: 2016-12-13T16:47:00.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-13T09:46:32.000Z (over 9 years ago)
- Last Synced: 2025-07-07T09:05:52.276Z (11 months ago)
- Language: PHP
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TV Maze API
===========
[](https://travis-ci.org/lsv/tvmazeapi)
[](https://codecov.io/gh/lsv/tvmazeapi)
[](https://insight.sensiolabs.com/projects/897d3d4f-5e8a-4e12-af82-63926d290945)
[](https://styleci.io/repos/76379059)
PHP wrapper for tvmaze.com API
### Install
`composer require lsv/tvmazeapi`
or add it to your `composer.json` file
```json
"require": {
"lsv/tvmazeapi": "^1.0"
}
```
### Usage
```php
use Lsv\TvmazeApi\Api\Show;
// Search for a show
$results = Show::getInstance()->search($query);
// $results = Lsv\TvmazeApi\Response\ShowResponse[]
// Search for a single show
$result = Show::getInstance()->singleSearch($query, true, true);
// $result = Lsv\TvmazeApi\Response\ShowResponse
// first true = Embed episodes
// second true = Embed next episode
// Find by tvmaze ID
$result = Show::getInstance()->findById($id, true, true);
// $result = Lsv\TvmazeApi\Response\ShowResponse
// first true = Embed episodes
// second true = Embed next episode
// Find by another sites ID
// Following methods can be used: lookupFromTvrage, lookupFromThetvdb or lookupFromImdb
$result = Show::getInstance()->lookupFromImdb($id);
// $result = Lsv\TvmazeApi\Response\ShowResponse
// first true = Embed episodes
// second true = Embed next episode
```
### What and what not
| Endpoints | Covered |
| --- | --- |
| Show search | **yes** |
| Show single search | **yes** |
| Show Lookup | **yes** |
| Show main information | **yes**
| People search | no |
| Schedule | no |
| Full schedule | no
| Show episode list | **yes**
| Episode by number | no
| Episodes by date | no
| Show seasons | no
| Show cast | no
| Show crew | no
| Show AKA's | no
| Show index | no
| Person main information | no
| Person cast credits | no
| Person crew credits | no
| Show updates | no
### License
The MIT License (MIT)
Copyright (c) 2016 Martin Aarhof martin.aarhof@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.