Zend Framework3の始め方2

投稿者: | 2018年2月27日

チュートリアル、チュートリアルに基づくアプリ作成をして自分なりに分かった、Zend Framework3の始め方についてメモを取ります。続きです。

ここからは、モジュールについて、
大体のアプリケーションで使用できる(であろう)テンプレートモジュールの作成を通じて、
自分が理解した範囲の解説と、作成をしていきます。
すでに書きましたが、
チュートリアル、チュートリアルに基づくアプリ作成をして分かったことが基準なので、
これが正しい、効率の良い方法だとは限りません。
一つの方法として読んでください。

注意

ここからは、

  • skeleton-applicationにデフォルトで付属してくるモジュールである、
    「Application」モジュール(module/Applicationフォルダ)
    を使用しない

という仮定の下で説明していきます。

 

テンプレートモジュールの作成

モジュール内には、
自分の作成したいアプリケーションに必要な画面、処理を記述していきます。
皆さんの作りたいアプリケーションに沿った説明をするのは不可能なので
ここでは、
ほとんどのアプリケーションで必要だろうと考えられる、
モジュールの構成(テンプレートと称することにします)を作成します。

 

テンプレートモジュールの作成では、以下のことを行います。

  • ファイル階層の作成
  • 作成したモジュールを登録する
  • MVCの一般設定(エラー画面とか)

 

ファイル階層の作成

必要なフォルダ階層、ファイルを作成します。
以下のようにフォルダとファイルを作成してください。

 

  • module(デフォルトで存在するフォルダ)
    • M
      • config
        • module.config.php
      • src
        • Controller
        • Form
        • Model
        • Module.php
      • view
        • error
          • 404.phtml
          • index.phtml
        • layout
          • layout.phtml
        • M(先頭は小文字)

ここで、
Mは、自分で名前を付けるモジュール名のことを指します。先頭は大文字のアルファベットである必要があります。今後も、モジュール名をMと表記します。先頭は大文字です。
青文字はファイルであることを示しています。

例として、私が以前作成した
scheduleアプリケーションのScheduleモジュールの構成を載せます。
写真中、moduleフォルダ内のScheduleフォルダが、Sheduleモジュールにあたります。

 

ここからは、具体的なテンプレートの作成をしていきます。

 

 

モジュールを登録する

作成したモジュールは、登録する(必要な文を記述する)必要があります。
モジュールを登録するのに必要な作業は以下の通りです。

  • composer.jsonファイルの編集
  • コマンドラインでcomposerを実行
  • modules.config.phpファイルの編集

ひとつづつ攻略していきます。

composer.jsonファイルの編集

path/to/install/composer.jsonを編集します。
ファイル内のautoload部分を探し、以下に置き換えます。

ここで、psr-4内に、Applicationの文が記入されていると思います。
Applicationモジュールを使用しないのであれば、その文を削除しても大丈夫です。
path/to/installは、前回、zend-frameworkをインストールした場所に該当します。

コマンドラインでcomposerを実行

コマンドラインで、path/to/installへ移動し、以下の文を実行します。
ちなみに、コマンドライン内での移動は、
cd c:/path/to/install
等のコマンドでできます。

 

modules.config.phpファイルの編集

path/to/install/config/modules.config.phpファイルを開き、
return 文を編集します

コメントアウトしているように、Applicationモジュールを使用しないときは削除しても構いません

 

 

MVCの一般設定(エラー画面とか)

MVCで必要な設定(初期化とか、エラー画面の設定とか)をしていきます。
ここでは以下のことを行います

  • Module.phpファイルの編集
  • module.config.phpファイルの編集
  • 最低限のエラー画面、レイアウトの設定

これらのファイル編集時、編集内容が中途半端に見えるかもしれません。
理由は、コントローラやモデルを新しく作成するときに記入する必要がある部分が存在するからです。
コントローラやモデルの汎用的(?)な作成方法は、べつのメモに記述する予定です。

 

Module.phpファイルの編集

M/src/Module.phpファイルを開き、以下を記述します。

 

module.config.phpファイルの編集

M/config/module.config.phpファイルを開き、以下を記入します。

 

最低限のエラー画面、レイアウトの作成

404エラー画面、例外が投げられたときのエラー画面を作成します。

M/view/error/404.phtml
M/view/error/index.phtml
を開き、
エラー画面っぽいhtmlを記述します。
具体的な例として、
デフォルトでついてきたApplicationモジュール内の
view/error/404.phtml
view/error/index.phtml
ファイルが挙げられます。

ここにそれを転載します。

view/error/404.phtml

 

view/error/index.phtml

 

このファイル優秀で、どこでエラーが起きたのかを教えてくれるので
そのまま利用するのがおすすめです。
ただし、インターネットに公開するときはしかるべきページにするべきです。
エラー内容なんて表示させないよね

 

レイアウト画面を作成します。
レイアウトファイルとは、
そのモジュールにアクセスしているときは常に表示しておいてほしい
メニューバーだったり、リンクだったりを記述しておくファイルです。
また、cssのロード、jqueryのロードなどもこのファイルに記述しておくと便利です。
M/view/layout/layout.phtmlファイルを開き、
レイアウトを編集します。

これも具体的な例として、Applicationモジュール内の
view/layout/layout.phtml
ファイルが挙げられます。

<?= $this->content ?>

という文に、今後のビュー作成時に作る画面が入ります。

最低限のlayout.phtmlを載せます。

 

 

これでテンプレートは完成ですが、
このままでは何もできません。こんな画面が表示されます。
404.phtmlが表示されているはずです。

おわりに

これで、最低限必要なファイルはできました。
しかし、これだけでは、本当に何も表示できません。
理由は、コントローラーやルーティングの設定が全くないからです。

次回は、コントローラーの設定について、
自分の理解している範囲で、一般化して説明します。
より詳しい内容は機会があれば…

 

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA