新增ContextHub至頁面及存取商店

將ContextHub新增至您的頁面以啟用ContextHub功能並連結至ContextHub Javascript資料庫。

ContextHub Javascript API可讓您存取ContextHub管理的內容資料。 本頁簡要說明API存取及控制內容資料的主要功能。 請依照API參考檔案的連結，查看詳細資訊和程式碼範例。

將ContextHub新增至頁面元件

若要啟用ContextHub功能並連結至ContextHub Javascript程式庫，請包含 contexthub 元件(位於 head 區段。 您頁面元件的HTL程式碼應類似下列範例：

<sly data-sly-resource="${'contexthub' @ resourceType='granite/contexthub/components/contexthub'}"/>

請注意，您也需要設定ContextHub工具列是否顯示在「預覽」模式中。 請參閱 顯示和隱藏ContextHub UI.

關於ContextHub存放區

使用ContextHub存放區來保留內容資料。 ContextHub提供下列儲存類型，這些儲存類型構成所有儲存類型的基礎：

所有商店類型都是 ContextHub.Store.Core 類別。 有關建立新商店類型的資訊，請參閱 建立自訂商店. 如需範例存放區類型的相關資訊，請參閱 範例ContextHub存放區候選項.

持續性模式

Context Hub存放區使用下列其中一種持續性模式：

  • 本地： 使用HTML5 localStorage來保存資料。 本機儲存會跨工作階段保存在瀏覽器上。
  • 工作階段： 使用HTML5 sessionStorage來保存資料。 工作階段儲存在瀏覽器工作階段期間持續存在，且可供所有瀏覽器視窗使用。
  • Cookie: 使用瀏覽器對資料儲存Cookie的原生支援。 Cookie資料會在HTTP要求中傳送至伺服器，或從伺服器傳送。
  • Window.name: 使用window.name屬性來保存資料。
  • 記憶體： 使用Javascript物件來保留資料。

預設情況下，Context Hub使用本地持久性模式。 如果瀏覽器不支援或允許HTML5 localStorage，則會使用工作階段持續性。 如果瀏覽器不支援或允許HTML5sessionStorage，則使用Window.name持久性。

存放資料

在內部，將資料儲存為樹結構，以便將值添加為主要類型或複雜對象。 添加要儲存的複雜對象時，對象屬性在資料樹中形成分支。 例如，下列複雜物件會新增至名為位置的空白存放區：

Object {
   number: 321,
   data: {
      city: "Basel",
      country: "Switzerland",
      details: {
         population: 173330,
         elevation: 260
      }
   }
}

儲存資料的樹狀結構可概念化如下：

/
|- number
|- data
      |- city
      |- country
      |- details
            |- population
            |- elevation

樹結構將儲存中的資料項目定義為索引鍵/值組。 在上述範例中，鍵 /number 與值對應 321，和鍵 /data/country 與值對應 Switzerland.

操作對象

ContextHub提供 ContextHub.Utils.JSON.tree 類，用於操作Javascript對象。 在將Javascript對象添加到儲存區之前，或在從儲存區獲取Javascript對象之後，使用此類的函式。

此外， ContextHub.Utils.JSON 類提供了將對象序列化為字串，並將字串反序列化為對象的函式。 此類別可用於處理JSON資料，以支援原生不包含的瀏覽器 JSON.parse 和 JSON.stringify 函式。

與ContextHub商店互動

使用 ContextHub 以Javascript物件形式取得商店。 取得儲存物件後，您就可以控制其包含的資料。 使用 getAllStores 或 getStore 函式來取得存放區。

存取儲存資料

此 ContexHub.Store.Core Javascript類別定義了與儲存資料互動的數個函式。 以下函式儲存和檢索對象中包含的多個資料項：

個別資料項目會儲存為一組索引鍵/值組。 要儲存和檢索值，請指定相應的鍵：

請注意，自訂存放區候選項可定義其他功能，以提供存取儲存資料的權限。

注意

ContextHub預設不會知道目前在發佈伺服器上使用的登入，且ContextHub會將這類使用者視為「匿名」。

您可以載入設定檔存放區，讓ContextHub得知已登入的使用者。 請參閱 此處為GitHub的范常式式碼.

ContextHub事件

ContextHub包含事件架構，可讓您自動回應以儲存事件。 每個儲存對象都包含 ContextHub.Utils.Eventing 可作為商店的 eventing 屬性。 使用 on 或 once 函式來將Javascript函式系結至儲存事件。

使用ContextHub來操控Cookie

Context Hub Javascript API提供跨瀏覽器支援，可處理瀏覽器Cookie。 此 ContextHub.Utils.Cookie namespace定義了建立、操控和刪除cookie的多個函式。

決定解析的ContextHub區段

ContextHub區段引擎可讓您判斷目前內容中要解析的已註冊區段。 使用 ContextHub.SegmentEngine.SegmentManager 類別來擷取解析的區段。 然後，使用 getName 或 getPath 函式 ContextHub.SegmentEngine.Segment 要測試區段的類別。

ContextHub 區段

ContextHub區段會安裝在 /conf/<site>/settings/wcm/segments 節點。

下列區段會與 WKND教學課程網站。

  • 夏季
  • 冬季

用以解決這些區段的規則摘要如下：

警告

安裝的區段會作為參考設定提供，協助您為專案建立專屬的設定，因此不應直接使用。

偵錯ContextHub

有許多選項可用來偵錯ContextHub，包括產生記錄檔。 請參閱 設定ContextHub以取得詳細資訊。

請參閱ContextHub架構概觀

ContextHub提供 診斷頁 您可在其中看到ContextHub架構的概觀。

本頁內容