モジュールIDの引数

モジュールID条件設定ではカテゴリーやエントリー、ページなどの項目にチェックボックスがついています。このチェックボックスはURLコンテキストの値を参照しています。



カテゴリーIDの入力フォームではcidの数字を入力しますが、引数にチェックすることでURLの情報に合わせてデータの表示することができます。

引数チェックボックスの使い方

引数のチェックボックスは、URLコンテキストに応じて表示する内容を変えることができます。URLコンテキストについてはURLコンテキストのページをご覧ください。

現在表示しているカテゴリーの一覧を表示させたい

カテゴリーIDの引数チェックボックスにチェックをしてください。

http://www.example.com/news/ のときはnewsカテゴリーのエントリー一覧を表示します。 http://www.example.com/products/ のときはproductsカテゴリーのエントリー一覧を表示します。
このようにURLの値によって表示させるデータを変えることができます。わざわざnewsカテゴリー一覧表示用のモジュールを作ったり、productsカテゴリー一覧表示用のモジュールを作ったりしなくてよくなります。

ページャーを使いたい

ページャーを表示させ、さらにページ(page)の引数チェックボックスにチェックをしてください。

例えば、お知らせエントリーの2ページ目のエントリーを表示させるときは、ページャーで2ページ目へのリンクを表示させると、URLの値に /page/2/ が出力されます。しかし、これだけでは2ページ目の情報を表示することはできません。
さらに、ページ(page)の引数チェックボックスにチェックすることで、2ページ目へのリンクをクリックしたときに現在のページの情報を表示することができます。 http://www.example.com/news/page/2/

キーワード検索したい

キーワード(keyword)の引数チェックボックスにチェックをしてください。

検索フォームからキーワードを入力して検索するとURLに検索したキーワードが入ります。例えば「醤油」というキーワードで検索するとURLに /keyword/醤油/ という値が含まれ、「醤油」という文字を持っているエントリー一覧を表示することができます。
http://www.example.com/keyword/醤油/

タグの絞り込みがしたい

タグ(tag)の引数チェックボックスにチェックをしてください。

タグクラウドのリンクをクリックするとURLに選択したタグの値が入ります。例えば「フォーム」というタグを持ったエントリーの一覧を表示させたいときはURLに /tag/フォーム/ と入れて絞り込めるようにします。
http://www.example.com/tag/フォーム/

カスタムフィールドの絞り込みがしたい

フィールド(field) の引数チェックボックスにチェックをしてください。

カスタムフィールドの絞り込みをする場合はURLに /field/カスタムフィールド変数名/値/ が入っていれば、そのカスタムフィールドの値を持っているエントリーを表示することができます。
http://www.example.com/field/pickup/true/

期間で絞り込みがしたい

開始日時(start)と 終了日時(end)の引数チェックボックスにチェックをしてください。

例えば、Entry_ArchiveListモジュールなどで2014年1月に投稿したエントリー一覧を表示させる場合はURLに /2014/01/ という値が入ります。「開始日時(start)」と「 終了日時(end)」の引数がチェックすることで、2014年1月に投稿したエントリー一覧を表示させることができます。
http://www.example.com/2014/01/

Slackとの連携機能

a-blog cmsの拡張アプリ「slack」を使うとフォームからデータが送信された段階でそのフォームのデータを加工し、slackに通知することができます。例えばフォームから「資料請求」などがあれば「資料請求がありました。」などとslackの好きなチャンネルに通知できます。

カスタマイズ

今回のハンズオンではsimple2017のお問い合わせフォームで登録された内容をSlackの任意のチャンネルに送信しましょう。

下準備

以下の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をインストールします。



インストール完了後は、管理ページ >Slack よりSlackの管理ページに移動します。その後、「Webhook URL」という項目がありますので、その項目に先ほど覚えておいた Webhook URL を入力します。 これでa-blog cmsとSlackを連携させる準備は整いました。

注意

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

define('HOOK_ENABLE', 1);

拡張アプリ Slack の使い方

下の図のように、Slackに通知したいFormIDを指定し、メッセージの送信先チャネルを「Channel」に送信元の名前を「From」に設定します。またメッセージにはFormモジュールの変数と、グローバル変数を使用することができます。


課題

simple2017のお問い合わせフォームから送信された内容をSlackの任意のチャンネルで通知してみましょう。通知内容は任意で構いませんが、グローバル変数とフォームモジュールの変数を使うようにしてみましょう。

モジュールIDの日時指定で機能修正を行いました

モジュールIDの引数設定で、URLコンテキストを使用するチェックと、固定値の設定の両方使用した場合に、開始日時(start)、終了日時(end)に不具合がありました。

通常、URLコンテキストを使用するチェックと、固定値を設定した場合、URLコンテキストが優先されます。


Google SpreadSheet との連携機能


a-blog cmsの拡張アプリ「SpreadSheet」を使うとお問い合わせフォームなどで送信された内容を任意のGoogle SpreadSheetの最後の行に追記することができます。

カスタマイズ

今回のハンズオンではsimple2017のお問い合わせフォームで送信されたいくつかの項目を Google SpreadSheetに追記してみます。

下準備

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

  1. ClientID JSON の取得
  2. ClientID JSON を CMS側に登録

1. ClientID JSON の取得


まずは、Google API Console にアクセスしてログインしてください。ログイン後、任意の名前でプロジェクトを作成します。 上の画像のように 1, 2 の手順でプロジェクトを新規作成できます。


左上のセレクトメニューをクリックし、先ほど作成したプロジェクトを選択します。



次は、サブカラムより「ライブラリ」という項目をクリックし、API ライブラリのページに移動します。そのページにて、Google Sheet APIという項目を検索して有効化してください。



最後に「認証情報」をクリックして認証情報の設定画面に移動します。そこで新たにOAuth クライアント ID を作成します。 アプリケーションの種類として、「ウェブアプリケーション」を設定して、「認証済みのリダイレクトURI」には「ドメイン名/bid/(現在使用しているブログのBID)/admin/app_google_spreadsheet_callback」を設定します。


その後、クライアントIDなどの情報が記述されたJSONファイルをダウンロードしましょう。その後、ダウンロードしたJSONファイルをサーバーにアップロードします。ドキュメントルート以下にアップロードをするとブラウザからアクセスできてしまいますので、ドキュメントルートより上の階層にアップロードするのが望ましいです。

2. ClientID JSON を CMS側に登録


次はCMS側の設定です。まずは、拡張アプリからHook処理をかけるようにconfig.server.phpを1にします。

define('HOOK_ENABLE', 1);

管理画面 > 拡張アプリより、 SpreadSheet をインストールします。インストール完了後は、管理画面 > SpreadSheet より Google Spread Sheet の管理画面に移動します。


そして先ほど設置したJSONファイルへのパスを記述します。絶対パスで記述しましょう。パスを記述後、設定を保存してから、「認証」ボタンをクリックして認証するようにしましょう。

※ablogcms.ioで行う場合は、ルートディレクトリには設置できないため、「themes」フォルダなどにJSONファイルを設置します。 ablogcms.ioでの記述例: /var/www/vhost/xxxxxx.ablogcms.io/html/themes/xxxxxxxx.json


またこの管理ページ内でa-blog cmsのFormIDに対して書き込みしたいSpreadsheetのIDを指定する必要があります。 Spreadsheet IDとSheet IDは、開いているSpreadSheetのURLから調べることができます。

https://docs.google.com/spreadsheets/d/{Spreadsheet ID}/edit#gid={Sheet ID}

課題

simple2017のお問い合わせフォームから送信された内容をGoogle SpreadSheetに追加登録してみましょう。下の図のような実行結果になっていれば成功です。