ContextHub の拡張

提供されている ContextHub ストアやモジュールのタイプがソリューションの要件を満たさない場合は、新しいタイプを定義できます。

カスタムストア候補の作成

ContextHub ストアは、登録済みのストア候補から作成します。カスタムストアを作成するには、ストア候補を作成して登録する必要があります。

ストア候補を作成して登録するコードを含む JavaScript ファイルは、クライアントライブラリフォルダーに含める必要があります。フォルダーのカテゴリは、次のパターンに一致しなければなりません。

contexthub.store.[storeType]

カテゴリの [storeType] 部分は、ストア候補と一緒に登録されている storeType です（「ContextHub ストア候補の登録」を参照）。例えば、storeType が contexthub.mystore の場合、クライアントライブラリフォルダーのカテゴリは contexthub.store.contexthub.mystore でなければなりません。

ContextHub ストア候補の作成

ストア候補を作成するには、ContextHub.Utils.inheritance.inherit 関数を使用して、次のいずれかのベースストアを拡張します。

各ベースストアは、ContextHub.Store.Core ストアを拡張したものです。

次の例では、ContextHub.Store.PersistedStore ストア候補の最もシンプルな拡張を作成しています。

myStoreCandidate = function(){};
ContextHub.Utils.inheritance.inherit(myStoreCandidate,ContextHub.Store.PersistedStore);

実際には、カスタムストア候補は追加の関数を定義するか、ストアの初期設定を上書きします。いくつかのサンプルストア候補が、/libs/granite/contexthub/components/stores の下にあるリポジトリにインストールされています。これらのサンプルを参考にするには、CRXDE Lite を使用して JavaScript ファイルを開きます。

ContextHub ストア候補の登録

ストア候補を登録して ContextHub フレームワークに統合し、ストア候補からストアを作成できるようにします。ストア候補を登録するには、registerStoreCandidate クラスの ContextHub.Utils.storeCandidates 関数を使用します。

ストア候補を登録する際に、ストアタイプの名前を指定します。候補からストアを作成するときは、ストアタイプを使用してベースとする候補を識別します。

ストア候補を登録する際に、優先度を指定します。既に登録済みのストア候補と同じストアタイプを使用してストア候補を登録した場合、優先度の高い候補が使用されます。そのため、新しいストア候補を既存のストア候補に優先させることができます。

ContextHub.Utils.storeCandidates.registerStoreCandidate(myStoreCandidate,
                                'contexthub.mystorecandidate', 0);

ほとんどの場合、1 つの候補のみが必要で優先度を 0 に設定できますが、より高度な登録について学ぶことができます。これにより、少数のストア実装のうちの 1 つを javascript 条件（applies）と優先度の候補に基づいて選択できます。

ContextHub UI モジュールタイプの作成

ContextHub に付属してインストールされる UI モジュールタイプが要件を満たさない場合は、カスタム UI モジュールタイプを作成できます。UI モジュールタイプを作成するには、ContextHub.UI.BaseModuleRenderer クラスを拡張して ContextHub.UI に登録し、新しい UI モジュールレンダラーを作成します。

UI モジュールレンダラーを作成するには、UI モジュールをレンダリングするロジックを格納している Class オブジェクトを作成します。少なくとも、このクラスは次のアクションを実行する必要があります。

ContextHub.UI.BaseModuleRenderer クラスを拡張します。このクラスは、すべての UI モジュールレンダラーのベースとなる実装です。Class オブジェクトは、このクラスが拡張されていることを示すために使用する extend というプロパティを定義します。
デフォルトの設定を指定します。defaultConfig プロパティを作成します。このプロパティは、contexthub.base UI モジュール用に定義されているプロパティと、必要なその他すべてのプロパティを含むオブジェクトです。

ContextHub.UI.BaseModuleRenderer のソースは、/libs/granite/contexthub/code/ui/container/js/ContextHub.UI.BaseModuleRenderer.js にあります。レンダラーを登録するには、registerRenderer クラスの ContextHub.UI メソッドを使用します。モジュールタイプの名前を指定する必要があります。管理者がこのレンダラーをベースとして UI モジュールを作成する場合は、この名前を指定します。

レンダラークラスを作成し、自己実行型匿名関数に登録します。次の例は、contexthub.browserinfo UI モジュールのソースコードをベースとしています。この UI モジュールは、ContextHub.UI.BaseModuleRenderer クラスのシンプルな拡張です。

;(function() {

    var SurferinfoRenderer = new Class({
        extend: ContextHub.UI.BaseModuleRenderer,

        defaultConfig: {
            icon: 'coral-Icon--globe',
            title: 'Browser/OS Information',

            storeMapping: {
                surferinfo: 'surferinfo'
            },

            template:
                '<p>{{surferinfo.browser.family}} {{surferinfo.browser.version}}</p>' +
                '<p>{{surferinfo.os.name}} {{surferinfo.os.version}}</p>'
        }
    });

    ContextHub.UI.registerRenderer('contexthub.browserinfo', new SurferinfoRenderer());

}());

レンダラーを作成して登録するコードを含む JavaScript ファイルは、クライアントライブラリフォルダーに含める必要があります。フォルダーのカテゴリは、次のパターンに一致しなければなりません。

contexthub.module.[moduleType]

カテゴリの [moduleType] 部分は、モジュールレンダラーの登録に使用されている moduleType です。例えば、moduleType が contexthub.browserinfo の場合、クライアントライブラリフォルダーのカテゴリは contexthub.module.contexthub.browserinfo でなければなりません。