テンプレート変数表

SetTemplateを使う事でインクルードファイル数が減り共通化できるようになり、テンプレートの管理がしやすくなります。ただ、せっかくSet_Templateでテンプレートを変数化しても、どのようなテンプレートが用意されているか分からないと使いづらいものになってしまいます。

ここでは、テンプレートの変数表を作成する事を学び、より開発しやすい環境を整えましょう。

Docコメントの書き方

SetTemplateに特定の書き方でHTMLコメントを書く事により、動的に変数表を作成する事が可能になります。 SetTemplateを使う場合は、以下のようなコメントを書くようにしましょう。

<!--@doc
 # 自由にコメントを書けます。
 # コメントは複数行書けます。
 # 
 # @id template_id
 # @param hoge | パラメーター説明文1
 # @param fuga | パラメーター説明文2
 # @author 作った人
 # @create 2016/04/12 
-->
<!-- BEGIN_SetTemplate id="template_id"  -->
...
<!-- END_SetTemplate -->

「<!--@doc」 からはじまり、そのテンプレートを説明するコメントを複数行書く事ができます。 また、@から始まる特定の書き方をする事により、変数表の情報をより詳しくする事ができます。(@idは必須項目です)

変数表の表示

テンプレート変数表ページを作っていきます。以下の手順で行います。

  1. テンプレートの作成 自分のテーマに適応なファイル名でテンプレートを作成します(e.g varstable.htmlなど)
  2. テンプレートに動的に変数表を作成するモジュールを貼り付け。以下コード参照。
  3. 変数表に表示したいSetTemplateの定義がされたファイルを読み込む。
<!-- BEGIN_MODULE Template_VarsTable -->

<!-- 表示したいSetTemplateの定義がされたファイルを読み込み -->
<!-- #include file="/vars/all.html" -->

<!-- 変数表のテンプレートをsystemテーマから読み込み -->
<!-- #include file="/admin/template/vars-table.html"-->

<!-- END_MODULE Template_VarsTable -->

ここまで出来たらブラウザで作成したテンプレートにアクセスすると以下のように変数表が表示されるようになります。変数表を作る事によりテンプレートのパーツが整理され複数人のチーム開発でも大変役に立ちます。是非活用しましょう。


テンプレート変数表

テンプレート変数表

ライト版からスタンダード版へのアップデート

ライト版の提供終了

2016年3月末日をもちましてライトライセンスの提供は終了となりました。これによりCMSのバージョンアップを行いたい場合や、管理ユーザー数を増やしたい場合などには、スタンダード版へのアップデートが必要になります。

a-blog cms ライト版の終了のお知らせ

スタンダード版へのアップデート方法

ライト版とスタンダード版では、パッケージの内容が違うため、ライセンスファイルだけ置き換えればアップデート出来るわけではありません。パッケージの更新が必要になってきます。

パッケージの置き換え

以下パッケージの置き換えの流れになります。基本的にはスタンダード版のバージョンアップと同様になります。

  • スタンダード版のパッケージの最新バージョン(アップデート版)をダウンロード
  • パッケージに同梱されているバージョンアップマニュアルに沿ってバージョンアップを実行
  • ライセンスファイルを購入したスタンダードライセンスのものに置き換え

ダウンロードページ

バージョンアップを行った段階でライト版でなくなりますので、ライトライセンスでは表示がされなくなります。 必ずスタンダードライセンスをご準備の上、アップデートを行ってください。

拡張アプリ Slack を公開しました


今年、2018年3月26日に公開された a-blog cms Ver.2.8ではより外部サービスと連携しやすい仕組みを用意しています。そこで今後いくつかの連携機能をa-blog cmsの本体とは別に拡張アプリという形で配布することにしました。 その第一弾として今回は 拡張アプリ「Slack」を用意しました。拡張アプリ「Slack」を使うとお問い合わせフォームなどから送信された内容をSlackに通知することができます。たとえばフォームから「資料請求」などがあれば「資料請求がありました。」などの簡単なメッセージや、メールの本文をそのまま、好きなチャンネルに通知できます。

ダウンロード

ダウンロード

利用するためにはダウンロード後、/extension/pluginsに設置してください。

使い方

以下の3つのステップで a-blog cms と Slack を連携します。

  1. Slackへの登録
  2. Webhook URL の取得
  3. a-blog cmsの拡張アプリ Slackに Webhook URL を登録

1. Slackへの登録

Slackのアカウントをお持ちでない方は下記のURLにてアカウントを作成しましょう。ある程度の機能までは無料で使うことができます。 https://slack.com/

2. Webhook URL の取得

下記のURLにてチャネルを指定して Webhook URL を取得します。ここで登録したチャネル以外のチャネルにもメッセージを飛ばすことはできますので好きなチャネルを指定して作成しましょう。 https://slack.com/services/new/incoming-webhook

3. a-blog cmsの拡張アプリ Slackに Webhook URL を登録

管理ページ > 拡張アプリより「拡張アプリ管理」のページに移動します。そのページより下の図のようにSlackをインストールします。



インストール完了後は、管理ページ > フォーム > 連携したいフォームID よりSlackの管理ページに移動します。その後、「Webhook URL」という項目がありますので、その項目に先ほど覚えておいた Webhook URL を入力します。

あとは、Slackに通知したいフォームIDに移動し、メッセージの送信先チャネルを「Channel」に送信元の名前を「From」に設定します。またメッセージにはフォームモジュールの変数と、グローバル変数を使用することができます。 「Message」の項目にはグローバル変数やフォーム内の変数も利用することができます。



これでa-blog cmsとSlackを連携させる準備は整いました。あとは先ほどの設定がされたフォーム「お問い合わせフォームなど」に移動し普段通り情報を入力します。



お問い合わせ完了後、以下のようなメッセージがSlackに通知されていれば成功です。



注意

config.server.phpでHOOKを有効にしておく必要があります。

define('HOOK_ENABLE', 1);

拡張アプリの今後の配布について

拡張アプリは今後 applepleのGitHubのページに公開していく予定です。 またGitHubに公開されているアプリは下の拡張アプリ一覧ページからダウンロードできるようになりますのでよかったら訪れてみてください。


拡張アプリ一覧ページ