ブログチュートリアル - レイヤーの追加

Post モデルの作成

モデルクラスは、CakePHP アプリケーションの基本中の基本 (bread and butter) です。 CakePHP のモデルを作成することで、データベースとやりとりできるようになり、表示 (view)、 追加 (add)、編集 (edit)、削除 (delete) といった操作に必要な土台を 手に入れることになります。

CakePHP のモデルクラスのファイルは、 /app/Model の中にあり、今回は、 /app/Model/Post.php というファイルを作って保存します。 ファイルの中身全体は次のようになります:

class Post extends AppModel {
}

命名規約は、CakePHP では非常に大切です。モデルを Post という名前にすることで、 CakePHP は自動的に、このモデルは PostsController で使用されるのだろうと考えます。 また、 posts という名前のデータベーステーブルと結びつけられます。

注釈

もし一致するファイルが /app/Model に見つけられなければ、CakePHP は動的に モデルオブジェクトを生成します。これはまた、不意に間違ったファイル名 (例えば、 post.php や posts.php) をつけると、CakePHP はどんな設定も認識できず、 代わりにデフォルトのものを使うことになるということも意味します。

テーブルの接頭辞 (prefix) や、コールバック、バリデーションといったモデルの詳細については、 マニュアルの モデル の章を参照してください。

Posts コントローラの作成

次に、投稿記事 (posts) に対するコントローラを作成します。 コントローラとは、投稿記事とやりとりするためのビジネスロジックが入るところです。 簡単に言うと、それは幾つかのモデルとやりとりし、投稿記事に関連する作業を行う場所です。 この新しいコントローラは、 PostsController.php という名前で、 /app/Controller ディレクトリの中に配置します。基本的なコントローラは次のようになります:

class PostsController extends AppController {
    public $helpers = array('Html', 'Form');
}

では、コントローラにひとつのアクションを追加してみましょう。アクションは、 アプリケーションの中のひとつの関数か、インターフェイスをあらわしています。 例えば、ユーザが www.example.com/posts/index (www.example.com/posts/ と同じです) をリクエストした場合、投稿記事の一覧が表示されると期待するでしょう。 このアクションのコードは次のようになります:

class PostsController extends AppController {
    public $helpers = array('Html', 'Form');

    public function index() {
        $this->set('posts', $this->Post->find('all'));
    }
}

PostsController の中に index() という関数を定義することによって、ユーザは、 www.example.com/posts/index というリクエストで、そのロジックにアクセスできるようになります。 同様に、 foobar() という関数を定義すると、ユーザは、www.example.com/posts/foobar でアクセスできるようになります。

警告

ある URL にさせたいために、コントローラ名とアクション名をそれに合わせて独自に 命名したくなるかもしれませんが、その誘惑に抵抗してください。CakePHP の規約 (大文字化、複数形の名前など)に従って、読みやすく、理解しやすいアクション名を 付けるようにしましょう。あとで、「routes」という機能を使って、URL とコードを 結びつけることができます。

アクションの中にあるひとつの命令が、 set() を使って、コントローラからビュー (次に作成します) にデータを渡しています。この行は、Post モデルの find('all') メソッドから返ってきた値で、「posts」というビューの変数を設定します。 Post モデルは自動的に $this->Post として呼び出せるようになります。 これは、CakePHP の命名規約に従っているからです。

CakePHP のコントローラに関する詳細は、 コントローラ の章をチェックしてください。

Post ビューの作成

現在、モデルにはデータが入り、コントローラにはアプリケーションロジックと流れが定義されています。 今度は、作成した index アクション用のビューを作成しましょう。

CakePHP のビュー (view) は、アプリケーションのレイアウト (layout) の内側に はめこまれる、データ表示用の断片部品です。たいていのアプリケーションでは、PHP のコードが 含まれる HTML になりますが、XML、CSV、バイナリのデータにもなりえます。

レイアウト (Layout) は、ビューを囲む表示用のコードで、独自に定義したり、 切り替えたりすることも可能ですが、今のところは、デフォルト (default) のものを 使用することにしましょう。

一つ前のセクションの set() メソッドによって、ビューから「posts」変数が使えるように 割り当てたのを覚えていますか。ビューに渡されたデータは次のようなものになっています:

// print_r($posts) の出力:

Array
(
    [0] => Array
        (
            [Post] => Array
                (
                    [id] => 1
                    [title] => タイトル
                    [body] => これは、記事の本文です。
                    [created] => 2008-02-13 18:34:55
                    [modified] =>
                )
        )
    [1] => Array
        (
            [Post] => Array
                (
                    [id] => 2
                    [title] => またタイトル
                    [body] => そこに本文が続きます。
                    [created] => 2008-02-13 18:34:56
                    [modified] =>
                )
        )
    [2] => Array
        (
            [Post] => Array
                (
                    [id] => 3
                    [title] => タイトルの逆襲
                    [body] => こりゃ本当にわくわくする!うそ。
                    [created] => 2008-02-13 18:34:57
                    [modified] =>
                )
        )
)

CakePHP のビューファイルは、 /app/View の中の、コントローラ名に対応するフォルダの中に 保存されています (この場合は、「Posts」というフォルダを作成します)。 この投稿記事データをテーブル表示するには、ビューのコードは次のようなものにできます

<!-- File: /app/View/Posts/index.ctp -->

<h1>Blog posts</h1>
<table>
    <tr>
        <th>Id</th>
        <th>Title</th>
        <th>Created</th>
    </tr>

    <!-- ここから、$posts配列をループして、投稿記事の情報を表示 -->

    <?php foreach ($posts as $post): ?>
    <tr>
        <td><?php echo $post['Post']['id']; ?></td>
        <td>
            <?php echo $this->Html->link($post['Post']['title'],
array('controller' => 'posts', 'action' => 'view', $post['Post']['id'])); ?>
        </td>
        <td><?php echo $post['Post']['created']; ?></td>
    </tr>
    <?php endforeach; ?>
    <?php unset($post); ?>
</table>

$this->Html というオブジェクトを使っていることに気づいたかもしれません。 これは、CakePHP の HtmlHelper クラスのインスタンスです。 CakePHP には一連のビューヘルパーがあり、リンクの作成、フォームの出力、 JavaScript、AJAX などをすぐに使えます。使い方の詳細については、 ヘルパー を参照してください。ここで重要なのは、 link() メソッドが、指定されたタイトル(最初のパラメータ)と URL (二つ目のパラメータ) で HTML リンクを生成する、ということです。

CakePHP 内で URL を指定する場合、配列フォーマットの使用が推奨されます。 これはルーティングの章で詳しく説明されます。URL に配列フォーマットを用いることによって、 CakePHP のリバースルーティング機能を活用することができます。また、 /コントローラ/アクション/パラメータ1/パラメータ2 という形のアプリケーションの基本パスに対する相対パスを単に書くこともできます。

この時点で、ブラウザから http://www.example.com/posts/index を開いてみてください。 タイトルと投稿内容のテーブル一覧がまとめられているビューが表示されるはずです。

ビューの中のリンク (投稿記事のタイトルから /posts/view/some_id という URL へのリンク) を クリックすると、CakePHP は、そのアクションはまだ定義されていません、という表示を出します。 もしそういう表示が出ない場合には、何かおかしくなってしまったか、もうすでにあなたが その定義作業をしてしまったから(仕事がハヤイ!)か、のどちらかです。 そうでないなら、これから PostsController の中に作ってみましょう:

// File: /app/Controller/PostsController.php
class PostsController extends AppController {
    public $helpers = array('Html', 'Form');

    public function index() {
         $this->set('posts', $this->Post->find('all'));
    }

    public function view($id = null) {
        if (!$id) {
            throw new NotFoundException(__('Invalid post'));
        }

        $post = $this->Post->findById($id);
        if (!$post) {
            throw new NotFoundException(__('Invalid post'));
        }
        $this->set('post', $post);
    }
}

set() の呼び出しはもう知っていますね。 find('all') の代わりに、 findById() を使っていることに注目してください。今回は、ひとつの投稿記事の情報しか 必要としないからです。

ビューのアクションが、ひとつのパラメータを取っていることに注意してください。 それは、これから表示する投稿記事のID番号です。このパラメータは、リクエストされた URL を通して渡されます。ユーザが、 /posts/view/3 とリクエストすると、 「3」という値が $id として渡されます。

ユーザーが実在するレコードにアクセスすることを保証するために少しだけエラーチェックを行います。 もしユーザが /posts/view とリクエストしたら、 NotFoundException を送出し CakePHP の ErrorHandler に処理が引き継がれます。また、ユーザーが存在するレコードに アクセスしたことを確認するために同様のチェックを実行します。

では、新しい「view」アクション用のビューを作って、 /app/View/Posts/view.ctp というファイルで保存しましょう。

<!-- File: /app/View/Posts/view.ctp -->

<h1><?php echo h($post['Post']['title']); ?></h1>

<p><small>Created: <?php echo $post['Post']['created']; ?></small></p>

<p><?php echo h($post['Post']['body']); ?></p>

/posts/index の中にあるリンクをクリックしたり、手動で、 /posts/view/1 にアクセスしたりして、動作することを確認してください。

記事の追加

データベースを読み、記事を表示できるようになりました。今度は、新しい投稿が できるようにしてみましょう。

まず、PostsController の中に、 add() アクションを作ります:

class PostsController extends AppController {
    public $helpers = array('Html', 'Form', 'Flash');
    public $components = array('Flash');

    public function index() {
        $this->set('posts', $this->Post->find('all'));
    }

    public function view($id) {
        if (!$id) {
            throw new NotFoundException(__('Invalid post'));
        }

        $post = $this->Post->findById($id);
        if (!$post) {
            throw new NotFoundException(__('Invalid post'));
        }
        $this->set('post', $post);
    }

    public function add() {
        if ($this->request->is('post')) {
            $this->Post->create();
            if ($this->Post->save($this->request->data)) {
                $this->Flash->success(__('Your post has been saved.'));
                return $this->redirect(array('action' => 'index'));
            }
            $this->Flash->error(__('Unable to add your post.'));
        }
    }
}

注釈

$this->request->is() は、リクエストのメソッド (get, put, post, delete) もしくはリクエストの識別子 (ajax) を指定する1つの引数を持ちます。 それは、ポストされたデータの内容をチェックするためのものでは ありません$this->request->is('book') は、 もし book データがポストされたとしても、 true を返しません。

注釈

FlashComponent と FlashHelper を、使うコントローラで読み込む必要があります。 必要不可欠なら、AppController で読み込むようにしてください。

add() アクションの動作は次のとおりです: もし、リクエストの HTTP メソッドが POST なら、Post モデルを使ってデータの保存を試みます。 何らかの理由で保存できなかった場合には、単にビューを表示します。 この時に、ユーザバリデーションエラーやその他の警告が表示されることになります。

すべての CakePHP のリクエストは CakeRequest オブジェクトに格納されており、 $this->request でアクセスできます。リクエストオブジェクトには、受信したリクエストに 関するいろんな情報が含まれているので、アプリケーションのフローの制御に利用できます。今回は、 リクエストが HTTP POST かどうかの確認に CakeRequest::is() メソッドを 使用しています。

ユーザがフォームを使ってデータを POST した場合、その情報は、 $this->request->data の中に入ってきます。 pr()debug() を使うと、 内容を画面に表示させて、確認することができます。

FlashComponent の FlashComponent::success() メソッドを使って セッション変数にメッセージをセットすることによって、リダイレクト後のページでこれを表示します。 レイアウトでは FlashHelper::render() を用いて、メッセージを表示し、 対応するセッション変数を削除します。コントローラの Controller::redirect 関数は別の URL にリダイレクトを行います。 array('action' => 'index') パラメータは /posts、つまり posts コントローラの index アクションを表す URL に解釈されます。 多くの CakePHP の関数で指定できるURLのフォーマットについては、 APIRouter::url() 関数を参考にすることができます。

save() メソッドを呼ぶと、バリデーションエラーがチェックされ、もしエラーがある場合には 保存動作を中止します。これらのエラーがどのように扱われるのかは次のセクションで見てみましょう。

新しい情報を保存するために、最初に create() メソッドでモデルの状態をリセットします。 それは、データベース内にレコードを作成するわけではなく、 Model::$id を消去し、 データベースフィールドのデフォルト値を元に Model::$data を設定します。

データのバリデーション

CakePHP はフォームの入力バリデーションの退屈さを取り除くのに大いに役立ちます。 みんな、延々と続くフォームとそのバリデーションルーチンのコーディングは好まないでしょう。 CakePHP を使うと、その作業を簡単、高速に片付けることができます。

バリデーションの機能を活用するためには、ビューの中で CakePHP の FormHelper を 使う必要があります。 FormHelper はデフォルトで、すべてのビューの中で $this->Form としてアクセスできるようになっています。

add のビューは次のようなものになります:

<!-- File: /app/View/Posts/add.ctp -->

<h1>Add Post</h1>
<?php
echo $this->Form->create('Post');
echo $this->Form->input('title');
echo $this->Form->input('body', array('rows' => '3'));
echo $this->Form->end('Save Post');
?>

ここで、FormHelper を使って、HTML フォームの開始タグを生成しています。 $this->Form->create() が生成した HTML は次のようになります:

<form id="PostAddForm" method="post" action="/posts/add">

create() にパラメータを渡さないで呼ぶと、現在のコントローラの add() アクション (または id がフォームデータに含まれる場合 edit() アクション) に、 POST で送るフォームを構築している、と解釈されます。

$this->Form->input() メソッドは、同名のフォーム要素を作成するのに使われています。 最初のパラメータは、どのフィールドに対応しているのかを CakePHP に教えます。 2番目のパラメータは、様々なオプションの配列を指定することができます。 - この例では、textarea の列の数を指定しています。 ここではちょっとした内観的で自動的な手法が使われています。 input() は、指定されたモデルのフィールドに基づいて、異なるフォーム要素を出力します。

$this->Form->end() の呼び出しで、submit ボタンとフォームの終了部分が出力されます。 end() の最初のパラメータとして文字列が指定してある場合、FormHelper は、 それに合わせて submit ボタンに名前をつけ、終了フォームタグも出力します。 ヘルパーの詳細に関しては、 ヘルパー を参照してください。

さて少し戻って、 /app/View/Posts/index.ctp のビューで「Add Post」というリンクを 新しく表示するように編集しましょう。 <table> の前に、以下の行を追加してください:

<?php echo $this->Html->link(
    'Add Post',
    array('controller' => 'posts', 'action' => 'add')
); ?>

バリデーション要件について、どうやって CakePHP に指示するのだろう、と思ったかもしれません。 バリデーションのルールは、モデルの中で定義することができます。 Post モデルを見直して、幾つか修正してみましょう:

class Post extends AppModel {
    public $validate = array(
        'title' => array(
            'rule' => 'notBlank'
        ),
        'body' => array(
            'rule' => 'notBlank'
        )
    );
}

$validate 配列を使って、 save() メソッドが呼ばれた時に、 どうやってバリデートするかを CakePHP に教えます。ここでは、本文とタイトルのフィールドが、 空ではいけない、ということを設定しています。CakePHP のバリデーションエンジンは強力で、 組み込みのルールがいろいろあります (クレジットカード番号、メールアドレスなど)。 また柔軟に、独自ルールを作って設定することもできます。この設定に関する詳細は、 データバリデーション を参照してください。

バリデーションルールを書き込んだので、アプリケーションを動作させて、タイトルと本文を 空にしたまま、記事を投稿してみてください。 FormHelper::input() メソッドを 使ってフォーム要素を作成したので、バリデーションエラーのメッセージが自動的に表示されます。

投稿記事の編集

それではさっそく投稿記事の編集ができるように作業をしましょう。 もう CakePHP プロのあなたは、パターンを見つけ出したでしょうか。 アクションをつくり、それからビューを作る、というパターンです。 PostsController の edit() アクションはこんな形になります:

public function edit($id = null) {
    if (!$id) {
        throw new NotFoundException(__('Invalid post'));
    }

    $post = $this->Post->findById($id);
    if (!$post) {
        throw new NotFoundException(__('Invalid post'));
    }

    if ($this->request->is(array('post', 'put'))) {
        $this->Post->id = $id;
        if ($this->Post->save($this->request->data)) {
            $this->Flash->success(__('Your post has been updated.'));
            return $this->redirect(array('action' => 'index'));
        }
        $this->Flash->error(__('Unable to update your post.'));
    }

    if (!$this->request->data) {
        $this->request->data = $post;
    }
}

このアクションではまず、ユーザが実在するレコードにアクセスしようとしていることを確認します。 もし $id パラメータが渡されてないか、ポストが存在しない場合、 NotFoundException を送出して CakePHP の ErrorHandler に処理を委ねます。

次に、リクエストが POST か PUT であるかをチェックします。もしリクエストが POST か PUT なら、 POST データでレコードを更新したり、バリデーションエラーを表示したりします。

もし $this->request->data が空っぽだったら、取得していたポストレコードを そのままセットしておきます。

edit ビューは以下のようになるでしょう:

<!-- File: /app/View/Posts/edit.ctp -->

<h1>Edit Post</h1>
<?php
echo $this->Form->create('Post');
echo $this->Form->input('title');
echo $this->Form->input('body', array('rows' => '3'));
echo $this->Form->input('id', array('type' => 'hidden'));
echo $this->Form->end('Save Post');
?>

(値が入力されている場合、)このビューは、編集フォームを出力します。 必要であれば、バリデーションのエラーメッセージも表示します。

ひとつ注意: CakePHP は、「id」フィールドがデータ配列の中に存在している場合は、 モデルを編集しているのだと判断します。もし、「id」がなければ、(add のビューを復習してください) save() が呼び出された時、CakePHP は新しいモデルの挿入だと判断します。

これで、特定の記事をアップデートするためのリンクを index ビューに付けることができます:

<!-- File: /app/View/Posts/index.ctp  (編集リンクを追加済み) -->

<h1>Blog posts</h1>
<p><?php echo $this->Html->link("Add Post", array('action' => 'add')); ?></p>
<table>
    <tr>
        <th>Id</th>
        <th>Title</th>
        <th>Action</th>
        <th>Created</th>
    </tr>

<!-- $posts 配列をループして、投稿記事の情報を表示 -->

<?php foreach ($posts as $post): ?>
    <tr>
        <td><?php echo $post['Post']['id']; ?></td>
        <td>
            <?php
                echo $this->Html->link(
                    $post['Post']['title'],
                    array('action' => 'view', $post['Post']['id'])
                );
            ?>
        </td>
        <td>
            <?php
                echo $this->Html->link(
                    'Edit',
                    array('action' => 'edit', $post['Post']['id'])
                );
            ?>
        </td>
        <td>
            <?php echo $post['Post']['created']; ?>
        </td>
    </tr>
<?php endforeach; ?>

</table>

投稿記事の削除

次に、ユーザが投稿記事を削除できるようにする機能を作りましょう。 PostsController の delete() アクションを作るところから始めます:

public function delete($id) {
    if ($this->request->is('get')) {
        throw new MethodNotAllowedException();
    }

    if ($this->Post->delete($id)) {
        $this->Flash->success(
            __('The post with id: %s has been deleted.', h($id))
        );
    } else {
        $this->Flash->error(
            __('The post with id: %s could not be deleted.', h($id))
        );
    }

    return $this->redirect(array('action' => 'index'));
}

このロジックは、$id で指定された記事を削除し、 $this->Flash->success() を使って、ユーザに確認メッセージを表示し、それから /posts にリダイレクトします。 ユーザーが GET リクエストを用いて削除を試みようとすると、例外を投げます。 捕捉されない例外は CakePHP の例外ハンドラーによって捕まえられ、気の利いたエラーページが 表示されます。多くの組み込み 例外(Exception) があり、アプリケーションが 生成することを必要とするであろう様々な HTTP エラーを指し示すのに使われます。

ロジックを実行してリダイレクトするので、このアクションにはビューがありません。 しかし、index ビューにリンクを付けて、投稿を削除するようにできるでしょう:

<!-- File: /app/View/Posts/index.ctp -->

<h1>Blog posts</h1>
<p><?php echo $this->Html->link('Add Post', array('action' => 'add')); ?></p>
<table>
    <tr>
        <th>Id</th>
        <th>Title</th>
        <th>Actions</th>
        <th>Created</th>
    </tr>

<!-- ここで $posts 配列をループして、投稿情報を表示 -->

    <?php foreach ($posts as $post): ?>
    <tr>
        <td><?php echo $post['Post']['id']; ?></td>
        <td>
            <?php
                echo $this->Html->link(
                    $post['Post']['title'],
                    array('action' => 'view', $post['Post']['id'])
                );
            ?>
        </td>
        <td>
            <?php
                echo $this->Form->postLink(
                    'Delete',
                    array('action' => 'delete', $post['Post']['id']),
                    array('confirm' => 'Are you sure?')
                );
            ?>
            <?php
                echo $this->Html->link(
                    'Edit', array('action' => 'edit', $post['Post']['id'])
                );
            ?>
        </td>
        <td>
            <?php echo $post['Post']['created']; ?>
        </td>
    </tr>
    <?php endforeach; ?>

</table>

postLink() を使うと、投稿記事の削除を行う POST リクエストをするための JavaScript を使うリンクが生成されます。ウェブクローラーが 不意にコンテンツ全てを削除できてしまうので、GETリクエストを用いたコンテンツの削除を 許可することは危険です。

注釈

このビューコードは FormHelper を使い、削除する前に、JavaScript による 確認ダイアログでユーザに確認します。

ルーティング(Routes)

CakePHP のデフォルトのルーティングの動作で十分だという人もいます。しかし、ユーザフレンドリで 一般の検索エンジンに対応できるような操作に関心のある開発者であれば、CakePHP の中で、 URL がどのように特定の関数の呼び出しにマップされるのかを理解したいと思うはずです。 このチュートリアルでは、routes を簡単に変える方法について扱います。

ルーティングテクニックの応用に関する情報は、 ルーティングの設定 を見てください。

今のところ、ユーザがサイト (たとえば、 http://www.example.com) を見に来ると、 CakePHP は PagesController に接続し、「home」というビューを表示するようになっています。 ではこれを、ルーティングルールを作成して PostsController に行くようにしてみましょう。

CakePHP のルーティングは、 /app/Config/routes.php の中にあります。 デフォルトのトップページのルートをコメントアウトするか、削除します。 この行です:

Router::connect(
    '/',
    array('controller' => 'pages', 'action' => 'display', 'home')
);

この行は、「/」という URL をデフォルトの CakePHP のホームページに接続します。 これを、自分のコントローラに接続させるために、次のような行を追加してください:

Router::connect('/', array('controller' => 'posts', 'action' => 'index'));

これで、「/」でリクエストしてきたユーザを、PostController の index() アクションに 接続させることができます。

注釈

CakePHP は「リバースルーティング」も利用します。 上記のルートが定義されている状態で、配列を期待する関数に array('controller' => 'posts', 'action' => 'index') を渡すと、結果のURLは「/」になります。 つまり、URL の指定に常に配列を使うということが良策となります。 これによりルートが URL の行き先を定義する意味を持ち、 リンクが確実に同じ場所を指し示すようになります。

まとめ

この方法に則ったアプリケーションの作成により、平和、賞賛、愛、お金までもが、 あなたが考えうる以上にもたらされるでしょう。シンプルですよね。ですが、気をつけてほしいのは、 このチュートリアルは、非常に基本的な点しか扱っていない、ということです。 CakePHP には、もっともっと 多くの 機能があります。シンプルなチュートリアルにするために、 それらはここでは扱いませんでした。マニュアルの残りの部分をガイドとして使い、 もっと機能豊かなアプリケーションを作成してください。

基本的なアプリケーションの作成が終わったので、現実世界のアプリを作る準備が整いました。 自分のプロジェクトを始めて、 Cookbook の残りと API を使いましょう。

もし困ったときは、いろんな方法で助けを得ることができます。 情報の探し方 を見てみてください。 CakePHP にようこそ!

お勧めの参考文献

CakePHP を学習する人が次に学びたいと思う共通のタスクがいくつかあります:

  1. レイアウト: ウェブサイトのレイアウトをカスタマイズする
  2. エレメント ビューのスニペットを読み込んで再利用する
  3. Scaffolding: コードを作成する前のプロトタイピング
  4. Bakeでコード生成 基本的な CRUD コードの生成
  5. シンプルな認証と承認のアプリケーション: ユーザの認証と承認のチュートリアル