PHP用Data APIライブラリ(その3・単一オブジェクト取得系メソッド)

Movable TypeのData APIでは、オブジェクトのリストを取得するメソッドのほかに、単一のオブジェクトを取得するメソッドもあります。
PHPライブラリでも、それらのメソッドを実行することができます。

1.メソッドの一覧

単一のオブジェクトを取得するメソッドは、「get○○○」のような名前になっています。
メソッドにより、以下のようにパラメータを2つ～4つ取ります。

• getUser(user_id, params)
• getBlog(site_id, params)
• getEntry(site_id, entry_id, params)
• getComment(site_id, comment_id, params)
• getTrackback(site_id, ping_id, params)
• getStatsProvider(site_id, params)
• getCategory(site_id, category_id, params)
• getFolder(site_id, folder_id, params)
• getAsset(site_id, asset_id, params)
• getThumbnail(site_id, asset_id, params)
• getPage(site_id, page_id, params)
• getRole(role_id, params)
• getLog(site_id, log_id, params)
• getTagForSite(site_id, tag_id, params)
• getTheme(theme_id, params)
• getThemeForSite(site_id, theme_id, params)
• getTemplate(site_id, template_id, params)
• getTemplatemap(site_id, template_id, templatemap_id, params)
• getWidgetset(site_id, widgetset_id, params)
• getWidgets(site_id, widget_id, params)
• getWidgetForWidgetset(site_id, widgetset_id, widget_id, params)
• getPlugin(plugin_id, params)
• getField(site_id, field_id, params)
• getLikesForEntry(site_id, entry_id, params)
• getFormattedText(site_id, formatted_text_id, params)

2.メソッドの呼び出し方

「site_id」など、「○○_id」のパラメータには、オブジェクトのIDを渡します。
また、「params」のパラメータには、オプションとして渡す情報を、連想配列の形で指定します。
オプションを指定しない場合は、paramsのパラメータは省略することができます。
メソッドごとのオプションの詳細は、Data APIのドキュメントを参照してください。

3.メソッドの戻り値

メソッドの戻り値は連想配列になります。
連想配列の個々のキーがフィールドに対応します。

なお、オブジェクトの読み込みでエラーが起こった場合は、戻り値の連想配列に「error」という要素ができます。

4.例

例えば、以下のような状況だとします。

• 変数$apiに、Data APIのオブジェクトを割り当てています。
• IDが1番のブログから、IDが10番の記事を読み込み、変数$entryに割り当てます。
• 読み込んだ記事のタイトルを出力します。
  

この場合、以下のようなコードを実行します。

$entry = $api->getEntry(1, 10);
if (isset($entry['error']) {
    エラー処理
}
print $entry['title'];