README

一个用于与媒体管理API交互的PHP库。

安装

该库可以通过Composer安装。只需在composer.json文件的要求块中包含库。

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

然后运行composer install

composer install

现在您可以要求加载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);

客户端

您可以通过使用getClient方法来获取客户端数据。

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

模板

获取所有模板

您可以通过您的账户获取所有模板。

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

播放列表

获取所有播放列表

您可以通过您的账户获取所有播放列表。

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

视频

您可以通过您的账户获取所有视频或单个视频。

获取所有视频

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

获取单个视频

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

外部

媒体管理器有多个外部API。这些API主要用于基于JavaScript的调用，但也可以通过此库使用PHP调用。

模板

搜索视频

您可以在给定的外部模板上搜索所有视频。您最多可以传递25个术语进行搜索（作为数组）。搜索是在标题、描述和标签上执行的。

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

最受欢迎的视频

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

推荐视频

您可以使用推荐API根据您传递的视频获取推荐。

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

最新视频

获取模板上的最新视频

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

获取模板上的视频

获取发布到模板的视频详情

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

获取模板上的视频

获取模板上的所有视频。

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

获取模板上的音频

获取模板上的所有音频。

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

###播放列表

所有这些播放列表API都需要一个templateID。它们允许您筛选出在播放列表和外部模板中出现的视频。

获取播放列表中的视频

获取发布到播放列表的所有视频

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

获取播放列表中的音频

获取发布到播放列表的所有音频

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

获取播放列表中的视频

获取发布到播放列表的视频

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

获取播放列表中的音频

获取发布到播放列表的音频

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

分析

您还可以查询您的分析。

查询构建器

您还可以使用查询构建器。

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

然后您可以将它传递给Query方法。

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

这将执行最简单的查询，即SHOW Video。您可以在查询构建器上构建并添加条件等。

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

默认SHOW是针对视频的，但您可以通过调用Show()方法来更改它。

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

添加条件

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

默认情况下，条件将使用操作符IS。这可以通过传递第三个参数来更改。

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

当查询中有多个条件时，将使用操作符来分隔它们。有两种选项AND、OR。默认情况下使用AND。这可以通过设置Logical方法来更改。

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

过滤

您还可以过滤API返回的内容。

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

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

因此，此过滤器允许您只返回发布到给定模板的视频。您可以继续添加其他过滤器。

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

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

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

因此，现在我们只想返回发布到给定模板且发布到给定播放列表的视频。

分页

某些API调用将返回分页内容。因此，getVideos方法将返回一个MediaManager\Pager\Pager对象。这可以通过简单的循环轻松迭代。

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

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

分页器过滤器

有时您可能想更改分页过滤器。例如，如果您想限制返回的项目数量。

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

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