コアAPI

提供: MoodleDocs
移動先:案内検索

MoodleにはMoodleスクリプトにツールを提供する多くのコアAPIがあります。

コアAPIはMoodleプラグインを書く上では必要不可欠です。

最も利用される一般API

これらのAPIは極めて重要なものであり、ほとんどすべてのMoodleプラグインで使用されます。

アクセスAPI (アクセス)

アクセスAPIは現在のユーザに何を許可するのかを決定するための機能をあなたに提供します。同時にモジュールが新しい機能でMoodleを拡張できるようにします。

データ操作API (dml)

あなたはデータ操作APIで確実および安全にデータベースを読み書きできます。

ファイルAPI (files)

ファイルAPIは様々なプラグインとの接続においてファイルストレージをコントロールします。

フォームAPI (form)

フォームAPIはウェブフォーム経由のユーザデータを定義および処理します。

ロギングAPI (log)

ロギング2がログの記録および検索方法を記述するのに対してイベントAPIはMoodleのイベントを記録できます。

ナビゲーションAPI (navigation)

ナビゲーションAPIでアイテムの追加および削除等、自由にナビゲーションツリーを操作できます。

ページAPI (page)

ページAPIでは現在のページのセットアップ、JavaScriptの追加およびユーザへのコンテンツの表示方法を設定します。

アウトプットAPI (output)

アウトプットAPIはページのすべての部分でHTMLの表示に使用されます。

ストリングAPI (string)

ストリングAPIはユーザインターフェースで使用する言語テキストストリングを取得します。すべての利用可能な翻訳済み言語を処理します。

アップグレードAPI (upgrade)

アップグレードAPIはバージョンを追跡しながら、あなたのモジュールのインストールおよびアップグレードを処理します。

Moodlelib API (core)

Moodlelib APIはMoodleのその他一般的目的のMoodle関数の主ライブラリファイルです。関数はリクエストパラメータ、設定、ユーザプリファレンス、時間、ログイン、MNet、プラグイン、ストリングその他処理を超えれます。多くの定義済み定数もあります。

その他の一般API

管理設定API (admin)

Admin設定 APIはプラグインおよびMoodleコアの設定オプション提供を扱います。

アナリティクスAPI (analytics)

あなたはアナリティクスAPIで予測モデル作成および洞察生成ができます。

アベイラビリティAPI (availability)

アベイラビリティAPIは活動およびセクションへのアクセスをコントロールします。

バックアップAPI (backup)

バックアップAPIはバックアップ目的でのコースデータのXMLへの変換方法を定義します。また、リストアAPIはバックアップ済みデータの変換方法を定義します。

キャッシュAPI (cache)

The Moodle Universal Cache (MUC)はMoodle内にキャッシュデータを保存する構造です。あなたのコードでキャッシュを使用するために必要なものに関してキャッシュAPIで説明します。

カレンダーAPI (calendar)

あなたはカレンダーAPIでユーザ、グループ、コースまたはサイト全体のイベントをカレンダーに追加および修正できます。

チェックAPI (check)

あなたはチェックAPIでサイトにセキュリティ、パフォーマンスまたはヘルスチェックを追加できます。

コメントAPI (comment)

あなたのコードに簡単にコメントを追加できるようコメントAPIではユーザコメントを保存および検索できるようにします。

コンピテンシーAPI (competency)

あなたはコンピテンシーAPIで学習プランテンプレート、フレームワーク、コースおよび活動のコンピテンシーのエビデンスを一覧表示および追加できます。

データ定義API (ddl)

あなたはアップグレード中、テーブルの作成、変更および削除にデータ定義APIを使用できます。

エディタAPI

エディタAPIはHTMLテキストエディタのコントロールに使用されます。

登録API (enrol)

登録APIはコース参加者を扱います。

イベントAPI (event)

イベントAPIではあなたが好きな時に発生データをいつでも処理できるようにします。また、データ発生時にそのデータを扱うハンドラも指定できます。これはプラグイン間の推奨通信手段です。そして、これはMoodle内でのロギングのベースを作成します。

経験API (xAPI)

経験API (xAPI) は学習コンテンツと学習システムが相互連携できるようにするeラーニング標準です。すべてのプラグインは経験API (xAPI)を使用してxAPI標準命令文を生成および処理できます。

外部関数API (external)

あなたは外部関数APIで外部プログラム (ウェブサービス等) からアクセスできる完全にパラメータ化されたメソッドを作成できます。

お気に入りAPI

あなたはお気に入りAPIでユーザのお気に入りとしてアイテムをマークおよび管理できます。これは「星付き」とも呼ばれます。

ロックAPI (lock)

あなたはクラスタ内の別のノードであったとしても、ロックAPIで複数リクエスト間の処理を同期できます。

メッセージAPI (message)

あなたはメッセージAPI でユーザにメッセージを送信できます。また、メッセージの受信方法を選択できます。

メディアAPI (media)

メディアAPIはオーディオ、ビデオ等のメディアアイテムの埋め込みに使用できます。

マイプロファイルAPI

マイプロファイルAPIはプロファイルページへの情報追加に使用されます。

OAuth 2 API (oauth2)

OAuth 2 APIはOAuth 2を使用する外部システムを設定および管理するための一般的な場所の提供に使用されます。

プリファレンスAPI (preference)

プリファレンスAPIは個別のユーザのプリファレンスを保存および検索するためのシンプルな方法です。

ポートフォリオAPI (portfolio)

あなたはポートフォリオAPIでページにポートフォリオインターフェースを追加できます。また、ユーザがポートフォリオのコンテンツを最新にできます。

プライバシーAPI (privacy)

あなたは保存する個人データをプライバシーAPIで説明できます。 また、ユーザベースで発見、エクスポートおよび削除されるデータの意味を提供できます。 ここではヨーロッパの一般データ保護規則 (General Data Protection Regulation - GDPR) のような法令を遵守するようにもできます。

評価API (rating)

評価APIでユーザがあなたのプラグイン内のアイテムを評価するためのAJAX評価インターフェースを作成できます。また、あなたは活動モジュール内で評点を合計して成績を作成できます。

RSS API (rss)

RSS APIであなたのモジュール内データのセキュアRSSフィードを作成できます。

検索API (search)

あなたは検索APIで検索エンジンのコンテンツをインデックス化できます。また、 検索エンジンに結果を問い合わせできます。

タグAPI (tag)

あなたはタグAPIでモジュール内のアイテムにタグ (およびタグクラウド) を保存できます。

タスクAPI (task)

あなたはタスクAPIでバッググラウンドジョブを1回のみ、または定期的に実行できます。

時間API (time)

時間APIはサイト内のユーザ間の時間の変換および表示を担当します。

テストAPI (test)

テストAPIには単体テストAPI (PHPUnit) および承認テストAPI (承認テスト) を含みます。理想的には新しいすべてのコードは最初に単体テストから書いてください。

ユーザ関連API (user)

これは多岐にわたるユーザ一覧の並べ替えおよび検索に関するユーザ関連APIの非公式グルーピングです。

ウェブサービスAPI (webservice)

あなたはウェブサービスAPIで特定の関数 (一般的に外部関数) をウェブサービスとして公開できます。

バッジAPI (badges)

バッジユーザドキュメンテーションです (あなたが特定のバッジおよびオープンバッジバックパックを管理できるすべてのクラスおよびAPIで適切なページをコンパイルするまでの一時的なページです)。

カスタムフィールドAPI

あなたはカスタムフィールドAPIで様々なエントリのカスタムフィールドを設定および追加できます。

活動モジュールAPI

活動モジュールはMoodleで最も重要なプラグインです。活動モジュールに対してのみ提供されるいくつかのコアAPIがあります。

活動完了API (completion)

活動完了APIはどのように活動が完了されるかシステムに示します。

高度な評定API (grading)

あなたは高度な評定APIで評定表にさらに高度な評定インターフェース (ルーブリック等) を追加できます。高度な評定インターフェースではシンプルな評定を実現できます。

条件付き活動API (condition) - 2.7で廃止

廃止予定の条件付き活動APIはMoodle 2.6以降のモジュールおよびセクションへの条件アクセスの提供に使用されます。このAPIはアベイラビリティAPIと入れ替えられました。

グループAPI (group)

あなたはグループAPIで活動のグループモードを確認および設定できます。

評定表API (grade)

あなたは評定表APIで評定表を読み込みおよび書き込みできます。 また、あなたは詳細評定情報のインターフェースを提供できます。

盗作API (plagiarism)

盗作APIは盗作をチェックするために活動モジュールがファイルおよびデータを外部サービスに送信できるようにします。

問題API (question)

問題API (問題バンクAPIおよび問題エンジンAPIに分離できます) は問題バンクの問題を利用したい活動によって使用できます。

関連情報