README

A PHP library for interacting with the Media Manager APIs.

Installing

The library can be installed via Composer. Simply include the library in your require block in composer.json.

{
    "require": {
        "media-manager/media-manager-api-php": "dev-master"
    }
}

And then run the composer install

composer install

Now you can require the autoload.

require 'vendor/autoload.php';

//Create the gateway or request used to get data.
$gateway = new MediaManager\HTTP\CurlRequest();

//CREATE MEDIAMANAGER INSTANCE
$MediaManager = new \MediaManager\MediaManager("{shortname}", "{apiKey}", $gateway);

Client

You can get your client data by using the getClient method.

$client = $MediaManager->api()->getClient();

Templates

Getting all templates

You can get all templates attached to your account.

$videos = $MediaManager->api()->getTemplates();

Playlists

Getting all playlists

You can get all playlists attached to your account.

$videos = $MediaManager->api()->getPlaylists();

Videos

You can get all your videos or a single video.

Getting all videos

$videos = $MediaManager->api()->getVideos();

Getting a video

$videos = $MediaManager->api()->getVideo("{videoid}");

External

Media Manager has a number of external APIs. These are mainly used for Javascript based calls, but can still be called via PHP using this library.

Templates

Searching videos

You can search all videos on a given external template. You can pass up to 25 terms to search against (as an array). The search is purformed on titles, descriptions and tags.

$searchResults = $MediaManager->ExternalAPI->searchTemplateVideos("{external_template_id}", array("hello", "world"));

Most viewed videos

$mostViewed = $MediaManager->ExternalAPI->getTemplateMostViewedVideos("{external_template_id}");

Recommend videos

You can use the recommend API to get recommendations based on a video you pass.

$mostViewed = $MediaManager->external()->recommendTemplateVideo("{external_template_id}","{videoid}");

Latest videos

Get the latest videos on template

$latest = $MediaManager->external()->getTemplateLatestVideos("{external_template_id}");

Get video on template

Get a video details thats published to template.

$video = $MediaManager->external()->getTemplateVideo("{external_template_id}", "{videoid}");

Get videos on template

Get all videos on template.

$videos = $MediaManager->external()->getTemplateVideos("{external_template_id}");

Get audios on template

Get all audios on template.

$audios = $MediaManager->external()->getTemplateAudios("{external_template_id}");

###Playlists

All these playlist APIS will require a templateID also. They allow you filter down videos that appear in a playlist and also a external template.

Get videos in playlist

Get all videos published to a playlist

$videos = $MediaManager->external()->getPlaylistVideosOnTemplate("{playlist_id}","{external_template_id}");

Get audios in playlist

Get all audios published to a playlist

$audios = $MediaManager->external()->getPlaylistAudiosOnTemplate("{playlist_id}","{external_template_id}");

Get video in playlist

Get video published to a playlist

$video = $MediaManager->external()->getPlaylistVideoOnTemplate("{playlist_id}","{external_template_id}","{video_id"});

Get audio in playlist

Get audio published to a playlist

$video = $MediaManager->external()->getPlaylistAudioOnTemplate("{playlist_id}","{external_template_id}","{audio_id"});

Analytics

You can also query your analytics.

Query Builder

You can also make use of the Query Builder.

$Query = new MediaManager\Analytics\Query();

You can then pass this into the Query method.

$query = $MediaManager->API->Analytics()->query($Query);

This will perform the most simple query, which would be SHOW Video. You can build on the query builder and add conditions and so on.

//Get current Show query.
$Show = $Query->get();

The default SHOW is for videos, but you can change it by calling the Show() method.

//Set the Show query to an Audo query.
$Show = $Query->Show("Audio");

Adding condition

$Show->Condition("title", "hello world");

By default the conditon will use the opreator IS. This can be changed by passing a third parameter.

$Show->Condition("title", "hello world", "ISNOT");

When you have more than one conditon on a query a operator is used to seperate them. There are two options AND, OR. By default AND is used. This can be changed by setting the Logical method.

$Show->Condition("title", "new")->Logical("OR");
$Show->Condition("title", "manager")->Logical("OR");
$Show->Condition("title", "test");

Filtering

You can also filter down the content returned by the API.

//ADD TEMPLATE FILTER
$MediaManager->API->addTemplateFilter("{template}");

//GET VIDEOS
$videos = $MediaManager->API->getVideos();

So this filter allows you to only return videos that are published to a given template. You can continue to add other filters.

//ADD TEMPLATE FILTER
$MediaManager->API->addTemplateFilter("{template}");

//ADD PLAYLIST FILTER
$MediaManager->API->addPlaylistFilter("{playlist}");

//GET VIDEOS
$videos = $MediaManager->API->getVideos();

So now we only want to return videos that are published to a given template, but also published to a given playlist.

Paging

Some API calls will return paged content. So the getVideos method will be returned as a MediaManager\Pager\Pager object. This can be easily iterated using a simple loop.

//GET VIDEOS
$videos = $MediaManager->API->getVideos();

//LOOP THROUGH FIRST PAGE
foreach($videos as $key => $video){
   
}

Pager filters

Sometimes you may want to change the pager filters. For instance if you wanted to limit the number of items returned.

//ADD A PAGE FILER
$MediaManager->API->addFilter("perPage","10");

//GET VIDEOS
$videos = $MediaManager->API->getVideos();