サーバー管理／ウェブアプリケーション開発

スニペット、プラグイン、モジュールなどのすべての開発において、ソース中でmodx のドキュメント変数やデータベース操作関数など、modx が知っている情報を参照することができます。それらはmodx API と呼ばれ、公式wiki(http://wiki.modxcms.com/index.php/Main_Page) にまとめて掲載されています。

[図01]公式wiki

上記URL にアクセスし、All Categories のうち、API Pages にアクセスします。「API:DocumentParser」とありますが、DocumentParser APIこそがmodx のコアとなるAPI となり、DocumentParser に収録されているプロパティ、メソッドを使えばmodx が把握するおおよその情報を利用することができます。

[図02]DocumeotParser API の構造

上記ページのうち、Object variables はプロパティ、API functions はメソッドとして利用できます。Child Classes は別API のインスタンスが格納されているプロパティとなりますが、そのうちDBAPI はmodx データベースを操作するための重要なAPI となります。これは、[図01]公式wiki > All Categories > API Pages の中で「API:DBAPI」をクリックした先で詳細が確認できます。

modx の開発はこれらAPI を駆使して行うものであり、API の仕様と使い方さえ覚えてしまえば自由にmodx を拡張することができます。

開発を行う際には独自クラスを作成し、インクルードするなどして利用すると思います。独自クラスのメソッドでmodx API を利用する場合は、上記のようにメソッドの開始位置に上記コードを埋め込んでください。

ただし、modx 管理画面で直接コードを書く場合(モジュールのモジュールコード(php) 等) は$modx はmodx によって定義済みとなるので上記コードの埋め込みは必要ありません。

次のコードはデータベースよりリソース情報を取り出します。独自クラスの中でメソッドを定義して利用することを前提としています。このように実際の開発では $modx をベースに様々な情報を引き出してコーディングしていきます。