API:Calling internally/ja

このページは MediaWiki API 説明文書の一部です。

言語:	English  • 日本語

MediaWiki API

Quick overview:

• Quick start guide
• FAQ /en
  • エチケットおよび使用制限 /en
• チュートリアル /en
• フォーマット
• エラーの報告
• Restricting usage /en
• Cross-site requests /en
• 認証
  • ログイン
  • ログアウト
  • アカウント作成 /en
• クエリ
  • メタ情報
  • プロパティ
  • 一覧
• 検索の提案 /en
• テンプレートを拡張しレンダリングする
• ページのキャッシュの破棄 /en
• パラメーター情報 /en
• ウィキの本文の変更
  • ページの作成/編集
  • ページの移動
  • ロールバック
  • ページの削除
  • 削除された版の復元
  • ページの保護/保護解除
  • 利用者のブロック/ブロック解除
  • ページのウォッチ/ウォッチ解除 /en
  • メールの送信 /en
  • 変更の巡回 /en
  • ページの取り込み /en
  • Change user group membership /en
  • ファイルのアップロード /en
  • 利用者オプション /en
• ウォッチリストのフィード /en
• ウィキデータ /en
• 拡張機能 /en
• MediaWikiおよび拡張機能内でのAPIの使用
• その他
• 実装
• クライアント コード

APIを内部の別のコードで使う(done)

ときに別の部分のコードでデータアクセスとAPIの集約機能を使いたいと思うことがあります。Here are the steps needed to accomplish such usage:

1) FauxRequestクラスを使ってリクエストパラメータを準備します。ウェブ越しでリクエストを作ることに関してすべてのパラメータは同じです。

$params = new FauxRequest(array (
        'action' => 'query',
        'list' => 'allpages',
        'apnamespace' => 0,
        'aplimit' => 10,
        'apprefix' => $search
));

2) ApiMainインスタンスを作り実行します。 パラメータはFauxRequestオブジェクトのインスタンスなので、ApiMainはフォーマッティングのprintersを実行するのでもエラーを取り扱うのでもありません。パラメータエラーもしくは別の内部エラーはコードを呼び出す際にキャッチされる例外を引き起こします。

$api = new ApiMain($params);
$api->execute();

3) 結果のデータ配列を取得します。

$data = & $api->getResultData();

拡張機能でAPIモジュールを作る(done)

拡張機能はAPIモジュールを提供できるようになります。r25364で追加されました。