PHP用Data APIライブラリ(その2・リスト取得系メソッド)

PHP用Data APIライブラリには多くのメソッドがありますが、その呼び出し方は、いくつかのグループに分類することができます(一部の例外を除く)。
まず、オブジェクトのリストを取得するメソッドについて、呼び出し方を解説します。

1.メソッドの一覧

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

  • listEndpoints(params)
  • listBlogsForUser(user_id, params)
  • listEntries(site_id, params)
  • listCategories(site_id, params)
  • listComments(site_id, params)
  • listCommentsForEntry(site_id, entry_id, params)
  • listTrackbacks(site_id, params)
  • listTrackbacksForEntry(site_id, entry_id, params)
  • listPermissionsForUser(user_id, params)
  • listStatsPageviewsForPath(site_id, params)
  • listStatsVisitsForPath(site_id, params)
  • listStatsPageviewsForDate(site_id, params)
  • listStatsVisitsForDate(site_id, params)
  • listCategories(site_id, params)
  • listCategoriesForEntry(site_id, entry_id, params)
  • listParentCategories(site_id, category_id, params)
  • listSiblingCategories(site_id, category_id, params)
  • listChildCategories(site_id, category_id, params)
  • listFolders(site_id, params)
  • listParentFolders(site_id, folder_id, params)
  • listSiblingFolders(site_id, folder_id, params)
  • listChildFolders(site_id, folder_id, params)
  • listAssets(site_id, params)
  • listAssetsForEntry(site_id, entry_id, params)
  • listAssetsForPage(site_id, page_id, params)
  • listAssetsForSiteAndTag(site_id, tag_id, params)
  • listEntriesForCategory(site_id, category_id, params)
  • listEntriesForAsset(site_id, asset_id, params)
  • listEntriesForSiteAndTag(site_id, tag_id, params)
  • listPages(site_id, params)
  • listPagesForFolder(site_id, folder_id, params)
  • listPagesForAsset(site_id, asset_id, params)
  • listPagesForSiteAndTag(site_id, tag_id, params)
  • listCommentsForPage(site_id, page_id, params)
  • listTrackbacksForPage(site_id, page_id, params)
  • listSites(params)
  • listSitesByParent(site_id, params)
  • listRoles(params)
  • listPermissions(params)
  • listPermissionsForUser(user_id, params)
  • listPermissionsForSite(site_id, params)
  • listPermissionsForRole(role_id, params)
  • listLogs(site_id, params)
  • listTagsForSite(site_id, params)
  • listThemes(params)
  • listThemesForSite(site_id, params)
  • listTemplates(site_id, params)
  • listTemplatemaps(site_id, template_id, params)
  • listWidgetsets(site_id, params)
  • listWidgets(site_id, params)
  • listWidgetsForWidgetset(site_id, widgetset_id, params)
  • listUsers(params)
  • listPlugins(params)
  • listFields(site_id, params)
  • listCategoriesForEntry(site_id, entry_id, params)
  • listFormattedTexts(site_id, params)

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

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

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

  • 変数$apiに、Data APIのオブジェクトを割り当てています。
  • IDが1番のブログから、最新の記事を10件読み込み、変数$entriesに割り当てます。

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

$params = array('limit' => 10);
$entries = $api->listEntries(1, params);

3.メソッドの戻り値

メソッドの戻り値は、「totalResults」と「items」という2つの要素をもつ連想配列になります。
totalResultsは、条件に合うオブジェクトの総数を表します。
また、itemsは読み込んだオブジェクトの配列になります。

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