前回では、.installファイルを使用してテーブルを作成する方法について確認しました。
今回は最終回として、カスタムモジュールの処理をPHPUnitテストというもので試験してみます。
PHPUnitテストを使えば、単体試験をソースコード化することで自動化および再試験の簡略化が出来ます。
Drupalだと固有のUnitTestCaseを継承してテストクラスを作成できます。
final class Issue5MailTest extends UnitTestCase {
今回は、イベントの出欠回答時に通知送信するメールを例にします。
前回では、フォームから入力された内容をDBに保存するところまで追いました。
その際に保存先のテーブルは作成済みとしていましたが、今回はそのテーブルをDrupalでどのように作成しているかを確認していきます。
今回作成するのは.installファイルになります。
まず.installってなんなのかですが、Drupalのカスタムモジュールでインストールや更新時の処理を書くためのDrupal固有のファイルです。
拡張子は.installですが、中身はPHPで書きます。
PHP自体に.installという仕組みがあるわけではなく、Drupal側がこのファイルをPHPとして読み込んでいます。
前回でフォームを作成しました。しかし、入力内容がどのような流れでDBに保存されていくかを追えてなかったので、今回はそれを追って行こうかと思います。
前提として、フォームと保存先のテーブルは作成済みとします。テーブルの作成方法については次回の記事で取り扱います。※.install使用
前回にシステムの入り口として用意したフォームから出欠するしないというデータが送られてきます。もちろん各ユーザが入力します。
仮に出席しますといったデータが流れてきた場合は、出席扱いで名前などとセットでINSERTされます。
先ずフォームってなんなのかですが、具体的には下記のようなテキストを入力・選択して送信するための画面部品のことを指す用語です。
PHPにフォーム定義をしていきます。
Drupalでフォームを定義する際にはHTMLではなく、PHPの配列で定義します。理由はDrupalのForm APIで纏めて管理しており、HTML部分については既にコアとして定義済みだからです。
今回はDrupalのフック関数について解説します。
前回のフォルダ構成で触れた「横から割り込めるフック処理を入れるmarucha.module以外については必須です。」という部分についての深掘りになります。
今回は例としてDrupalに元々存在する検索フォームを置き換えます。 通常の送信ボタンではなく、Marucha検索という表示に変更できます。
とりあえず先ずはフック関数がどういう実装になるかですが、下記のようにmarucha_form_alterという感じでモジュール名を入れる必要があります。
hook_form_alter()が元々の形で、Drupalのコア機能が用意しているものになります。
これから数回に分けてDrupalカスタムモジュール作成方法についての社員ブログを書いていこうかと思います。
先ずは、最初の一歩として大雑把にでもアーキテクチャの勉強から入っていこうかと思います。
それでは一般的なフォルダ構成です。
イベント出欠有無など、何かしらの回答データを集計したりグラフ化したい場面が多いかと思います。
そういった場面用に今回はDrupalカスタムモジュールにて実装手順を説明していこうかと思います。
DrupalはFacebookが提唱したPHPのBigPipe技術を使ってHTMLページを生成しているようです。※似たようなものにAjaxがあります。
今回はそこに焦点を当ててみようかと思います。
先ずはWordPress等のよくあるブログ作成の場合どうなっているかを見ていきます。下記手順になります。
ユーザがページにアクセス
→PHPが上から順番にプログラムを実行し、ページの全HTMLをメモリ上に完成
→完成したHTMLを一括でブラウザに送信
このやり方だと、ページ内に1箇所でも重いデータがあると処理が終わるまで、ユーザーは待たされることになります。
以前に標準機能で実装していたイベント管理ページをカスタムモジュールにて再実装してみました。
すると、なんとなく見た目が綺麗に整った感じがします。(右窓がカスタム)
これは何故かというと、使っている描画の仕組みが違うからです。
標準機能は、Drupal汎用部品なのに対し、カスタムはそれ専用です。
なんで実装量が増えるというデメリットはあるものの、汎用的な表示にならない為、綺麗な画面を作ることが可能なのです。
今回はカスタムテーマに関するアクイアジャパンのウェビナーをベースに、どのファイルが・どこに配置され・どのような役割を持つのかというファイル構成に焦点を当てて体系的に解説します。