ウェブのましじめ

a-blog cms 拡張アプリのForm2Entryをインストールする

a-blog cms
田村 章吾(タムショー)

こんにちは田村です。

今回はa-blog cmsの拡張アプリ「Form2Entry」をインストールして使用するまでを解説します。

「Form2Entry」とはフォームで送信した内容を元にエントリーを作成することができる拡張アプリです。
これにより掲示板のような投稿型サイトが簡単に実装することができます。


どんなものか試して見たい方はこちらのハンズオンを参考にしてみてください。
https://developer.a-blogcms.jp/hands-on/camp2019autumn/form2entry.html

拡張アプリとは


まず「拡張アプリ」とは何なのかですが、WordPressであれば「プラグイン」、Drupalであれば「モジュール」と同じと考えて良いと思います。WordPressなどと同様にPHPを使って記述していきます。

a-blog cmsでPHP?と思われる方もいるかもしれません。
通常a-blog cmsではPHPを触ることなくカスタマイズ可能ですが、フックという形で特定タイミングで独自の処理を実行できるようにすることができます。このフック処理を追加するときにPHPを書く必要があります。

https://developer.a-blogcms.jp/document/user_hook/

馴染みのあるところでは「グローバル変数」と「校正オプション」の追加というあたりですね。

このように拡張したい処理を都度フックに書いてカスタマイズすることも出来ますが、
必要なフック処理を1つのパッケージとしてブログ単位で呼び出せるようにまとめたものが「拡張アプリ」というわけです。

拡張アプリを独自で作成する

「拡張アプリ」はこの辺りの処理を拡張することが可能なようです。詳しくはドキュメントを確認するのが良いでしょう。

  • 校正オプションの拡張
  • フック処理の拡張
  • Validatorの拡張
  • 独自GETモジュールの追加
  • 独自POSTモジュールの追加
  • テンプレートの挿入(テンプレートの拡張)


https://developer.a-blogcms.jp/document/develop_apps/

無料の拡張アプリ

a-blog cms公式から無料の拡張アプリも公開されていますので参考にしてみてください。

https://developer.a-blogcms.jp/app/


ビジネスパートナー用の拡張アプリ


ビジネスパートナーのみ購入できる拡張アプリがあります。
今回登場する「Form2Entry」もビジネスパートナー用の拡張アプリの一つです。

a-blog cmsにはビジネスパートナーという制度があります。ビジネスパートナーになると事業者向の特典が充実しますので定期的にa-blog cms を利用する場合はパートナー契約をすることをオススメします。

https://developer.a-blogcms.jp/partner/detail.html

動作確認

Form2Entryをインストールしてみる

まずはa-blog cmsをインストールしましょう。
インストールの手順は省略しここではbeginner2020をインストールすることにします。


設定は見やすいように変更してください。ここではタイトルだけ変更しておきます。


次に拡張アプリをインストールします。
記事が少し古いですが、動くと信じてこちらからダウンロードして使用します。

https://developer.a-blogcms.jp/hands-on/camp2019autumn/form2entry.html#entry-3

ダウンロードしたファイルを解凍し次へ配置します。

extension/plugins/Form2Entry


さらにconfig.server.phpの Hookを1にします。

define("HOOK_ENABLE", 0);
↓
define("HOOK_ENABLE", 1);



次に管理画面の設定変更します。「Form2Entry」を使用するブログでインストールする必要があります。
今回は、親ブログで使用することにします。
左ナビゲーションから拡張アプリ管理のページへいくと「Form2Entry」が見えるのでインストールします。


Form2Entryを使ってエントリーを投稿してみる

次に、左ナビゲーションからフォーム管理のページへ移動します。
ここでは標準で入っている「お問い合わせフォーム:contactForm」を利用してエントリーを作成してみましょう。


フォームIDの編集画面を見てみると「Form2Entry 設定」という項目が増えています。
ここで「Form2Entry 」を設定します。



エントリー設定:「有効にする」
タイトル指定:「{name}様からのご質問:{description}


ここの{name}、{description}というのはお問い合わせフォームで使用されているフィールドの値になります。
一度お問い合わせページとテンプレートをみてみましょう。


仮に郵便番号であれば{postal-code}といった形で使用できます。
フォームを作る時と同じイメージで良いと思います。
使用したい値を入力します。
さらにはカスタムフィールド に割り当てたり、ユニットに入れることも可能です。

ここでは見出しのみで進むこととし、フォームの内容を入力します。
外見に変化はありませんがそのまま「送信」まで進めます。


送信が完了しました。特に変化はありません。

次に管理画面を見てみましょう。



無事にエントリーがされているのがわかります。
見出しのみしか入れていないためコンテンツの内容は空ですが、正しく表示されているようです。
フォームからの内容をエントリーとして登録することが可能になりました。

この記事ではここまでとしますが、あとはサイトに合わせてカスタムフィールド やユニットに値をいれると良いでしょう。

以上、ここまでが「Form2Entry」の基本的なインストールと使用方法です。
細かい値の設定などはハンズオンのページを確認してもらうと良いですが
基本的にはカスタムフィールドと、CSVインポートあたりの感覚でカスタムできると思います。

https://developer.a-blogcms.jp/hands-on/camp2019autumn/form2entry.html
https://developer.a-blogcms.jp/document/customfield/
https://developer.a-blogcms.jp/document/datamanagement/csv_convert.html


ビジネスパートナー専用の拡張アプリとなりますが、「Form2Entry」色々と面白いカスタマイズが出来そうですね。

また、ハンズオンの記事は古くなっていますのでzipファイルも古いかもしれません。
実際に導入を考えている場合は、一度アップルップルさんへ相談してみるが良いでしょう。
もしくは「ましじめ」にカスタマイズをご依頼いただければ、良いご提案をさせていただきます^^

ではでは。

田村 章吾(タムショー)
ましじめ株式会社代表 北九州市在住。 『現場のプロから学ぶ CSSコーディングバイブル』の著者。 CMSを中心としたWeb制作をしています。

ましじめのスキルが必要ですか?

ウェブののましじめ