[CakePHP] RESTを使ってViewをXML形式で返す

REST ? CakePHP Cookbook v2.x documentation
http://book.cakephp.org/2.0/ja/development/rest.html
湘南社中テクニカルブログ: <b>Server</b>CakePHPでRESTのJSON APIを作成する
http://blog.shonanshachu.com/2012/01/cakephprestjson-api.html
Cakephp 2.x の REST API を作成してみる ≪ Hello My World
http://plmin.us/blog/2013/01/29/cakephp-2-x-rest-api/
CakePHP2.0で配列をXMLに変換し出力する | Code Life
http://code-life.net/?p=1096

簡単に言えば、HTTPのURLを指定して、戻り値をXMLやJSONで取得する。XML-PRCの場合は、送るときにXMLデータをPOSTするのだが、RESTの場合はURLを使う。いわゆる ASP.NET MVCのWeb APIと同じ。POSTやPUTなどを使うが、手軽のはPOSTのほう。メソッド名さえ揃えてしまえば、POSTオンリーでもよい気がする。

CakePHP には、もともとRESTの機能を持っていて、XMLで返すことが簡単にできる…はずなのだが、結構苦労する。というのも、

REST ? CakePHP Cookbook v2.x documentation
http://book.cakephp.org/2.0/ja/development/rest.html

を見ると、REST の方法には、

  • _serialize を使う方法
  • xml/ フォルダを作る方法

と2つ載っているものの、_serialize の方法は動かない。正確に言うと、内部データを XML に変換しているときにこけてしまう…う~ん、これがバグなのかどうかはわからない。なので、xml/ フォルダに index.ctp 等の View を作って対応する。
新しい View を作ると便利なのが、元の View(ブラウザで開くときのview)を残しておくことができることで、_serialize を使うと、Controller 自身を書き換えてしまうことになるので、ブラウザからちょいちょいと修正したいときに不便。なので、ブラウザ用の view は残したままで、REST 用の view≒XMLを返す view を新しく追加する、という方式のほうが保守的によい。ただし、セキュリティ的にはブラウザ用の view もロックをしないといけない。データの更新機能は管理者レベルにしたいことが多いので、実運用の場合は別途ロックを掛ける必要がある。

■app/Config/routes.php を書き換える

app/Config/routes.php に Router::parseExtensions(); を追加する。Router::mapResources(‘recipes’); のようにテーブル名をマッピングするようにも書いてあるのだが、これがなくても動く。ちなみに、ドキュメントでは「require CAKE … よりも前に」となっているが、後ろでも動作する。が、先頭に書いておくのがベター。

//Router::mapResources('Stores');	// 無くてもok
Router::parseExtensions('xml');
...

■app/Controller/AppController.php を書き換える

本来は、RequestHandler を個別のControllerに入れるべきなのだが、数が多いので AppController に入れてしまう。こうすると全てのコントローラーとビューで xml/ フォルダへの routes が有効になる。

class AppController extends Controller {
	public $components = array('RequestHandler');
}

■xml/index.ctp を作る

View/Stores/ に xml というフォルダを作って、その中に index.ctp などを新しく作る。

+ View
 + Stores
  - index.ctp
  - view.ctp
  - edit.ctp
  - add.ctp
  + xml
   - index.ctp
   - view.ctp

こうすることで、http://localhost/Stores/ を呼び出したときは View/Stores/index.ctp を、http://localhost/Stores.xml を呼び出したときは View/Stores/xml//index.ctp が呼び出される。多分、xml は小文字(フォルダー名と同じ)にしないとダメだと思う。実験環境は windows 上なので、XML でも xml で通るのだが、Unix 環境だと区別すると思われる。

View/Stores/xml/index.ctp

$items = array('items'=
	array('item'=> $stores));
$xml = Xml::fromArray(array('response'=>$items));
echo $xml->asXML();

XML形式で返すように asXML メソッドを使う。Xml::fromArray へ配列を渡す形式は、

XML ? CakePHP Cookbook v2.x documentation
http://book.cakephp.org/2.0/ja/core-utility-libraries/xml.html

を参照。CakePHP の 1.x と 2.x で渡すときの形式が違っているので注意が必要。おそらく _serialize の方法がダメなのは、ここを間違っていると思われ。

返す結果は、以下のように items タグの中に item が複数ある形式になる。「$stores」のところは、Controller で set している名前に随時変更する。

<response>
 <items>
  <item>
   <Store>
    <ID>1</ID>
    <SellingCompanyID>1</SellingCompanyID>
    <AreaGroupID>26</AreaGroupID>
...
   <Store>
  <item>
    <item>
...
    </item>
 </items>
</response>

view の場合は、$store を元に単数で返せば ok

<!--?php $item = array('item'=--> $store);
$xml = Xml::fromArray(array('response'=>$item));
echo $xml->asXML();

■実行してみる

□http://localhost/Stores の場合

□http://localhost/Stores.xml の場合

□http://localhost/Stores/view/1 の場合

□http://localhost/Stores/view/1.xml の場合

index.ctp と view.ctp 自体はコピーアンドペーストで作れるので、適当なスクリプトを作って増産しておけばよい。編集機能(edit/add と DELETE)の場合は、むやみに使われないようにフォーム認証(BASIC認証)と合わせて作ることになるので、別途 C# のクライアントを作って試してみる。

~~~

追記

元のコントローラーを使っているのでページング機能が有効になっています。なので、デフォルトでは最初の20件しか取れません。このデータ自体は1万件以上あるので、すべてを取ってきてもダメ、できれば limit を指定したいところですね。全ページ数を取得するかどうかはさておき、「http://localhost/Stores/index/page:2.xml」のようにすれば、2ページ目も取得できます。

指定ページ以上を取得しようとして page:999.xml のようにすると、404 のエラーが発生するので、例外が出ている模様。このあたりを気を付ければ全件を取得できる?

カテゴリー: CakePHP | [CakePHP] RESTを使ってViewをXML形式で返す はコメントを受け付けていません

[CakePHP] シンプルな認証を実装する(認証の中盤)

[CakePHP] シンプルな認証を実装する(認証の前半) – Moonmile Solutions Blog
http://www.moonmile.net/blog/archives/4855

なところでフォーム認証ができたので「こんにちは、○○さん」だけ作ってみる。
下記のように、ログイン状態を表示して login/logout へのリンクもつける。

□ログインしていない状態
20130504_01

□ログイン状態

20130504_02

こんな風に、ログイン状態とリンクを表示させる。

■AppController.php を変更する

class AppController extends Controller {

    public $components = array(
        'Session',
        'Auth' => array(
        	// ログイン後に /Posts/index へジャンプ
        	'loginRedirect' => array('controller' => 'posts', 'action' => 'index'),
        	// ログアウト後に /Pages/home へジャンプ
			'logoutRedirect' => array('controller' => 'pages', 'action' => 'display', 'home'))
		);

    public function beforeFilter() {
    	// 各コントローラーの index と view を有効にする
        $this->Auth->allow('index', 'view');
        // 認証コンポーネントをViewで利用可能にしておく
        $this->set('auth',$this->Auth);
    }
}

*.ctp で直接表示することも考えたのだが、Controller 経由でないと Auth コンポーネントを扱えないので、VView で扱えるように AppController に $this->set(‘auth’, $this->Auth ); という形で View からも Auth を使えるようにしてしまう。スピード的にはどうなんだろう、と思うところもあるけれど、こうするとすべての view からログイン関係がアクセス可能になるので、コードが楽になる。

■View で login/logiout の表示を制御する

app/Posts/index.ctp

<div>
	<?php if ($auth->loggedIn()) : ?>
	<?php echo h($auth->user('username')); ?> さん、こんにちは <a href="/cakeu/Users/logout">logout</a>
	<?php else: ?>
	<a href="/cakeu/Users/login">login</a>
	<?php endif ?>
</div>
<div class="posts index">
	<h2><?php echo __('Posts'); ?></h2>
	<table cellpadding="0" cellspacing="0">
...

実際は「こんにちは○○さん」のところは、View のコンポーネントとして用意したほうがいいと思う。そうしないと、あちこちに View に同じコードが散らばるし、あとからフォーマットを変えようと思ってえらいことになってしまう。login 状態による分岐なので、Controller でレンダリングする方法もあるのだが、「こんにちは」の部分とか、login, logout へのリンクは view の範疇になるので、Controller に押し込むとちょっと変な形になりそう。ってことで View に。

ログインしているかどうかは $this->Auth->loggedIn() でしらべて、 $this->auth->user(‘username’) でユーザ名を拾ってくる。username 自体はデータベースの列名そのままなので、ニックネームとかロールとかも拾える。

そんな訳で続きは、ユーザ名やロールによって処理を分ける方式を。

カテゴリー: CakePHP | 1件のコメント

[CakePHP] シンプルな認証を実装する(認証の前半)

認証(ログインとログアウト)
http://book.cakephp.org/2.0/ja/tutorials-and-examples/blog-auth-example/auth.html#id3

のところを追加していく。チュートリアルではいきなり、AppController を書き換えてしまっているが、一度ログイン認証を実装してから、beforeFilter あたりを追加したほうが分かりやすいかも。実は「ログインした状態」を判別するのと、「ログインしたユーザーが操作ができるか」というのを判別するのとは別のことになる。例えば、ログインユーザーの名称をページに表示するために「ログインしているかどうか」の状態は必要かもしれないが、「ログインしたユーザーが操作できるか」は必要ない。操作が可能かどうかの判別は必要なのは、操作を拒否するときに限られるので。

公開するアクションの作成
http://book.cakephp.org/2.0/ja/core-libraries/components/authentication.html#id20

を見ると、全体が拒否(deny)の状態から、徐々に許可(allow)していくパターンになる。本来は、このほうが良いのだが、一部分だけ管理したい(denyしたい)場合がある。この場合は、$this->Auth->allow(); ですべてを許可してから、部分的に $this->Auth->deny(…); していくのだと思う。

[CakePHP] シンプルな認証を実装する(準備) – Moonmile Solutions Blog
http://www.moonmile.net/blog/archives/4837

の続きとして、フォーム認証から実装しよう。

チュートリアルの通りに、User に対して認証を使ってみる。

■User にログイン/ログアウトを実装する

app/Controller/AppController.php に $components を追加する。

class AppController extends Controller {

    public $components = array(
        'Session',
        'Auth' );
}

こうすることで、$this->Session と $this->Auth が使えるようになる。

app/Controller/UsersController.php に、login と logout を追加する。

class UsersController extends AppController {
/**
 * ログイン
 */
public function login() {
    if ($this->request->is('post')) {
        if ($this->Auth->login()) {
            $this->redirect($this->Auth->redirect());
        } else {
            $this->Session->setFlash(__('Invalid username or password, try again'));
        }
    }
}

/**
 * ログアウト
 */
public function logout() {
    $this->redirect($this->Auth->logout());
}
...

app/View/Users/login.ctp を新規作成する。

<div class="users form">
<?php echo $this->Session->flash('auth'); ?>
<?php echo $this->Form->create('User'); ?>
    <fieldset>
        <legend><?php echo __('Please enter your username and password'); ?></legend>
        <?php echo $this->Form->input('username');
        echo $this->Form->input('password');
    ?>
    </fieldset>
<?php echo $this->Form->end(__('Login')); ?>
</div>

app/Model/User.php で、保存時にパスワードをハッシュ化する。

App::uses('AppModel', 'Model');
App::uses('AuthComponent', 'Controller/Component');	// コンポーネントを追加
/**
 * User Model
 *
 */
class User extends AppModel {
/**
 * 保存時にパスワードをハッシュ化する
 */
	public function beforeSave($options = array()) {
	    if (isset($this->data[$this->alias]['password'])) {
	        $this->data[$this->alias]['password'] = AuthComponent::password($this->data[$this->alias]['password']);
	    }
	    return true;
	}
}

$this->Auth->login() では、ユーザー名とパスワードをチェックするのだが、パスワードはハッシュ値を使っている。なので、Model/User でパスワードを保存するときにハッシュ化しておく。これ、もともとのテーブルがハッシュ化してあればそれがいいんだけど、直書きの場合とか別な暗号化を行っている場合はどうなるんだろうか?ってのを調査しないと。

多分、

カスタム認証オブジェクトの作成
http://book.cakephp.org/2.0/ja/core-libraries/components/authentication.html#id5

あたりを使えばいけると思うのだが。

■試しに実行してみる

これを実行してみて http://localohst:81/cakeu/users/ にアクセスしてユーザーの一覧を表示させようとすると。

な風に、/users/login に飛ばされる。これは正しい操作で、Auth をインストールした時点で、ログインしていないユーザーは全ページのアクセスを禁止されているので、こうなる。デフォルトの設定として、ログインできていない場合は、/users/login に飛ばされるようになっているので、こんな動きになります。

で、通常の場合は、

  • ログインしていない状態でも Post の一覧(index)が見たい。
  • ログインしていない状態でも User の Add ができたい。
  • ログインしたら、なんらかのページにジャンプする。
  • ログアウトしたら、なんらかのページにジャンプする。

というのが必要な訳で、これを CakePHP のチュートリアルのように書き換えます。

■ログインしていない状態の設定

/Controller/AppController.php の beforeFilter を書き換えます。

class AppController extends Controller {

    public $components = array(
        'Session',
        'Auth' => array(
        	// ログイン後に /Posts/index へジャンプ
        	'loginRedirect' => array('controller' => 'posts', 'action' => 'index'),
        	// ログアウト後に /Pages/home へジャンプ
			'logoutRedirect' => array('controller' => 'pages', 'action' => 'display', 'home'))
		);

    public function beforeFilter() {
    	// 各コントローラーの index と view を有効にする
        $this->Auth->allow('index', 'view');
    }
}

Auth->allow メソッドは、公開するメソッドを羅列するので、この場合は「全コントローラーに対して index と view が有効になる」という設定になります。なので、Model ごとに細かい設定をすることも必要になり、User の add メソッドだけ有効(ユーザーを追加する)にするためには、/Controller/UsersController.php に beforeFilter を追加する必要があります。

/Controller/UsersController.php の beforeFilter を追加する。

class UsersController extends AppController {

	public function beforeFilter() {
	    parent::beforeFilter();
	    // ユーザー自身が登録できるようにする
	    $this->Auth->allow('add');
	}

これで、ログインしていないユーザーは、

  • /Users/
  • /Users/view
  • /Users/add
  • /Users/login
  • /Users/logout
  • /Posts/
  • /Posts/view

にアクセスできるようになります。login, logout はデフォルト値なので、これが変更になったときは別途設定が必要。

■改めてアクセスしてみる

今度は http://localohst:81/cakeu/users/ にアクセスしてユーザーの一覧が表示できます。

「List Posts」ボタンを押すと、/posts/ が表示できます。

編集しようと思って「Edit」ボタンを押すと、ログインの画面に強制的にジャンプします。

■ログインユーザーを作ってアクセスする

/Posts/edit などがアクセス禁止になっていることが分かったので、/users/add で、ログインユーザーを作ってアクセスしてみる。

Role は一般ユーザーということで「Users」としておきます。今回の users テーブルでは Role は自由に設定できるので、想定として「Administrators(管理者)」と「Users(制限ユーザー)」のようなイメージにしておけば ok かと。ブログの場合は「Author」とか「Editor」を使えばわかりやすい。

submit すると、/users/ へジャンプする。

この状態では、まだログインはしていないので、あらためて、/users/login にアクセスするか、アクセス禁止の Edit ボタンを押して、ログインの画面にジャンプ。

うまくログインができると、/pages/home にジャンプする。実はこのページはルートのページになるので、http://localhost:81/cakeu/ にアクセスした時と同じページがでる。

※実は、ここに落とし穴があって、ログインしていないユーザーが http://localhost:81/cakeu/ のようにルートにアクセスするとログイン画面に飛ばされる。SNS の場合にはそれでもいいんだけど、ブログのような場合は、ページ一覧 /posts/ に飛んで欲しかったりするよね。そんな場合は、Controller/AppController.php で Auth のところで authError を追加すればいいはずなんですが…うまくいきませんね。これは後で調査。

■ユーザー情報を使う

ログインしたことは確認できたので、ログイン情報を使って定番の「こんにちは○○さん」を出してみます。これはチュートリアルにないので、オリジナル的に…ってのは次で。

カテゴリー: CakePHP | [CakePHP] シンプルな認証を実装する(認証の前半) はコメントを受け付けていません

[CakePHP] シンプルな認証を実装する(準備)

シンプルな認証と承認のアプリケーション ? CakePHP Cookbook v2.x documentation
http://book.cakephp.org/2.0/ja/tutorials-and-examples/blog-auth-example/auth.html

を利用して、フォーム認証(普通のユーザー名とパスワードを使ったログイン)を実装する。

というか、チュートリアルのままで動かしてみるというテスト。

  1. テーブルを作る。
  2. cake bake して、CRUD を作る。
  3. ログイン認証部分を作る。
  4. ロールとユーザーでアクセスを制御する。

の流れになる。

■必要なテーブル

テストするための最低限のテーブルを用意する。

ブログチュートリアル ? CakePHP Cookbook v2.x documentation
http://book.cakephp.org/2.0/ja/tutorials-and-examples/blog/blog.html

□posts テーブル

/* まず、postsテーブルを作成します: */
CREATE TABLE posts (
    id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
    title VARCHAR(50),
    body TEXT,
    created DATETIME DEFAULT NULL,
    modified DATETIME DEFAULT NULL
);
/* それから、テスト用に記事をいくつか入れておきます: */
INSERT INTO posts (title,body,created)
    VALUES ('タイトル', 'これは、記事の本文です。', NOW());
INSERT INTO posts (title,body,created)
    VALUES ('またタイトル', 'そこに本文が続きます。', NOW());
INSERT INTO posts (title,body,created)
    VALUES ('タイトルの逆襲', 'こりゃ本当にわくわくする!うそ。', NOW());

□users テーブル

CREATE TABLE users (
    id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
    username VARCHAR(50),
    password VARCHAR(50),
    role VARCHAR(20),
    created DATETIME DEFAULT NULL,
    modified DATETIME DEFAULT NULL
);

※規約にしたがって、複数形「posts」と「users」で用意すると、$useTable しなくて済む…が、既存のテーブルを使っても可能。

※列名を created, modified としておくと、自動で作成日時、更新日時が入る。手作業でやる場合は別途調査。

■Config/database.php を書き換える

cake bake がデータベースに接続できるように detabase.php を書き換えておく。

class DATABASE_CONFIG {
	public $default = array(
		'datasource' => 'Database/Mysql',
		'persistent' => false,
		'host' => 'localhost',
		'login' => 'user',
		'password' => 'password',
		'database' => 'test_database_name',
		'prefix' => '',
		'encoding' => 'utf8',
	);
}

■cake bake all で MVC を作成する

Consolecake bake all で Post と User の MVC を作成する。

※面倒がなければ、phpunit のひな形も作成しまえばok。

■IE で確認

http://localhost:81/cakeu/Posts
http://localhost:81/cakeu/Users

にアクセスをして確認(フォルダ名とポートは適宜変更)


この状態で、自由に Post と User が編集できる状態になる。

■できあがった MVC

cake bake all すると同じものができるけど、あとから参照できるの自動生成される MVC ファイルを貼り付けておきます。ソースコードを見ると、$this->request->is(‘post’) な REST の部分とか、$this->Session->setFlash なセッション部分とかが生成されていて、御影上ややこしくなっているけど、マスターテーブルの編集なんかはこれで十分なので、そのまま活用してもよいと思う。

□Model/Post.php

<?php
App::uses('AppModel', 'Model');
/**
 * Post Model
 *
 */
class Post extends AppModel {

}
&#91;/code&#93;
<p>
※リンクとかしてないので空っぽ
</p>
<p>
□Controller/PostController.php
[code lang="php"]
<?php
App::uses('AppController', 'Controller');
/**
 * Posts Controller
 *
 * @property Post $Post
 */
class PostsController extends AppController {

/**
 * index method
 *
 * @return void
 */
	public function index() {
		$this->Post->recursive = 0;
		$this->set('posts', $this->paginate());
	}

/**
 * view method
 *
 * @throws NotFoundException
 * @param string $id
 * @return void
 */
	public function view($id = null) {
		if (!$this->Post->exists($id)) {
			throw new NotFoundException(__('Invalid post'));
		}
		$options = array('conditions' => array('Post.' . $this->Post->primaryKey => $id));
		$this->set('post', $this->Post->find('first', $options));
	}

/**
 * add method
 *
 * @return void
 */
	public function add() {
		if ($this->request->is('post')) {
			$this->Post->create();
			if ($this->Post->save($this->request->data)) {
				$this->Session->setFlash(__('The post has been saved'));
				$this->redirect(array('action' => 'index'));
			} else {
				$this->Session->setFlash(__('The post could not be saved. Please, try again.'));
			}
		}
		$users = $this->Post->User->find('list');
		$this->set(compact('users'));
	}

/**
 * edit method
 *
 * @throws NotFoundException
 * @param string $id
 * @return void
 */
	public function edit($id = null) {
		if (!$this->Post->exists($id)) {
			throw new NotFoundException(__('Invalid post'));
		}
		if ($this->request->is('post') || $this->request->is('put')) {
			if ($this->Post->save($this->request->data)) {
				$this->Session->setFlash(__('The post has been saved'));
				$this->redirect(array('action' => 'index'));
			} else {
				$this->Session->setFlash(__('The post could not be saved. Please, try again.'));
			}
		} else {
			$options = array('conditions' => array('Post.' . $this->Post->primaryKey => $id));
			$this->request->data = $this->Post->find('first', $options);
		}
		$users = $this->Post->User->find('list');
		$this->set(compact('users'));
	}

/**
 * delete method
 *
 * @throws NotFoundException
 * @param string $id
 * @return void
 */
	public function delete($id = null) {
		$this->Post->id = $id;
		if (!$this->Post->exists()) {
			throw new NotFoundException(__('Invalid post'));
		}
		$this->request->onlyAllow('post', 'delete');
		if ($this->Post->delete()) {
			$this->Session->setFlash(__('Post deleted'));
			$this->redirect(array('action' => 'index'));
		}
		$this->Session->setFlash(__('Post was not deleted'));
		$this->redirect(array('action' => 'index'));
	}
}

□Model/User.php

<?php
App::uses('AppModel', 'Model');
/**
 * User Model
 *
 */
class User extends AppModel {

}
&#91;/code&#93;
<p>
※Post と同じようにリンクとかしてないので空っぽ
</p>
※外部キーを使うと、Post と User がリンクするようになる
</p>
<p>
□Controller/UserController.php
[code lang="php"]
<?php
App::uses('AppController', 'Controller');
/**
 * Users Controller
 *
 * @property User $User
 */
class UsersController extends AppController {

/**
 * index method
 *
 * @return void
 */
	public function index() {
		$this->User->recursive = 0;
		$this->set('users', $this->paginate());
	}

/**
 * view method
 *
 * @throws NotFoundException
 * @param string $id
 * @return void
 */
	public function view($id = null) {
		if (!$this->User->exists($id)) {
			throw new NotFoundException(__('Invalid user'));
		}
		$options = array('conditions' => array('User.' . $this->User->primaryKey => $id));
		$this->set('user', $this->User->find('first', $options));
	}

/**
 * add method
 *
 * @return void
 */
	public function add() {
		if ($this->request->is('post')) {
			$this->User->create();
			if ($this->User->save($this->request->data)) {
				$this->Session->setFlash(__('The user has been saved'));
				$this->redirect(array('action' => 'index'));
			} else {
				$this->Session->setFlash(__('The user could not be saved. Please, try again.'));
			}
		}
	}

/**
 * edit method
 *
 * @throws NotFoundException
 * @param string $id
 * @return void
 */
	public function edit($id = null) {
		if (!$this->User->exists($id)) {
			throw new NotFoundException(__('Invalid user'));
		}
		if ($this->request->is('post') || $this->request->is('put')) {
			if ($this->User->save($this->request->data)) {
				$this->Session->setFlash(__('The user has been saved'));
				$this->redirect(array('action' => 'index'));
			} else {
				$this->Session->setFlash(__('The user could not be saved. Please, try again.'));
			}
		} else {
			$options = array('conditions' => array('User.' . $this->User->primaryKey => $id));
			$this->request->data = $this->User->find('first', $options);
		}
	}

/**
 * delete method
 *
 * @throws NotFoundException
 * @param string $id
 * @return void
 */
	public function delete($id = null) {
		$this->User->id = $id;
		if (!$this->User->exists()) {
			throw new NotFoundException(__('Invalid user'));
		}
		$this->request->onlyAllow('post', 'delete');
		if ($this->User->delete()) {
			$this->Session->setFlash(__('User deleted'));
			$this->redirect(array('action' => 'index'));
		}
		$this->Session->setFlash(__('User was not deleted'));
		$this->redirect(array('action' => 'index'));
	}
}

以下は、View

□View/Posts/index.ctp

<div class="posts index">
	<h2><?php echo __('Posts'); ?></h2>
	<table cellpadding="0" cellspacing="0">
	<tr>
			<th><?php echo $this->Paginator->sort('id'); ?></th>
			<th><?php echo $this->Paginator->sort('title'); ?></th>
			<th><?php echo $this->Paginator->sort('body'); ?></th>
			<th><?php echo $this->Paginator->sort('created'); ?></th>
			<th><?php echo $this->Paginator->sort('modified'); ?></th>
			<th class="actions"><?php echo __('Actions'); ?></th>
	</tr>
	<?php foreach ($posts as $post): ?>
	<tr>
		<td><?php echo h($post&#91;'Post'&#93;&#91;'id'&#93;); ?>&nbsp;</td>
		<td><?php echo h($post&#91;'Post'&#93;&#91;'title'&#93;); ?>&nbsp;</td>
		<td><?php echo h($post&#91;'Post'&#93;&#91;'body'&#93;); ?>&nbsp;</td>
		<td><?php echo h($post&#91;'Post'&#93;&#91;'created'&#93;); ?>&nbsp;</td>
		<td><?php echo h($post&#91;'Post'&#93;&#91;'modified'&#93;); ?>&nbsp;</td>
		<td class="actions">
			<?php echo $this->Html->link(__('View'), array('action' => 'view', $post['Post']['id'])); ?>
			<?php echo $this->Html->link(__('Edit'), array('action' => 'edit', $post['Post']['id'])); ?>
			<?php echo $this->Form->postLink(__('Delete'), array('action' => 'delete', $post['Post']['id']), null, __('Are you sure you want to delete # %s?', $post['Post']['id'])); ?>
		</td>
	</tr>
<?php endforeach; ?>
	</table>
	<p>
	<?php
	echo $this->Paginator->counter(array(
	'format' => __('Page {:page} of {:pages}, showing {:current} records out of {:count} total, starting on record {:start}, ending on {:end}')
	));
	?>	</p>
	<div class="paging">
	<?php
		echo $this->Paginator->prev('< ' . __('previous'), array(), null, array('class' => 'prev disabled'));
		echo $this->Paginator->numbers(array('separator' => ''));
		echo $this->Paginator->next(__('next') . ' >', array(), null, array('class' => 'next disabled'));
	?>
	</div>
</div>
<div class="actions">
	<h3><?php echo __('Actions'); ?></h3>
	<ul>
		<li><?php echo $this->Html->link(__('New Post'), array('action' => 'add')); ?></li>
		<li><?php echo $this->Html->link(__('List Users'), array('controller' => 'users', 'action' => 'index')); ?> </li>
		<li><?php echo $this->Html->link(__('New User'), array('controller' => 'users', 'action' => 'add')); ?> </li>
	</ul>
</div>

□View/Posts/view.ctp

<div class="posts view">
<h2><?php  echo __('Post'); ?></h2>
	<dl>
		<dt><?php echo __('Id'); ?></dt>
		<dd>
			<?php echo h($post&#91;'Post'&#93;&#91;'id'&#93;); ?>
			&nbsp;
		</dd>
		<dt><?php echo __('Title'); ?></dt>
		<dd>
			<?php echo h($post&#91;'Post'&#93;&#91;'title'&#93;); ?>
			&nbsp;
		</dd>
		<dt><?php echo __('Body'); ?></dt>
		<dd>
			<?php echo h($post&#91;'Post'&#93;&#91;'body'&#93;); ?>
			&nbsp;
		</dd>
		<dt><?php echo __('Created'); ?></dt>
		<dd>
			<?php echo h($post&#91;'Post'&#93;&#91;'created'&#93;); ?>
			&nbsp;
		</dd>
		<dt><?php echo __('Modified'); ?></dt>
		<dd>
			<?php echo h($post&#91;'Post'&#93;&#91;'modified'&#93;); ?>
			&nbsp;
		</dd>
	</dl>
</div>
<div class="actions">
	<h3><?php echo __('Actions'); ?></h3>
	<ul>
		<li><?php echo $this->Html->link(__('Edit Post'), array('action' => 'edit', $post['Post']['id'])); ?> </li>
		<li><?php echo $this->Form->postLink(__('Delete Post'), array('action' => 'delete', $post['Post']['id']), null, __('Are you sure you want to delete # %s?', $post['Post']['id'])); ?> </li>
		<li><?php echo $this->Html->link(__('List Posts'), array('action' => 'index')); ?> </li>
		<li><?php echo $this->Html->link(__('New Post'), array('action' => 'add')); ?> </li>
		<li><?php echo $this->Html->link(__('List Users'), array('controller' => 'users', 'action' => 'index')); ?> </li>
		<li><?php echo $this->Html->link(__('New User'), array('controller' => 'users', 'action' => 'add')); ?> </li>
	</ul>
</div>

□View/Posts/add.ctp

<div class="posts form">
<?php echo $this->Form->create('Post'); ?>
	<fieldset>
		<legend><?php echo __('Add Post'); ?></legend>
	<?php
		echo $this->Form->input('title');
		echo $this->Form->input('body');
	?>
	</fieldset>
<?php echo $this->Form->end(__('Submit')); ?>
</div>
<div class="actions">
	<h3><?php echo __('Actions'); ?></h3>
	<ul>

		<li><?php echo $this->Html->link(__('List Posts'), array('action' => 'index')); ?></li>
	</ul>
</div>

□View/Posts/edit.ctp

<div class="posts form">
<?php echo $this->Form->create('Post'); ?>
	<fieldset>
		<legend><?php echo __('Edit Post'); ?></legend>
	<?php
		echo $this->Form->input('id');
		echo $this->Form->input('title');
		echo $this->Form->input('body');
	?>
	</fieldset>
<?php echo $this->Form->end(__('Submit')); ?>
</div>
<div class="actions">
	<h3><?php echo __('Actions'); ?></h3>
	<ul>

		<li><?php echo $this->Form->postLink(__('Delete'), array('action' => 'delete', $this->Form->value('Post.id')), null, __('Are you sure you want to delete # %s?', $this->Form->value('Post.id'))); ?></li>
		<li><?php echo $this->Html->link(__('List Posts'), array('action' => 'index')); ?></li>
	</ul>
</div>

□View/Users/index.ctp

<div class="users index">
	<h2><?php echo __('Users'); ?></h2>
	<table cellpadding="0" cellspacing="0">
	<tr>
			<th><?php echo $this->Paginator->sort('id'); ?></th>
			<th><?php echo $this->Paginator->sort('username'); ?></th>
			<th><?php echo $this->Paginator->sort('password'); ?></th>
			<th><?php echo $this->Paginator->sort('role'); ?></th>
			<th><?php echo $this->Paginator->sort('created'); ?></th>
			<th><?php echo $this->Paginator->sort('modified'); ?></th>
			<th class="actions"><?php echo __('Actions'); ?></th>
	</tr>
	<?php foreach ($users as $user): ?>
	<tr>
		<td><?php echo h($user&#91;'User'&#93;&#91;'id'&#93;); ?>&nbsp;</td>
		<td><?php echo h($user&#91;'User'&#93;&#91;'username'&#93;); ?>&nbsp;</td>
		<td><?php echo h($user&#91;'User'&#93;&#91;'password'&#93;); ?>&nbsp;</td>
		<td><?php echo h($user&#91;'User'&#93;&#91;'role'&#93;); ?>&nbsp;</td>
		<td><?php echo h($user&#91;'User'&#93;&#91;'created'&#93;); ?>&nbsp;</td>
		<td><?php echo h($user&#91;'User'&#93;&#91;'modified'&#93;); ?>&nbsp;</td>
		<td class="actions">
			<?php echo $this->Html->link(__('View'), array('action' => 'view', $user['User']['id'])); ?>
			<?php echo $this->Html->link(__('Edit'), array('action' => 'edit', $user['User']['id'])); ?>
			<?php echo $this->Form->postLink(__('Delete'), array('action' => 'delete', $user['User']['id']), null, __('Are you sure you want to delete # %s?', $user['User']['id'])); ?>
		</td>
	</tr>
<?php endforeach; ?>
	</table>
	<p>
	<?php
	echo $this->Paginator->counter(array(
	'format' => __('Page {:page} of {:pages}, showing {:current} records out of {:count} total, starting on record {:start}, ending on {:end}')
	));
	?>	</p>
	<div class="paging">
	<?php
		echo $this->Paginator->prev('< ' . __('previous'), array(), null, array('class' => 'prev disabled'));
		echo $this->Paginator->numbers(array('separator' => ''));
		echo $this->Paginator->next(__('next') . ' >', array(), null, array('class' => 'next disabled'));
	?>
	</div>
</div>
<div class="actions">
	<h3><?php echo __('Actions'); ?></h3>
	<ul>
		<li><?php echo $this->Html->link(__('New User'), array('action' => 'add')); ?></li>
		<li><?php echo $this->Html->link(__('List Posts'), array('controller' => 'posts', 'action' => 'index')); ?> </li>
		<li><?php echo $this->Html->link(__('New Post'), array('controller' => 'posts', 'action' => 'add')); ?> </li>
	</ul>
</div>

※何回かテストしているので ID が 1 から始まってない。

※パスワードは、そのまま書き込まれている。これは後でハッシュ値にする。

□View/Users/view.ctp

<div class="posts view">
<h2><?php  echo __('Post'); ?></h2>
	<dl>
		<dt><?php echo __('Id'); ?></dt>
		<dd>
			<?php echo h($post&#91;'Post'&#93;&#91;'id'&#93;); ?>
			&nbsp;
		</dd>
		<dt><?php echo __('Title'); ?></dt>
		<dd>
			<?php echo h($post&#91;'Post'&#93;&#91;'title'&#93;); ?>
			&nbsp;
		</dd>
		<dt><?php echo __('Body'); ?></dt>
		<dd>
			<?php echo h($post&#91;'Post'&#93;&#91;'body'&#93;); ?>
			&nbsp;
		</dd>
		<dt><?php echo __('Created'); ?></dt>
		<dd>
			<?php echo h($post&#91;'Post'&#93;&#91;'created'&#93;); ?>
			&nbsp;
		</dd>
		<dt><?php echo __('Modified'); ?></dt>
		<dd>
			<?php echo h($post&#91;'Post'&#93;&#91;'modified'&#93;); ?>
			&nbsp;
		</dd>
	</dl>
</div>
<div class="actions">
	<h3><?php echo __('Actions'); ?></h3>
	<ul>
		<li><?php echo $this->Html->link(__('Edit Post'), array('action' => 'edit', $post['Post']['id'])); ?> </li>
		<li><?php echo $this->Form->postLink(__('Delete Post'), array('action' => 'delete', $post['Post']['id']), null, __('Are you sure you want to delete # %s?', $post['Post']['id'])); ?> </li>
		<li><?php echo $this->Html->link(__('List Posts'), array('action' => 'index')); ?> </li>
		<li><?php echo $this->Html->link(__('New Post'), array('action' => 'add')); ?> </li>
	</ul>
</div>

□View/Users/add.ctp

<div class="posts form">
<?php echo $this->Form->create('Post'); ?>
	<fieldset>
		<legend><?php echo __('Add Post'); ?></legend>
	<?php
		echo $this->Form->input('title');
		echo $this->Form->input('body');
	?>
	</fieldset>
<?php echo $this->Form->end(__('Submit')); ?>
</div>
<div class="actions">
	<h3><?php echo __('Actions'); ?></h3>
	<ul>

		<li><?php echo $this->Html->link(__('List Posts'), array('action' => 'index')); ?></li>
	</ul>
</div>

□View/Users/edit.ctp

<div class="posts form">
<?php echo $this->Form->create('Post'); ?>
	<fieldset>
		<legend><?php echo __('Edit Post'); ?></legend>
	<?php
		echo $this->Form->input('id');
		echo $this->Form->input('title');
		echo $this->Form->input('body');
	?>
	</fieldset>
<?php echo $this->Form->end(__('Submit')); ?>
</div>
<div class="actions">
	<h3><?php echo __('Actions'); ?></h3>
	<ul>

		<li><?php echo $this->Form->postLink(__('Delete'), array('action' => 'delete', $this->Form->value('Post.id')), null, __('Are you sure you want to delete # %s?', $this->Form->value('Post.id'))); ?></li>
		<li><?php echo $this->Html->link(__('List Posts'), array('action' => 'index')); ?></li>
	</ul>
</div>

この状態から、

認証(ログインとログアウト)
http://book.cakephp.org/2.0/ja/tutorials-and-examples/blog-auth-example/auth.html#id3

を追加していく。

カテゴリー: CakePHP | [CakePHP] シンプルな認証を実装する(準備) はコメントを受け付けていません

[CakePHP] セッションを利用する

もともと PHP には $_SESSION があるので、それを利用すればよいのだが、CakePHP は $this->Session というう形で用意されている。

セッション ? CakePHP Cookbook v2.x documentation
http://book.cakephp.org/2.0/ja/core-libraries/components/sessions.html

残念ながら、$_SESSION と $this->Session と互換性はない模様。他のモジュールとのやり取りをするならば、$_SESSION を使うと良い。

■Model

Model はそのまま

■Controller

sess メソッドで id を保存しておいて、index で検索結果を出すという具合。

in Controller/TestController.php

	public function index($id=null) {
		if ($id==null) {
			// セッション内のIDを使う
			$id = $this->Session->read("Test.id");
			// session_start();
			// $id = $_SESSION['Test.id'];
		}
		if (isset($this->params['url']['id']))
			$id = $this->params['url']['id'];

		if ( $id != null ) {
			$this->set('Test',$this->Test->findAllById($id));
		} else {
			$this->set('Test',$this->Test->find('all'));
		}
	}

 

	// セッションを保存
	public function sess($id=null) {
		$this->Session->write("Test.id",$id);
		// session_start();
		// $_SESSION['Test.id'] = $id ;
		$this->redirect('.');
	}

/Test/sess/7 で URL を呼び出すと、/Test/index/7 と同じような呼び出しになる(内部で redirect している)。このときに、sess から index に渡すために $this->Session を使っている。このパターンだと、直接メソッド呼び出しをしたほうが安全か…まあ、URL が /Test/ になるので、それはそれで ok(アドレスが隠蔽化されるという意味で)。

$_SESSION[‘Test.id’] でも同じことができる。残念ながら、$_SESSION[‘Test.id’] と $this->Session->read(“Test.id”); は異なる値を示している。これは名前を「id」とかにしてもダメだった。

■View

View は同じ

■結果

/Test/sess/7 で呼び出すと、$this->Session に保存されて index で参照される。

カテゴリー: CakePHP | [CakePHP] セッションを利用する はコメントを受け付けていません

[CakePHP] トランザクションを利用する

トランザクションを利用する…が、WEB系の場合は、ワンコールのトランザクションしか使えないので、複数のコール/Web APIにまたがる場合は、2フェーズコミットの方法を取る。まあ、チケット予約とかのように普通はダーティコミットの方式がパフォーマンスがよい。最後にチェックを入れて、整合性がなければ/既に予約済みだとかの場合は、エラーにしてしまう方式。社内業務の場合は、それほどパフォーマンスを必要としない or 途中の入力を破棄されるほうが痛い場合は、一時入力を保持する方式でセッションを作る。

ここはワンコールのトランザクションで。

■Model

Model/AppModel.php を書き換え

class AppModel extends Model {
	var $db ;
	function begin()
	{
	    $db = ConnectionManager::getDataSource($this->useDbConfig);
	    $db->begin($this);
	}
	   
	function commit()
	{
	    $db = ConnectionManager::getDataSource($this->useDbConfig);
	    $db->commit($this);
	}
	   
	function rollback()
	{
	    $db = ConnectionManager::getDataSource($this->useDbConfig);
	    $db->rollback($this);
	}
}

コネクションが Model に付属するので、$this->useDbConfig も Model 単位になってしまうという罠があるので、多人数で使う場合には考慮が必要。ただ、大抵の場合はワンコネクションで済ませてしまうので、わざわざマルチコネクションを利用してない場合には特に問題にならない。

CakePHPで複数テーブルに対するトランザクションを使う場合 – takami_hirokiの日記
http://d.hatena.ne.jp/takami_hiroki/20101109/p1

のように ADO.NET 風に Transaciton クラスを別に用意したほうがよいかも。

■Controller

ためしに、delete で commit/rollback してみる。

in Controller/TestController.php

	public function delete($id=null) {
		if (isset($this->params['url']['id'])) $id = $this->params['url']['id'];
		if ( $id != null ) {

			// トランザクション開始
		    $this->Test->begin();
    		// 処理を書く
			// $this->Test->read(null, $id);
			$this->Test->delete( $id );
			
			// コミット or ロールバック
    		$this->Test->rollback();
    		// $this->Test->commit();
   		}
		$this->set('Test',$this->Test->find('all'));
	}

コネクションが $this->Test に属しているのだが、$this->Store でも同じ。ConnectionManager::getDataSource($this->useDbConfig); なので。

■View

View は同じ

■結果

削除はロールバックされて、更新されない。

※クエリを見ると、「BEGIN」しかないけど大丈夫なのか?動作的には問題ない。

カテゴリー: CakePHP | 2件のコメント

[CakePHP] IDを指定して行を更新する

UPDATE を使って指定行を更新する。

■Model

Model はそのまま

■Controller

/Test/update?id=10 とか /Test/update/10 で更新できるようにしておく。

in Controller/TestController.php

	public function update($id=null) {
		if (isset($this->params['url']['id'])) $id = $this->params['url']['id'];
		if ( $id != null ) {
			$this->Test->read(null, $id);
			$this->Test->set('Age',30 );
			$this->Test->set('UpdateDate',date('c'));
			$this->Test->save();
		}
		$this->set('Test',$this->Test->find('all'));
	}

read した後に set して save する。これは、PK(ID) が入っているので read がないパターンも作れるハズ。

複数の set の場合は、array を使っても ok。

	public function update($id=null) {
		if (isset($this->params['url']['id'])) $id = $this->params['url']['id'];
		if ( $id != null ) {
			$this->Test->read(null, $id);
			$this->Test->set(
				array('Age'=>30,
					'UpdateDate',date('c')));
			$this->Test->save();
		}
		$this->set('Test',$this->Test->find('all'));
	}

■View

View は同じ

■結果

更新した結果が表示される。

※UPDATE のために COUNT が3回呼び出されているのがなんとも。たくさんのUPDATEをする場合には、パフォーマンスに影響を与えるので、これは調節が必要。

カテゴリー: CakePHP | [CakePHP] IDを指定して行を更新する はコメントを受け付けていません

[CakePHP] IDを指定して行を削除する

DELETE を使って指定行を削除する。

■Model

Model はそのまま

■Controller

/Test/delete?id=10 とか /Test/delete/10 で削除できるようにしておく。

in Controller/TestController.php

	public function delete($id=null) {
		if (isset($this->params['url']['id'])) $id = $this->params['url']['id'];
		if ( $id != null ) {
			// $this->Test->read(null, $id);
			$this->Test->delete( $id );
   		}
		$this->set('Test',$this->Test->find('all'));
	}

delete で削除する。read は必要ないみたい…あとでチェックする。

■View

View は同じ

■結果

削除した結果が表示される。

※DELETEする前に COUNT しているのが謎だが…後で調べる。マッチする行がない場合には、DELETE が呼び出されないみたい。

カテゴリー: CakePHP | [CakePHP] IDを指定して行を削除する はコメントを受け付けていません

[CakePHP] 新しい行を挿入する

INSERT を使って新しい行を追加する。
実際には、新しいIDを作成する、新しい行を追加する、2手順になる。なので、正確に作るならば新しいIDを作りながら insert をした後に update をしないといけない(競合が発生するため)のだが、まあ、ひとまず作ってみるということで。

■テーブル構造

CREATE TABLE `test` (
  `ID` int NOT NULL,
  `Name` varchar(100) NOT NULL,
  `Age` int DEFAULT NULL,
  `UpdateDate` datetime NOT NULL
);

ID は auto_incriment を使ってもいいのだが、ここはそのまま int で。
データ同期が発生する…ってのを考慮して、UpdateDate の列を作っておく。

■Model

新しい ID を作るための GetNewId メソッドだけ作っておく。

class Test extends AppModel
{
	var $useTable = 'Test';
	function GetNewId() {
		$sql = 	"SELECT max(id)+1 as ID FROM Test";
		$ret = $this-&gt;query($sql);
		return $ret[0][0]['ID'];
	}
}

そういえば、行数で苦労している人もいるみたいなのだが、$this->query をした後に RowCount すると遅くなる(無駄な行を検索する)ので、SQL の COUNT 関数を使う。

	function GetCount() {
		$sql = 	"SELECT count(id) as CNT FROM Test";
		$ret = $this->query($sql);
		return $ret[0][0]['CNT'];
	}

な感じにすれば OK。適宜、WHERE 句を付け加えることになるが…これはまた別途考える。

■Controller

確認用に index メソッドで検索できるようにしておく。
insert メソッドが挿入部分。

in Controller/TestController.php

class TestController extends AppController {
	public function index() {
		$id = null;
		if (isset($this->params['url']['id'])) $id = $this->params['url']['id'];

		if ( $id != null ) {
			$this->set('Test',$this->Test->findAllById($id));
		} else {
			$this->set('Test',$this->Test->find('all'));
		}
	}
	public function insert() {
		$id = $this->Test->GetNewId();
		$this->set('ID',  $id );
		$data = array( 
			'ID' => $id,
			'Name' => 'tomoaki',
			'Age'  => 20,
			'UpdateDate' => date('c'));
			
		// $this->Test->create();
		$this->Test->save( $data );
		$this->set('Test',$this->Test->find('all'));
		// $this->redirect('.');
	}
}

ID を $this->set しているのは確認のため。
新しい行を、$data = array で作成して、save の順で呼び出し。ID を自分で作成しているので create は呼び出す必要はないかも…後で調べる。

$data の中身は、本来はクライアントから Web API で送るパターン。簡単な文字列ならば URL でよいのだが、ここは POST に統一しておくのが便利だと思う。
日付はサーバー日時で統一するために、PHP 側で生成。date(‘c’) すれば ok。

挿入後に index へリダイレクトしてもよいのだが、ここでは確認のために insert をそのまま表示。

■View

<h2>Test list</h2>
<?php 
	echo "new id: $ID <br />";
?>

<table>
	<tr>
		<td>ID</td>
		<td>Name</td>
		<td>Age</td>
		<td>UpdateDate</td>
	</tr>

<?php foreach($Test as $item) : ?>
	<tr>
		<td><?php echo $item['Test']['ID'] ?></td>
		<td><?php echo $item['Test']['Name'] ?></td>
		<td><?php echo $item['Test']['Age'] ?></td>
		<td><?php echo $item['Test']['UpdateDate'] ?></td>
	</tr>
<?php endforeach ; ?>

■結果

挿入した行が表示される。

※この結果は GMT が間違っているので、後で直す。

カテゴリー: CakePHP | [CakePHP] 新しい行を挿入する はコメントを受け付けていません

[CakePHP] 検索IDをURLに埋め込んで検索させる

findAllById を使って、検索して取得するパターンだが、/Store?id=10 ではなくて、/Store/10 のように検索できるようにする。

■Model

find 系を使うので変更なし

■Controller

/Store/10 でアクセスできるようにコントローラを作成…したいのだが、できないので、/Store/index/10 でアクセスする

in Controller/StoreController.php

class StoreController extends AppController {
	public function index($id=null) {
		$group = null;
		if (isset($this->params['url']['id'])) $id = $this->params['url']['id'];
		if (isset($this->params['url']['group'])) $group = $this->params['url']['group'];

		if ( $id != null ) {
			$this->set('Store',$this->Store->findAllById($id));
		} else if ( $group != null ) {
			$this->set('Store',$this->Store->findAllByAreagroupid($group));
		} else {
			$this->set('Store', $this->Store->find('all',array('limit'=>'100')));
		}
	}
}

index メソッドの引き数に $id を追加するだけ。
指定されない場合にも対応できるように、デフォルトの値を null にしておく。

/Store/10 でアクセスしようとすると、「10 という名前のメソッドがない」というエラーが出るので、/Store/index/10 でアクセスをする。この場合、/Store/select/10 のようにメソッド名を変えるほうがベターかと。
今回は、Web API なので、/Store?id=10 形式でアクセスするようにしよう。

■View

戻り値は配列になるので、foreach のところはそのままで。

■結果

指定したIDが表示される。

カテゴリー: CakePHP | [CakePHP] 検索IDをURLに埋め込んで検索させる はコメントを受け付けていません