「コアAPI (Dev docs)」の版間の差分

2022年12月2日 (金) 05:07時点における版

English page: dev: Core APIs

Moodleには、Moodleスクリプトのためのツールを提供する、いくつかのコアAPIがあります。

これらはMoodleプラグインを書く際に必要不可欠です。

最も利用されている一般的なAPI

これらのAPIは重要であり、ほぼすべてのMoodleプラグインで使用されます。

アクセスAPI (access)

アクセスAPIは、現在のユーザに何が許可されているかを判断するための関数を提供し、モジュールが新しい機能でMoodleを拡張することを可能にします。

データ操作API (dml)

データ操作APIを使うと、データベースに対して一貫した安全な方法で読み書きができるようになります。

ファイルAPI (file)

ファイルAPIは、様々なプラグインと連携してファイルの保存を制御します。

フォームAPI (form)

フォームAPIは、Webフォームを介したユーザデータの定義と処理を行います。

ロギングAPI (log)

イベントAPIではMoodleのイベントを記録することができ、ロギング2ではログがどのように保存および取得されるかについて説明されています。

ナビゲーションAPI (navigation)

ナビゲーションAPIを使うと、ナビゲーションツリーを操作して、アイテムを自由に追加したり削除したりすることができます。

ページAPI (page)

ページAPIは、現在のページの設定、JavaScriptの追加、ユーザへの表示方法の設定に使用されます。

アウトプットAPI (output)

ページのすべての部分のHTMLをレンダリングするためにアウトプットAPIが使用されます。

ストリングAPI (string)

ストリングAPIは、ユーザインターフェースで使用する言語のテキスト文字列を取得する方法です。これは、利用できるかもしれないあらゆる言語の翻訳を処理します。

アップグレードAPI (upgrade)

アップグレードAPIは、モジュールが自身のバージョンを追跡することで、インストールとアップグレードを行う方法です。

Moodlelib API (core)

Moodlelib APIは、雑多な汎用Moodle関数のセントラルライブラリファイルです。関数はリクエストパラメータ、設定、ユーザ設定、時間、ログイン、mnet、プラグイン、文字列および他の処理を行うことができます。また、多くの定数も定義されています。

その他一般的なAPI

管理者設定API (admin)

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

管理者プリセットAPI (adminpresets)

管理者プリセットAPIは、プラグインがサイト管理者プリセットに関連するいくつかの決定や実装を行うことができるようにするものです。

アナリティクスAPI (analytics)

アナリティクスAPIを使用すると、予測モデルを作成したり、インサイトを生成したりすることができます。

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

活動やセクションへのアクセスを制御するアベイラビリティAPI があります。

バックアップAPI (backup)

バックアップAPIはバックアップのためにコースデータをXMLに変換する方法を正確に定義し、リストアAPIはそれを逆に変換する方法を記述しています。

キャッシュAPI (cache)

Moodleユニバーサルキャッシュ (MUC) はMoodle内でキャッシュデータを保存するための構造体です。キャッシュAPIでは、あなたのコードでキャッシュを使用するために必要なもののいくつかを説明しています。

カレンダーAPI (calendar)

カレンダーAPIを使用すると、ユーザ、グループ、コース、またはサイト全体のカレンダーにイベントを追加および変更することができます。

チェックAPI (check)

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

コメントAPI (comment)

コメントAPIを利用すると、ユーザのコメントを保存・取得することができ、どのようなコードにも簡単にコメントを追加することができます。

コンピテンシーAPI (competency)

コンピテンシーAPIでは、学習計画、学習計画テンプレート、フレームワーク、コース、活動にコンピテンシーのエビデンスをリストアップして追加することが可能です。

データ定義API (ddl)

データ定義APIは、アップグレードの際にデータベースのテーブルやフィールドを作成、変更、削除するために使用するものです。

エディタAPI

HTMLテキストエディタの制御にはエディタAPIが使用されます。

登録API (enrol)

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

イベントAPI (event)

イベントAPIでは、好きな時に発生させるペイロードデータを持つ "イベント" を定義し、そのイベントが発生した時に対応するハンドラを定義することができます。これはプラグイン間通信の推奨形式です。これはまた、Moodleのロギングの基礎を形成します。

エクスペリエンスAPI (xAPI)

エクスペリエンスAPI（xAPI）は、学習コンテンツと学習システムが相互に会話できるようにするためのeラーニング標準規格です。エクスペリエンスAPI (xAPI)は、任意のプラグインでxAPI規格文を生成して処理することができます。

外部関数API (external)

外部関数APIを使うと、外部プログラム（Webサービスなど）からアクセスできる、完全にパラメータ化されたメソッドを作成することができます。

お気に入りAPI

お気に入りAPIを使用すると、あるユーザのアイテムをお気に入りとしてマークし、そのお気に入りを管理することができます。これはしばしば 'スター付き' と呼ばれます。

H5P API (h5p)

H5P APIは、プラグインがH5Pインテグレーションに関連するいくつかの決定や実装を行うことを可能にします。

ロックAPI (lock)

ロックAPIを使うと、クラスタ内の別々のノードであっても、複数のリクエストの間で処理を同期させることができます。

メッセージAPI (message)

メッセージAPIを使うと、ユーザに対してメッセージを投稿することができます。ユーザはそれをどのように受け取りたいかを決めることができます。

メディアAPI (media)

メディア APIを使用すると、オーディオ、ビデオ、Flashなどのメディアアイテムを埋め込むことができます。

マイプロファイルAPI

マイプロファイルAPIは、プロファイルページに何かを追加するために使用されます。

OAuth 2 API (oauth2)

OAuth 2 APIは、OAuth 2を利用した外部システムの設定や管理を共通化するために利用します。

ペイメントAPI (payment)

ペイメントAPIは、決済を扱うAPIです。

プリファレンスAPI (preference)

プリファレンスAPIは、個々のユーザのプリファレンスを保存し、取得するためのシンプルな方法です。

ポートフォリオAPI (portfolio)

ポートフォリオAPIを使用すると、ページ上にポートフォリオのインターフェースを追加したり、ユーザがデータをパッケージ化してポートフォリオに送信したりすることができます。

プライバシーAPI (privacy)

プライバシーAPIは、保存する個人データを記述し、ユーザごとにデータの発見、エクスポート、削除を行うための手段を提供するものです。これにより、欧州の一般データ保護規則（GDPR）などの規制に対応することができます。

評価API (rating)

評価API を使用すると、ユーザがプラグインのアイテムを評価できるように、AJAX評価インターフェースを作成できます。活動モジュールでは、評価を形成するために評定を集約することを選択することができます。

レポートビルダーAPI (reportbuilder)

レポートビルダーAPIを使用すると、プラグインでレポートを作成したり、ユーザが独自のレポートを作成するために使用するカスタムレポートデータを提供することができます。

RSS API (rss)

RSS APIは、モジュール内のデータの安全なRSSフィードを作成することができます。

検索API (search)

検索APIは、検索エンジンでコンテンツのインデックスを作成し、検索エンジンに結果を問い合わせることができます。

タグAPI (tag)

タグAPI では、モジュール内のアイテムにタグ（およびタグクラウド）を保存することができます。

タスクAPI (task)

タスクAPIAは、バックグラウンドで作業を実行することができます。一度だけ実行することも、定期的に実行することもできます。

時間API (time)

時間API は、サイト内のユーザー間の時間を翻訳して表示する役割を担っています。

テストAPI (test)

テストAPIには、ユニットテスト API (PHPUnit) とアクセプタンステスト API (アクセプタンステスト) が含まれます。理想を言えば、すべての新しいコードにはまずユニットテストを書くべきです。

ユーザ関連APIs (user)

これは、ユーザリストのソートや検索に関連する雑多なユーザ関連APIのやや非公式なグループ化です。

WebサービスAPI (webservice)

WebサービスAPIを使用すると、特定の機能（通常は外部機能）をWebサービスとして公開することができます。

バッジAPI (badges)

バッジユーザドキュメント (特定のバッジと OpenBadges Backpack を管理できるすべてのクラスと API を含む適切なページをコンパイルするまでの暫定ページです)。

カスタムフィールドAPI

カスタムフィールドAPIを使用すると、さまざまなエンティティに対してカスタムフィールドを設定および追加することができます。

活動モジュールAPIs

活動モジュールはMoodleで最も重要なプラグインです。活動モジュールのみにサービスを提供する、いくつかのコアAPIがあります。

活動完了API (completion)

活動完了APIは、活動がどのように完了したかをシステムに指示するためのものです。

高度な評定API (grading)

高度な評定APIを使用すると、評定表用の簡単な評点を作成できる、より高度な評定インターフェース (ルーブリックなど) を追加することができます。

条件付き活動API (condition) - 2.7 で非推奨

非推奨の条件付き活動APIはMoodle 2.6以降でモジュールおよびセクションへの条件付アクセスを提供するために使用されてきました。これはアベイラビリティAPIに置き換わりました。

グループAPI (group)

グループAPIでは、現在の活動グループのモードを確認したり、現在のグループを設定したりすることができます。

評定表API (grade)

評定表APIを使用すると、評定表から読み書きができるようになります。また、詳細な評定情報のためのインターフェイスを提供することもできます。

Plagiarism API (plagiarism)

The Plagiarism API allows your activity module to send files and data to external services to have them checked for plagiarism.

Question API (question)

The Question API (which can be divided into the Question bank API and the Question engine API), can be used by activities that want to use questions from the question bank.

@@ 133行目: / 133行目: @@
 [[グループAPI]]では、現在の活動グループのモードを確認したり、現在のグループを設定したりすることができます。
-=== Gradebook API (grade) ===
+=== 評定表API (grade) ===
-The [[Gradebook API]] allows you to read and write from the gradebook. It also allows you to provide an interface for detailed grading information.
+[[評定表API]]を使用すると、評定表から読み書きができるようになります。また、詳細な評定情報のためのインターフェイスを提供することもできます。
 === Plagiarism API (plagiarism) ===
 The [[Plagiarism API]] allows your activity module to send files and data to external services to have them checked for plagiarism.

Documentation