Mahara日本語ドキュメント/開発者エリア/Maharaアーキテクチャ解説: Difference between revisions

Latest revision as of 12:38, 1 February 2022

このドキュメントはMaharaアーキテクチャの基本情報およびコードの繋がりの情報提供を目的としています。このドキュメントを読むことにより、Maharaの連携、プラグイン開発による拡張、コアコードのハッキングに関して理解できます。

概要

MaharaはPHPで書かれたウェブアプリケーションであり、Moodle、Drupal、phpBB等に良く似ています。フレームワークのような機能を提供するため、Maharaはいくつかのライブラリを提供しますが、これ自体はZendフレームワークのようなPHPのフレームワークをベースにしていません。実際のところ、Maharaはデータベースアクセスおよびフォーム構築のようなフレームワークを提供しています。そして、あなたはその中で作業を進める必要があります。また、プラグインアーキテクチャにより、あなたのカスタマイズはコアコードの改変を避けることができます。この点において、MaharaはDrupalおよびMoodleのようなプラグイン設置可能なソフトウェアに非常に類似しています。

Maharaへのリクエストは特定のPHPスクリプトにヒットします。現在、ディスパッチャはありません。ホームページへのリクエストはindex.php等により扱われます。これらのスクリプトはMaharaコアを読み込んで、必要なデータを検索して、必要なデータ構造またはフォームを生成して、それらを表示するためテンプレータに渡しています。これはどのPHPスクリプトがどのページを生成するのかを簡単に把握できるシンプルなモデルです。「クリーンURL」の利点を失うことになりますが、多くのウェブサイトにとって移植可能な方法でもあります。

Maharaコアのコンセプトはプラグインです。仮にコア機能であったとしても、Maharaの大部分の機能はプラグインを書いた上で実装されています。そして、あなたが変更したいMaharaの一部分がプラグインに対応していない場合、Maharaは簡単に改変できるよう設計されています。

ハッカビリティ

Maharaは基本部分からすべてにおいて、高度に着脱および簡単に改造できるよう設計されています。PHPおよびLAMPスタックに慣れた多くの開発者が存在するため、私たちはMaharaを意図的にPHPで書くようにしました。MaharaはLinuxからSolaris/BSD/Macへの移行、ApacheからNginx/Lighttpdへの移行、およびMySQLからPostgreSQL (推奨DBMS) への移行も含めて、多くの様々なLAPM環境で動作させることができます。Maharaチームが厳密にテストしたわけではありませんが、MaharaをWindowsおよびIISで動作させた人もいます。パッチも歓迎します :)

パッチに関して話しますと、すでにご存知のようにMaharaは無料のオープンソースです。Maharaの小規模開発部隊は新しい機能、バグ修正、フォーラムでのサポート、Maharaの一般的な改善に日々携わっています。新しい機能の開発からMaharaの最良な利用の提案に関するバグレポートの投稿等、開発部隊のまわりには熱心なコミュニティ、翻訳者、ボランティア、開発者および多くの部分でMaharaの改善に尽力するユーザがいます。重要な点はMaharaがフリーソフトウェアであり、あなたが思う存分ハック (改造) できることです!

プラグインシステム

Maharaアーキテクチャの重要な特徴はプラグインシステムであることです。ユーザのコンテンツタイプからユーザ認証方法、検索方法の実装、グループの運用方法まで、Maharaのすべての部品は脱着可能です。Maharaのすべてのプラグインは「タイプ」 (次のセクションで説明します) に関わらずcronジョブの登録およびイベントの予約のような機能を共有しています。プラグインを書く作業が簡単になるよう、すぐに使える多くのサブシステムもあります。

プラグインタイプ

Maharaの部品は着脱可能ですが、特にAPIはこの目的で作成されています。例えば、検索APIが要求される検索結果を扱うためのメソッドを提供するのに対して、ユーザコンテンツタイプAPIはコンテンツ自体および所有権を取り扱うためのメソッドを含みます。私たちはこれらすべてを異なるプラグインのタイプと呼んでいます。以下、いくつかの例を挙げます:

アーティファクトプラグインタイプではユーザのコンテンツを取り扱います (ユーザコンテンツのアイテムはアーティファクトと呼ばれるため、このプラグイン名となりました)。
認証プラグインタイプはユーザアカウントの認証のためのAPIです。
ブロックタイププラグインタイプはシステムへの着脱可能な新しいタイプのブロックの設置を提供します。

Mahara 1.1では次のタイプのプラグインを利用できます: アーティファクト、認証、ブロックタイプ、グループタイプ、インタラクション、通知および検索。

このアプローチにはいくつかの素晴らしい利点があります。例えばシステムの一部としてプラグインの1つが使用された場合、私たちはそれぞれのプラグインにAPIをサポートするかどうか尋ねる必要はありません - 正しいタイプのプラグインのみが使用されます。実際の必要条件のため、私たちはプラグインタイプでAPIをカスタマイズできます。例えば検索を扱うプラグインは検索APIメソッドを実装するだけであり、ユーザコンテンツ、通知または他の関連する内容をサポートしないと伝える必要はありません。

ディスク上では: プラグインタイプは「htdocs/」フォルダ (ディレクトリ) 内にそれぞれディレクトリを持ちます。これらすべてのディレクトリにはlib.phpが含まれます。

プラグイン

前のセクションを前提とした場合、プラグイン自体は単にプラグインタイプのインスタンスでしかありません。ですから、例えばアーティファクトの場合、Maharaコアにはブログ、ファイルマネージャ、レジュメおよびプロファイル情報が同梱されます。そして通知においてMaharaには「内部」 (ユーザの活動ログへのログメッセージを記録)、メールおよびメールダイジェストがあります。

それぞれのプラグインでは少なくとも1つのクラス定義を含むlib.phpファイルを提供する必要があります。このクラスはプラグインによるcronジョブおよびイベント登録を可能とします。また、そのプラグインタイプのさらに特別な機能を引き込むこともできます。例えばアーティファクトプラグインにはメインメニューに新しいメニューアイテムを追加できます。

アーティファクトプラグインに関して言えば、それぞれのプラグインはページ描写に必要な1つまたはそれ以上のPHPスクリプトも提供します。このようにしてアーティファクトプラグインはコンテンツを管理するための高度なカスタムインターフェースを提供しながら、コンテンツのほかのアイテムと様々なプロパティを共有できる利点を獲得しています。

ディスク上: それぞれのプラグインは適切なプラグインタイプサブディレクトリのサブディレクトリです。lib.phpおよびversion.php、そしてデータベーステーブルを必要とする場合、「db/」ディレクトリが提供されます。いくつかのプラグインタイプには他のディレクトリもあります - 例) theme/ または blocktype/

コード内: それぞれのプラグインのlib.phpにはプラグインを拡張するプラグインクラスが含まれます。例えば、PluginArtefactBlogはPluginArtefactを拡張します。これにより適切なAPIが実装されます。他のクラスはプラグインタイプによっては必要な場合があります。

次へ: コアコンポーネント

サブページ

@@ Line 1: / Line 1: @@
-作成中です - [[User:Mits|mits]] ([[User talk:Mits|talk]])
+このドキュメントはMaharaアーキテクチャの基本情報およびコードの繋がりの情報提供を目的としています。このドキュメントを読むことにより、Maharaの連携、プラグイン開発による拡張、コアコードのハッキングに関して理解できます。
-このドキュメントはMaharaのアーキテクチャおよびそれがコードにどのように対応しているかについての基本的な導入書を提供することを目的としています。このドキュメントを読むことであなたはMaharaがどのように組み合わされているのか、そしてあなたがプラグインを書く、またはコアコードをハックすることでどのように拡張できるかについて合理的に理解できるはずです。
 <div id="section_1">
-==概要 Overview==
+==概要==
+MaharaはPHPで書かれたウェブアプリケーションであり、Moodle、Drupal、phpBB等に良く似ています。フレームワークのような機能を提供するため、Maharaはいくつかのライブラリを提供しますが、これ自体はZendフレームワークのようなPHPのフレームワークをベースにしていません。実際のところ、Maharaはデータベースアクセスおよびフォーム構築のようなフレームワークを提供しています。そして、あなたはその中で作業を進める必要があります。また、プラグインアーキテクチャにより、あなたのカスタマイズはコアコードの改変を避けることができます。この点において、MaharaはDrupalおよびMoodleのようなプラグイン設置可能なソフトウェアに非常に類似しています。
-MaharaはPHPで書かれたウェブアプリケーションであり、Moodle、Drupal、phpBB等と極めて類似しています。フレームワークのような機能を提供するためいくつかのライブラリを使用しますが、それ自体はZendフレームワークのようなPHPフレームワークをベースとしているわけではありません
+Maharaへのリクエストは特定のPHPスクリプトにヒットします。現在、ディスパッチャはありません。ホームページへのリクエストはindex.php等により扱われます。これらのスクリプトはMaharaコアを読み込んで、必要なデータを検索して、必要なデータ構造またはフォームを生成して、それらを表示するためテンプレータに渡しています。これはどのPHPスクリプトがどのページを生成するのかを簡単に把握できるシンプルなモデルです。「クリーンURL」の利点を失うことになりますが、多くのウェブサイトにとって移植可能な方法でもあります。
-実際のところ、Maharaはデータベースアクセス/フォーム構築のためのライブラリおよびプラグインアーキテクチャ等、あなたがその中で作業するために必要なフレームワークを提供して、あなたのカスタマイズをコアのハッキングから遠ざけることを可能にします。この意味においてMaharaはDrupalおよびMoodleのようなプラグイン脱着可能な製品と極めて類似しています。
-Requests that come to Mahara hit specific PHP scripts. There is no dispatcher currently. Requests for the homepage are served by index.php, etc. These scripts load the Mahara core, retrieve the data they need, generate any data structures or forms necessary, then pass that to a templater for display. It's a simple model to understand, where it's easy to tell which PHP script generated which page. It's also portable across many web servers, though it misses the benefits of "clean URLs".
+Maharaコアのコンセプトは'''プラグイン'''です。仮にコア機能であったとしても、Maharaの大部分の機能はプラグインを書いた上で実装されています。そして、あなたが変更したいMaharaの一部分がプラグインに対応していない場合、Maharaは簡単に改変できるよう設計されています。
-At the core of Mahara is the concept of a '''plugin'''. The vast majority of Mahara's functionality - even core functionality - is implemented by writing plugins. And if the part of Mahara you wish to change is not pluggable, Mahara is designed to be easy to hack.
 </div><div id="section_2">
-==Hackability==
+==ハッカビリティ==
-Mahara has been designed from the ground up to be highly pluggable, and easy to hack. We deliberately chose to write Mahara in PHP for this reason - as there is a huge collection of developers who are familiar with PHP, and also the LAMP stack. Mahara can run on many variations LAMP, including swapping Linux for Solaris/BSD/Mac, Apache for Nginx/Lighttpd, and MySQL for PostgreSQL (which is the preferred DBMS to use). People have also got Mahara going under Windows and IIS, though the Mahara team doesn't explicitly test under such conditions. Patches are welcome :)
+Maharaは基本部分からすべてにおいて、高度に着脱および簡単に改造できるよう設計されています。PHPおよびLAMPスタックに慣れた多くの開発者が存在するため、私たちはMaharaを意図的にPHPで書くようにしました。MaharaはLinuxからSolaris/BSD/Macへの移行、ApacheからNginx/Lighttpdへの移行、およびMySQLからPostgreSQL (推奨DBMS) への移行も含めて、多くの様々なLAPM環境で動作させることができます。Maharaチームが厳密にテストしたわけではありませんが、MaharaをWindowsおよびIISで動作させた人もいます。パッチも歓迎します :)
-Speaking of patches, Mahara is free, open source software (as you probably already know). There is a small army of developers on the team working on new functionality, bug fixes, helping in the forums and generally improving Mahara every day. Surrounding them is a community of enthusiasts, translators, volunteers, developers and users who improve Mahara in many ways - from developing new features to reporting bugs to suggesting the best way to use Mahara. The point is, it's free software which means you're absolutely encouraged to hack it to death!
+パッチに関して話しますと、すでにご存知のようにMaharaは無料のオープンソースです。Maharaの小規模開発部隊は新しい機能、バグ修正、フォーラムでのサポート、Maharaの一般的な改善に日々携わっています。新しい機能の開発からMaharaの最良な利用の提案に関するバグレポートの投稿等、開発部隊のまわりには熱心なコミュニティ、翻訳者、ボランティア、開発者および多くの部分でMaharaの改善に尽力するユーザがいます。重要な点はMaharaがフリーソフトウェアであり、あなたが思う存分ハック (改造) できることです!
 </div><div id="section_3">
-==Plugin System==
+==プラグインシステム==
-A key feature of Mahara's architecture is the plugin system. All sorts of parts of Mahara are pluggable - from the types of content users can have, to how users are authorised, right through to how search is implemented and how groups work. All plugins in Mahara, regardless of their '''type''' (more on that in the next section), share some functionality such as the ability to register cron jobs and subscribe to events. There are quite a few subsystems in place to make the job of writing plugins easier as well.
+Maharaアーキテクチャの重要な特徴はプラグインシステムであることです。ユーザのコンテンツタイプからユーザ認証方法、検索方法の実装、グループの運用方法まで、Maharaのすべての部品は脱着可能です。Maharaのすべてのプラグインは「タイプ」 (次のセクションで説明します) に関わらずcronジョブの登録およびイベントの予約のような機能を共有しています。プラグインを書く作業が簡単になるよう、すぐに使える多くのサブシステムもあります。
 <div id="section_4">
-===Plugin Types===
+===プラグインタイプ===
-Where parts of Mahara are pluggable, an API has been created especially for that purpose. For example, the API for user content types contains methods dealing with the content itself and ownership of the content, while the searching API provides methods detailing what search results are required. We call all of these a different '''type''' of plugin. Here are some examples:
+Maharaの部品は着脱可能ですが、特にAPIはこの目的で作成されています。例えば、検索APIが要求される検索結果を扱うためのメソッドを提供するのに対して、ユーザコンテンツタイプAPIはコンテンツ自体および所有権を取り扱うためのメソッドを含みます。私たちはこれらすべてを異なるプラグインの'''タイプ'''と呼んでいます。以下、いくつかの例を挙げます:
-* The '''artefact''' plugin type deals with user content (an item of user content is called an artefact, hence the name).
+* '''アーティファクト'''プラグインタイプではユーザのコンテンツを取り扱います (ユーザコンテンツのアイテムはアーティファクトと呼ばれるため、このプラグイン名となりました)。
-* The '''auth''' plugin type has an API for authorising user accounts.
+* '''認証'''プラグインタイプはユーザアカウントの認証のためのAPIです。
-* The '''blocktype''' plugin type provides a pluggable way to put new types of block into the system.
+* '''ブロックタイプ'''プラグインタイプはシステムへの着脱可能な新しいタイプのブロックの設置を提供します。
-As of Mahara 1.1, the following plugin types are available: artefact, auth, blocktype, grouptype, interaction, notification and search.
+Mahara 1.1では次のタイプのプラグインを利用できます: アーティファクト、認証、ブロックタイプ、グループタイプ、インタラクション、通知および検索。
-This approach has some nice benefits. For example, in parts of the system where one of the plugin types is being used, we don't have to ask every single plugin in the system whether it supports the API - only plugins of the correct type will be used. Plugin types also allows us to customise the API for the actual requirements. For example, a plugin dealing with search can just implement the search API methods, and doesn't have to say that it doesn't support user content, notifications or anything else for that matter.
+このアプローチにはいくつかの素晴らしい利点があります。例えばシステムの一部としてプラグインの1つが使用された場合、私たちはそれぞれのプラグインにAPIをサポートするかどうか尋ねる必要はありません - 正しいタイプのプラグインのみが使用されます。実際の必要条件のため、私たちはプラグインタイプでAPIをカスタマイズできます。例えば検索を扱うプラグインは検索APIメソッドを実装するだけであり、ユーザコンテンツ、通知または他の関連する内容をサポートしないと伝える必要はありません。
-On disk: Each plugin type has a directory in the htdocs/ folder. Each of these directories contains a lib.php
+ディスク上では: プラグインタイプは「htdocs/」フォルダ (ディレクトリ) 内にそれぞれディレクトリを持ちます。これらすべてのディレクトリにはlib.phpが含まれます。
 </div><div id="section_5">
-===Plugins===
+===プラグイン===
-Given the previous section, the plugins themselves are simply instances of a plugin type. So for example, for artefact, the Mahara core ships with plugins for blogs, a file manager, resume and profile information. And in notification, Mahara has 'internal' (which logs messages to a user's activity log), email and emaildigest.
+前のセクションを前提とした場合、プラグイン自体は単にプラグインタイプのインスタンスでしかありません。ですから、例えばアーティファクトの場合、Maharaコアにはブログ、ファイルマネージャ、レジュメおよびプロファイル情報が同梱されます。そして通知においてMaharaには「内部」 (ユーザの活動ログへのログメッセージを記録)、メールおよびメールダイジェストがあります。
-Each plugin has to provide a lib.php, which contains at least one class definition. This class allows the plugin to register cron jobs and events, and also hook into more specific functionality for that plugin type. For example, artefact plugins can register new menu items for the main menu.
+それぞれのプラグインでは少なくとも1つのクラス定義を含むlib.phpファイルを提供する必要があります。このクラスはプラグインによるcronジョブおよびイベント登録を可能とします。また、そのプラグインタイプのさらに特別な機能を引き込むこともできます。例えばアーティファクトプラグインにはメインメニューに新しいメニューアイテムを追加できます。
-In the case of artefact plugins, each plugin can also provide one or more PHP scripts that render pages it requires. In this way, artefact plugins can present highly custom interfaces for managing content, while gaining all the benefits of sharing various properties with other items of content.
+アーティファクトプラグインに関して言えば、それぞれのプラグインはページ描写に必要な1つまたはそれ以上のPHPスクリプトも提供します。このようにしてアーティファクトプラグインはコンテンツを管理するための高度なカスタムインターフェースを提供しながら、コンテンツのほかのアイテムと様々なプロパティを共有できる利点を獲得しています。
-'''On disk:''' Each plugin is a subdirectory under the appropriate plugin type subdirectory. It provides a lib.php and version.php, and if it needs database tables, a db/ directory. Some plugin types have other directories too - such as theme/ or blocktype/.
+'''ディスク上:''' それぞれのプラグインは適切なプラグインタイプサブディレクトリのサブディレクトリです。lib.phpおよびversion.php、そしてデータベーステーブルを必要とする場合、「db/」ディレクトリが提供されます。いくつかのプラグインタイプには他のディレクトリもあります - 例) theme/ または blocktype/
-'''In code:''' Each plugin's lib.php contains a Plugin class which extends Plugin. E.g., PluginArtefactBlog which extends PluginArtefact. This implements the appropriate API. Other classes may be necessary depending on the plugin type.
+'''コード内:''' それぞれのプラグインのlib.phpにはプラグインを拡張するプラグインクラスが含まれます。例えば、PluginArtefactBlogはPluginArtefactを拡張します。これにより適切なAPIが実装されます。他のクラスはプラグインタイプによっては必要な場合があります。
-'''Next: '''[[Developer Area/Mahara Architecture Introduction/Core Components|'''Core Components''']]
+'''次へ: '''[[開発者エリア/Maharaアーキテクチャイントロダクション/コアコンポーネント|'''コアコンポーネント''']]
 </div></div>
-===Subpages===
+===サブページ===
+* [[開発者エリア/Maharaアーキテクチャイントロダクション/コアコンポーネント|コアコンポーネント]]
-* [[Developer_Area/Mahara_Architecture_Introduction/Core_Components|Core Components]]
+* [[開発者エリア/Maharaアーキテクチャイントロダクション/コアサブシステム|コアサブシステム]]
-* [[Developer_Area/Mahara_Architecture_Introduction/Core_Subsystems|Core Subsystems]]
+[[Category:開発者エリア]]
-[[Category:Developer Area]]