CMSモジュールを組み込み、カスタマイズする

チュートリアルの前提条件と目的

このチュートリアルには、bluetronix CMSへの開発者アクセスが必要です。開発者フォルダーの機能と、独自のファイルが_ownでマークされる理由をすでに理解している必要があります。

既存のNews - Blogモジュールを例として使用します。モジュールを有効化し、そのリストビューをCMSページに組み込み、その後、自分のモジュールファイルと構成をターゲットを絞って調整します。オリジナルファイルは変更されません。

1. ブログモジュールを有効化する

CMSでモジュールを開き、News - Blogを選択します。

ブログモジュールを有効化オプションを有効にし、セキュリティ確認をOKで確認します。

その後、モジュールコンフィギュレーターが利用可能になります。左側に技術設定があり、右側には言語依存のモジュールテキストがあります。

2. CMSページにブログリストを組み込む

ページ/Blog/index.htmlを開き、HTMLコードを選択します。ブログページは簡単なCMSマークアップを通じて組み込まれます。

<!--bx_Mod/Blog/Modul-Blog-List-->

このマークアップはブログモジュールとそのリストビューを指しています。CMSはレンダリングの際、この位置にモジュールの生成された出力を挿入します。

3. ファイルマネージャーで中央モジュールファイルを開く

モジュールの実際のPHPおよびHTMLロジックはページのHTMLに直接存在するのではなく、システムフォルダーbx_Modに中心的にあります。ファイルマネージャーでまずこのフォルダーを開き、その後Blogサブフォルダーを開きます。

Blogフォルダーには、例えばModul-Blog-List.php、Modul-Blog-ShowCase.php、config.php、他のモジュールファイル、そしてlanguagesサブフォルダーがあります。

4. ブログリストの標準ファイルを表示する

Modul-Blog-List.phpを選択し、編集から開きます。

標準ファイルにはリストビューのプログラムロジックが含まれています。示されているコードでは、モジュールの設定や、存在する場合はプロジェクト特有のconfig_own.phpがインクルードされます。

これにより、単一のモジュールインクルードを、異なるページで同じ中心的なプログラムロジックを使用することが可能になります。標準モジュールを使用しているプロジェクトでは、将来のCMSアップデートにより、このファイルに変更が提供されることがあります。

元のModul-Blog-List.phpを直接編集しないでください。システムに属しており、CMSのアップデートで上書きされる可能性があります。

5. _ownで独自のリストビューを作成する

出力を変更するには、標準ファイルをコピーします。独自のコピーには正確に適切な_ownのラベルが付けられます:

Modul-Blog-List.php
        ↓ kopieren
Modul-Blog-List_own.php

新しいファイルModul-Blog-List_own.phpを開きます。このプロジェクト特有のバージョンでは、PHPロジックやHTML出力を変更できますが、標準ファイルには手を触れません。

テストでは、タイトルに目立つ文字列NEW!!!!を追加します。その他のリストビューは保持されます。

独自のモジュールファイルを保存し、ブログページを再読み込みします。CMSは適切な_ownバリエーションを使用し、/Blog/index.htmlのプレースホルダーはそのままにします。アクティブな独自ファイルは、変更されたタイトルNEW!!!! 最新の記事で確認できます。

6. モジュール設定と独自の構成

HTML出力のほかに、モジュールの設定も変更できます。スクリーンショットでは、例えばModul-Blog-ShowCaseの設定値DS Repeats = 3が示されています。

値を2に変更し、設定を保存します。これにより、このShowCaseエリアの希望する数が設定されます。この設定はModul-Blog-ShowCaseに関連しており、ブログリストビューのすべての記事の数と自動的に一致するわけではありません。

独自の設定はbx_Mod/Blog/config_own.phpにあります。このファイルをファイルマネージャーで選択します。

示されているconfig_own.phpは、対象のモジュール領域Modul-Blog-ShowCaseが読み込まれる場合のみ、値を上書きします:

if($ModulNameGB == "Modul-Blog-ShowCase") {
   $CF_DS_Repeats = 2;
}

標準値は引き続きconfig.phpから来ます。独自の設定ファイルは、したがって、すべての標準値を繰り返す必要はなく、必要な逸脱のみを含むことができます。

7. データベーステーブルとモジュールページを設定する

標準設定bx_Mod/Blog/config.phpには、使用されているデータベーステーブルや詳細およびリストビューへのパスが含まれています。示された例の値は次のとおりです:

$CF_DatabaseTable = "Blog";

$CF_DetailPage = "/Blog/Detail.html";
$CF_ListPage = "/Blog/index.html";

ブログモジュールに基づいて別の目的のための独自のバリエーションを開発する場合、独自の設定で別のデータベーステーブルを指定できます。この新しいテーブルが、モジュールファイルが期待するフィールドを含んでいるか、リストページおよび詳細ページが新しいバリエーションに適合しているかを確認してください。

8. モジュールの言語ファイル

bx_Mod/Blog/languagesには、ブログモジュールの言語ファイルがあります。既存の言語については、各々のPHPファイルがあり、例えばde.php、en.php、fr.phpがあります。

ここでは、言語依存のモジュールテキストが管理されます。プロジェクト特有の変更には、オリジナルの言語ファイルを直接上書きするのではなく、モジュールのバージョンがサポートする独自のファイル形式を使用してください。

9. 標準モジュールと独自のバージョンを区別する

_ownルールは、あなたのカスタマイズを通常のアップデートによる上書きから保護します。同時に、この個別バージョンのメンテナンスについては自分自身で責任を持つ必要があります。後のCMSアップデートで、標準ファイルの重要な変更があなたの独自ファイルにも関連するかを確認してください。

10. まとめ

ブログモジュールは、モジュール → ニュース - ブログの下で有効化し、CMSマークを介してリスト表示を組み込み、実際のプログラムロジックをbx_Mod/Blogの下で中央集中的に管理します。独自の変更を行うには、Modul-Blog-List.phpをModul-Blog-List_own.phpにコピーします。標準から逸脱する設定は、必要に応じてconfig_own.phpに記録します。

CMS-Seite /Blog/index.html
        ↓ Modul-Markierung
bx_Mod/Blog/Modul-Blog-List.php
        ↓ passende _own-Datei vorhanden?
Modul-Blog-List_own.php
        ↓ Konfiguration und Datenbank
HTML-Ausgabe innerhalb der CMS-Seite

この方法で、元のシステムファイルを変更することなく、既存のモジュールを特定の目的で拡張することができます。