#【目的】cakephp3のブログチュートリアルを使ってフレームワークの基本を抑える
参考：cakephp3ブログチュートリアル（公式ドキュメント）
###環境
PC：Mac
DB：mysql
ローカル環境：MAMP
#第1章（インストールからMVCの説明と一覧ページと詳細ページ作成まで）の目次
・cakephpインストール
・DBとテーブルを作成する（今回はarticlesテーブル作成）
・config/app_local.phpでDBとの紐付する
・モデルファイルをsrc/Model/Table/articles.phpとして作成する
・コントローラーファイルをsrc/Controller/ArticlesController.phpとして作成する
→コントローラーにはアクションの記述をする。
→アクションごとにURLが紐付く（hoge.jp/テーブル名/アクション名)
・ビューを作成する
→ファイルはsrc/Template/直下にテーブル名でディレクトリを作成し、アクションごとにctpファイルを作る
今回はsrc/Template/Articles/index.ctp
ctpファイルの中にヘルパーリンクを作成することで詳細ページへのリンクを作る事が可能
・ビューの詳細ページを作成する
→コントローラーに追加でviewアクションを作成する
→src/Template/Articles/view.ctpを作成し詳細ページを表示可能にする。
##cakephpのインストール
インストールは過去記事を参考に行ってください。
cakephp4のインストール方法
###抑えるべき点
テーブル名：テーブル名を使用して各ファイルを作成・操作していくので作成したテーブル名をしっかり抑えておく。
##DB作成
# まず、articles テーブルを作成します
CREATE TABLE articles (
id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
title VARCHAR(50),
body TEXT,
created DATETIME DEFAULT NULL,
modified DATETIME DEFAULT NULL
);
# それから、テスト用に記事をいくつか入れておきます
INSERT INTO articles (title,body,created)
VALUES ('タイトル', 'これは、記事の本文です。', NOW());
INSERT INTO articles (title,body,created)
VALUES ('またタイトル', 'そこに本文が続きます。', NOW());
INSERT INTO articles (title,body,created)
VALUES ('タイトルの逆襲', 'こりゃ本当にわくわくする！うそ。', NOW());
上記テーブルを今回はmysqlで作成します。
phpmyadminにてSQL文を入力し作成します。
事前にcake_blogというDBを作成しそのDBにて上記SQLを実行→テーブルを作成します。
###作成したテーブル画面
####※ここで作成したテーブル名がarticlesという点をしっかり抑えておく。
##DBの設定
テーブル作成後DBとcakeの紐付けをします。
公式ドキュメントには以下のようにconfig/app.phpを変更するように書いてありますが、ローカル環境ではconfig/app_local.phpに記述していきます。
【公式ドキュメント】
上記を参考に以下のように記述します。
【app_local.php】
'Datasources' => [
'default' => [
'className' => 'Cake\Database\Connection',
'driver' => 'Cake\Database\Driver\Mysql',
'persistent' => false,
'host' => 'localhost',
'username' => 'root',
'password' => 'root',
'database' => 'cake_blog',
'encoding' => 'utf8',
'timezone' => 'UTC',
],
],
DBの設定が完了するとcakeのトップ画面のDatabaseの部分が緑になります
###追加の設定
セキュリティソルトを変更します
【公式ドキュメント】
上記を参考に任意のランダムな文字列を入力します
'Security' => [
'salt' => 'randamunamoziretunisuruuuuuuuurandfadfafadfa',
],
##Articles モデルの作成
articlesテーブルを作成したので、ここではsrc/Model/Table/の中に
ArticlesTable.phpを作成します。
このファイルは後に作成するArticlesController.phpと紐付きます。
こうすることでこのファイルは自動的にDBのarticlesと紐付けがされます。
【ArticlesTable.php】
namespace App\Model\Table;
use Cake\ORM\Table;
class ArticlesTable extends Table
{
public function initialize(array $config)
{
$this->addBehavior('Timestamp');
}
}
↑公式より
##Articles コントローラーの作成
src/Controller/の中にArticlesController.phpを作成します。
【ArticlesController.php】
// src/Controller/ArticlesController.php
namespace App\Controller;
class ArticlesController extends AppController
{
public function index()
{
$articles = $this->Articles->find('all');
$this->set(compact('articles'));
}
}
ここではまずindexというactionを作成しています。
Controllerで設定したactionはデフォルトではwww.example.com/articles/indexというURLでアクセス出来ます。
同様に、 foobar() という関数を定義すると、ユーザーは、www.example.com/articles/foobar でアクセス出来ます。
URLのアクセスについては後述するルーティングにて変更出来ます。
その際はconfig/routes.phpを修正します。
$this->set(compact('articles');は上の行で設定している$articlesを配列にしてviewへ渡す機能です。
compact()はもともとphpにある関数です。
参考：compact()
###ポイント
コントローラーはモデルの記述によってDBとやりとり可能になったデータを呼び出してそれをactionを使用してviewへ渡す機能を担っています
##Articles ビューの作成
Viewファイルはコントローラーで作成したactionの内容をURLで表示させたい時にそのアクション名を使用して作成します。
今回のindexであれば作成場所はsrc/Template/Articles/index.ctpとなります。
###ポイント
テーブルごとにsrc/Template/の直下にディレクトリを作成します（今回はArticles)。
さらにその作成したディレクトリの中にviewファイルをアクションごとに作っていきます。
仮にArticlesController.phpにhogeというアクションが作成されていた場合、そのactionに紐づけるviewファイルは
src/Template/Articles/hoge.ctpというファイルを作ることになります。
【index.ctp】
<h1>ブログ記事</h1>
<table>
<tr>
<th>Id</th>
<th>タイトル</th>
<th>作成日時</th>
</tr>
<?php foreach ($articles as $article) : ?>
<tr>
<td><?= $article->id ?></td>
<td>
<?= $this->Html->link($article->title, ['action' => 'view', $article->id]) ?>
</td>
<td>
<?= $article->created->format('y/m/d'); ?>
</td>
</tr>
<?php endforeach; ?>
</table>
###コードの説明
<?php foreach ($articles as $article) : ?>
上記でコントローラーから$this->set(compact('articles');で受け取った値をforeach ($articles as $article)で回して全件表示しています。
<?= $this->Html->link($article->title, ['action' => 'view', $article->id]) ?>
上記はヘルパーというcakeの機能を使用してidごとの詳細ページへのリンクを作成しています。
ここではlink() メソッドが、指定されたタイトル（最初のパラメーター）と URL (二つ目のパラメーター) で HTML リンクを生成するということを行っています。
これにより/articles/view/some\_id にこれから作るviewファイルを紐づけ詳細ページを作ることが可能です。
ヘルパー
これでコントローラーで指定したURL（www.example.com/articles/index)にアクセスするとindex.ctpで記述した画面が表示されるようになります。
【表示画面】
##詳細ページ作成
上述のヘルパー機能によって生成したリンク先ページを作っていきます。
・コントローラーにviewアクションを追加
・リンク先ページviewを作成
【ArticlesController.php】
// src/Controller/ArticlesController.php
namespace App\Controller;
class ArticlesController extends AppController
{
public function index()
{
$articles = $this->Articles->find('all');
$this->set(compact('articles'));
}
public function view($id = null)
{
$article = $this->Articles->get($id);
$this->set(compact('article'));
}
}
今回は全件取得ではなく1件なのでget($id)を記述します。
新しいviewページview.ctpを作成します
【view.ctp】
<!-- File: src/Template/Articles/view.ctp -->
<h1><?= h($article->title) ?></h1>
<p><?= h($article->body) ?></p>
<p><small>Created:<?= $article->created->format('y/m/d') ?></small></p>
これでページ詳細ページにアクセス可能になります。
【表示された詳細ページ】
#第2章（記事の追加・編集・削除）
##要点
・ArticlesController.phpに「add(), edit(), delete()」アクションを追加
・各アクションへのリンクをArticles/index.ctp内に記述
→
追加：<?= $this->Html->link('記事追加',['action' => 'add']) ?>
編集：<?= $this->Html->link('編集', ['action' => 'edit', $article->id]) ?>
削除：
<?= $this->Form->postLink(
'削除 ',
['action' => 'delete', $article->id],
['confirm' => '本当に削除しますか?'])
?>
・追加・編集用のビューを作成（add.ctp, edit.ctp)
・追加や編集などのフォームで使用するバリデーションをモデル（```src/Model/ArticlesTable.php)の既存クラスにバリデーション用のアクションを追記し作成する。
##記事の追加
src/Controller/ArticlesController.phpのクラス内にaddアクションを追記する
public function add()
{
$article = $this->Articles->newEntity();
if ($this->request->is('post')) {
$article = $this->Articles->patchEntity($article, $this->request->getData());
if ($this->Articles->save($article)) {
$this->Flash->success(__('記事を保存する'));
return $this->redirect(['action' => 'index']);
$this->Flash->error(__('記事の追加が出来ません。'));
}
}
$this->set('article', $article);
}
###add() アクション説明
・リクエストの HTTP メソッドが POST なら、Articles モデルを使ってデータの保存を試みます。 何らかの理由で保存できなかった場合には、単にビューを表示
・ユーザーがフォームを使ってデータを POST した場合、その情報は、 $this->request->getData()の中に入ってきます。
・FlashComponent の success() および error() メソッドを使って セッション変数にメッセージをセット。これらのメソッドは PHP の マジックメソッド を利用→レイアウトでは<?= $this->Flash->render() ?> を用いてメッセージを表示
・ ['action' => 'index'] パラメーターは /articles、つまり articles コントローラーの index アクションを表す URL に移動する設定をしている。
・save() メソッドを呼ぶと、バリデーションエラーがチェックされ、もしエラーがある場合には 保存動作を中止します。
##記事追加ページの作成とバリデーションについて
↑公式ドキュメントより
cakephpではバリデーションを使用する為にビューの中でcakephpのフォームを利用するようにと言っている。
上記を念頭にadd.ctpファイルをTemplate/Articles/直下に作成します。
<h1>記事追加</h1>
<?php
echo $this->Form->create($article);
echo $this->Form->control('title');
echo $this->Form->control('body');
echo $this->Form->button(__('Save Article'));
echo $this->Form->end();
?>
URLで~/articles/addにアクセスすると
上記画面が表示されるようになる
##一覧ページから記事追加へのリンクの作成方法
index.ctpから上記add.ctpへ遷移するよう、以下のリンクをindex.ctpに記述する
<?= $this->Html->link('Add Article', ['action' => 'add']) ?>
index.ctp
<h1>ブログ記事</h1>
<?= $this->Html->link('記事追加',['action' => 'add']) ?>⬅︎この記述追加
<table>
<tr>
<th>Id</th>
<th>タイトル</th>
<th>作成日時</th>
</tr>
~以下略~
記事追加のリンクが追加されている事が確認出来る
##バリデーション作成方法
バリデーションのルールは、モデルの中で定義することができます
ArticlesTable.phpの既存クラス内にvalidationDefault()というアクションを追加します。
【ArticlesTable.php】に以下を追記
use Cake\Validation\Validator; //このクラスの読み取り追加
//以下のメソッドを追加
public function validationDefault(Validator $validator)
{
$validator
// ->notEmpty('title') //コンソールで「'notEmpty' is deprecated.」とnotEmptyは非推奨ですと表示されるのでnotBlankを使用
->notBlank('title')
->requirePresence('title')
->notBlank('body')
->requirePresence('body');
return $validator;
}
コメントになっているnotEmpty()はもともとcakeのドキュメントに記載されているものですが、こちらは現在非推奨のようなので（ターミナルに注意が表示されます）、notBlank()を使用している。
validationDefault() メソッドを使って save() メソッドが呼ばれた時に、 どうやってバリデートするかを CakePHP に教えます。ここでは、本文とタイトルのフィールドが、 空ではいけない、そして作成及び編集の際にどちらも必要であるということを設定しています。 CakePHP のバリデーションエンジンは強力で、 組み込みのルールがいろいろあります (クレジットカード番号、メールアドレスなど）。 また柔軟に、独自ルールを作って設定することもできます。この設定に関する詳細は、 バリデーション を参照してください。
##投稿記事の編集
コントローラーにedit()アクションを追加します。
【ArticlesController.php】の既存クラス内に以下を追記
public function edit($id = null)
{
$article = $this->Articles->get($id);
if($this->request->is(['post','put'])){
$this->Articles->patchEntity($article, $this->request->getData());
if($this->Articles->save($article)){
$this->Flash->success(__('記事が更新されました'));
return $this->redirect(['action' =>'index']);//ここの記述で保存実行時にindexページへ戻っている
}
$this->Flash->error(__('更新出来ませんでした。'));
}
$this->set('article', $article);
}
このアクションではまず、ユーザーが実在するレコードにアクセスしようとしていることを確認します。 もし $id パラメーターが渡されてないか、ポストが存在しない場合、 NotFoundException を送出して CakePHP の ErrorHandler に処理を委ねます。
次に、リクエストが POST か PUT であるかをチェックします。もしリクエストが POST か PUT なら、 patchEntity() メソッドを用いてPOST データを記事エンティティーに更新します。 最終的にテーブルオブジェクトを用いて、エンティティーを保存したり、退けてバリデーションエラーを表示したりします。
次に編集用のビューファイルを作成します
【src/Template/Articles/edit.ctp】
<h1>記事の編集</h1>
<?php
echo $this->Form->create($article);
echo $this->Form->control('title');
echo $this->Form->control('body',['rows' =>'3']);
echo $this->Form->button(__('記事保存'));
echo $this->Form->end();
?>
作成される画面（hoge.jp/articles/edit)
###ポイント(追加と編集の違い）
コントローラーでアクションを作成する際に
add
$article = $this->Articles->newEntity();
edit
$article = $this->Articles->get($id);
と変数articleに入れている値が異なっている。
これによって新たにエンティティを作るか既存のものを取得するかが変わる。
あとはindex.ctpにeditへのリンクを作る
<td>
<?= $this->Html->link('編集', ['action' => 'edit', $article->id]) ?>
</td>
上記を追加すればOK。
##投稿記事の削除
【ArticlesTable.php】に以下のアクションを追加
public function delete($id)
{
$this->request->allowMethod(['post', 'delete']);
$article = $this->Articles->get($id);
if($this->Articles->delete($article)){
$this->Flash->success(__('id: {0} の記事が削除されました。', h($id)));
return $this->redirect(['action' => 'index']);
}
}
###ポイント
deleteはロジックを実行してリダイレクトする為、アクションに対してビューがありません。
こういうパターンがあることを抑える。
最後に編集と同様削除のリンクをindex.ctpの
<td></td>内に作成します。
【Articles/index.ctp】
<h1>ブログ記事</h1>
<?= $this->Html->link('記事追加',['action' => 'add']) ?>
<table>
<tr>
<th>Id</th>
<th>タイトル</th>
<th>作成日時</th>
<th>編集</th>
</tr>
<?php foreach ($articles as $article) : ?>
<tr>
<td><?= $article->id ?></td>
<td>
<?= $this->Html->link($article->title, ['action' => 'view', $article->id]) ?>
</td>
<td>
<?= $article->created->format('y/m/d'); ?>
</td>
<td>
<?= $this->Form->postLink(
'削除 ',
['action' => 'delete', $article->id],
['confirm' => '本当に削除しますか?'])
?>
<?= $this->Html->link('編集', ['action' => 'edit', $article->id]) ?>
</td>
</tr>
<?php endforeach; ?>
</table>
【完成した画面】
以上で基本的なCRUD操作は完了です。
#第3章その他機能
##ルーティング
###デフォルトでhoge.jp/articlesとなっている記事一覧のURLをhoge.jpに変更する方法。
config/routes.phpを編集します。
デフォルトで
$routes->connect('/', ['controller' => 'Pages', 'action' => 'display', 'home']);
となっている上記を
$routes->connect('/', ['controller' => 'Articles', 'action' => 'index']);
へ変更します。
これで、「/」でリクエストしてきたユーザーを、ArticlesController の index() アクションに 接続させることができます。
さらに詳しい内容は公式のブログチュートリアル３に記載があります。
ブログチュートリアル３
ひとまず以上です。