最近、僕がハマったFuelPHPの紹介

最近、僕がハマった
FuelPHPの紹介
2012/7/20
Fukuoka.php Vol.2
@mawatarin

自己紹介

• @mawatarin

• ウェブプログラマ

• Perlを4年くらい

• そのあとPHPを4年くらい

• ただ最近は専らマネジメントより

セッションを始める前に

• まず、言い訳から始めさせてください！



• 1週間前に子どもが生まれました！



• 1週間前に子どもが生まれました！

• そのため、スライドを作る時間がほとんどありません
でしたっっっ

• ネタとか仕込む間もなかったので、つまらなかったら
ごめんなさい


• 事前のヒアリングでFuelPHPに関しては名前は聞いた
ことあるけど、使ってことがないという人が多かった
です

• とりあえず、ざっくりFuelPHPの概要を伝えるスライド
を作りました

今日のお話
1. FuelPHPに興味を持ったきっかけ

2. FuelPHPとは

3. FuelPHPのインストールとフォルダ構成

4. FuelPHPの使い方（MVCの基本）

5. セキュリティについて

6. その他ざっくりと（デバッグ、プロファイラ、コア
クラス一覧）


• Web API 制作の案件が入った

• IDに応じたデータを返すだけの簡単なもの




• たまたま空いてるPGがいなかった




• たまたま空いてるPGがいなかった

• 自分で作るか


• なんかフレームワークを使おう


• なんかフレームワークを使おう

• 最近よく聞くようになったフレームワーク「FuelPHP」

• RESTコントローラが簡単っぽい

• 試しに調べてみよう

例えば、このようなテーブルがあったとして

CREATE TABLE user (
id int(11) auto_increment
,name varchar(50)
,email varchar(255)
);

こんな風にコントローラを実装

class Controller_User extends Controller_Rest

public function get_list()

{

$user = Model_User::forge();

$data = $user->ﬁnd(Input::get('id'));

$this->response($data);

}
}
// 実際はもっと作り込みますが……

こんな風にコントローラを実装
※中身は後ほど解説します



{




}
}
// 実際はもっと作り込みますが……

以下のURLにアクセスすると……

http://localhost/user/list.xml?id=123

以下のURLにアクセスすると……
XMLが返ってくる！


<xml>
<id>123</id>
<name>foo</name>
<email>foo@example.jp</email>
</xml>

拡張子をjsonに変更すると……

http://localhost/user/list.json?id=123

拡張子をjsonに変更すると……
JSON形式で返ってくる！

http://localhost/user/list.json?id=123

{
"id":"123",
"name":"foo",
"email":"foo@example.jp"
}

拡張子をphpに変更すると……
PHP arrayで返ってくる！

http://localhost/user/list.php?id=123

array (
'id' => '123',
'name' => 'foo',
'email' => 'foo@example.jp',
)

何これステキ！

1. RESTコントローラの使い方

1. RESTコントローラの使い方

• Controller_Rest クラスを継承します

• 実装するメソッドには、HTTPメソッドのプレフィック
スをつけます

• URLのメソッド名に続けて、出力フォーマットの拡張子
を付けます

1. RESTコントローラの解説
Controller_Rest クラスを継承



{




}
}

メソッドのプレフィックスでHTTPメソッドを指定
GET, POST, PUT, DELETE が指定できます



{




}
}

メソッド名に続けて出力フォーマットの拡張子を付けます
拡張子に応じて自動的にフォーマットしてくれます



{




}
}


以下のフォーマットに対応

拡張子フォーマット
xml XML
json JSON
jsonp JSONP
csv CSVファイル
php PHP array
serialized シリアライズされたデータ

FuelPHPとの出会いはそんな感じ

2. FuelPHPとは
公式サイトより

2. FuelPHPとは
つたない和訳ですが

FuelPHPは他のフレームワークの
良いところを参考にし、コミュ
ニティ駆動で一から開発された
PHP5.3を対象としたシンプルで
柔軟なウェブアプリケーション
フレームワークです。

2. FuelPHPとは

• フューエル・ピー・エイチ・ピーと読みます

2. FuelPHPとは


• 2011年7月にversion 1.0が出た新しいフレームワーク

• その後、2011年12月に1.1、2012年6月に1.2リリース

2. FuelPHPとは


• 2011年7月にversion 1.0が出た新しいフレームワーク

• その後、2011年12月に1.1、2012年6月に1.2リリース

• FuelPHPのコア開発者5名すべてはCodeIgniterの開発に
関わっている（いた）

• 他のフレームワークの良い所取りをしたCodeIgniter
ライクなフレームワーク

2. FuelPHPとは

• 規約より設定

• PHP5.3以上必須

• オートローダー

• oilコマンド
• スキャフォールディング
• DBマイグレーション
• テスト、タスク

• モジュール、パッケージ、HMVC、 ViewModel

• MITライセンス

3. FuelPHPのインストール


$ curl get.fuelphp.com/oil | sh
$ oil create /path/to/install_dir/project_name

2行、それだけで。


インストール完了！ ※要Git

Twitter Bootstrapが取り入れられてるってのもイイ感じ

ざっくり解説


oilコマンドのインストール


FuelPHPのファイル群を生成


中身はともにGitHubからのgit clone（ざっくり解説）


3. FuelPHPのフォルダ構成

アプリケーションファイルを置く場所
＝僕らが書く場所

FuelPHPのコアが置かれた場所
基本的に触ることはないです

パッケージを置く場所

パッケージを置く場所
標準で5つのパッケージが
格納されています
自作のパッケージもここに格納します

スタティックファイルを置く場所

アプリケーションファイルの中を
見ていきましょう


Model


View


Controller


ViewModel
Viewファイルとは違います


ViewModel
Viewファイルとは違います

ビューモデルはビューの生成に必要なロジックを含むク
ラスです。コントローラがユーザ入力を処理し、必要な
アクションを処理すると、ビューモデルにビューに必要
なデータを取得するように処理を引き継ぎます。
http://press.nekoget.com/fuelphp_doc_1.2/general/
viewmodels.html

Conﬁg
必要に応じて設定ファイルをオーバーライドします
例えば、環境に応じてDBを変えたり、プロファイラを有
効する等

Config
効する等
core/config
app/config
app/config/production or app/config/development

の順でオーバーライドされます
productionまたはdevelopmentは、環境に応じて読み込まれ
ます

Config
効する等
core/config
app/config
app/config/production or app/config/development

の順でオーバーライドされます
productionまたはdevelopmentは、環境に応じて読み込まれ
ます
初期状態でフォルダは存在しませんが、stage, test という
環境も定義されています

4. FuelPHPの使い方 - Controller

4. FuelPHPの使い方 - Controller

• APPPATH/classes/controller以下に配置

• ファイル名はコントローラー名で小文字にします

• Controllerクラスを継承します

• クラス名にはController_プレフィックスをつけます

• クラス名の単語の先頭は大文字にします

• クラス名の単語の区切りにアンダースコアを使うと
サブフォルダを意味してしまうので注意が必要です

4. Controllerでのお約束
ファイル名はすべて小文字

APPPATH/classes/controller/welcome.php

class Controller_Welcome extends Controller
{

public function action_index()

{

return Response::forge(View::forge('welcome/index'));

}
}

Controllerクラスを継承します


{


{


}
}

Controller_プレフィックスをつけます


{


{


}
}

クラス名の単語の先頭は大文字にします


{


{


}
}

クラス名の単語の区切りにアンダースコアを使うとサブ
フォルダを意味します

APPPATH/classes/controller/welcome/member.php

class Controller_Welcome_Member extends Controller
{


{


}
}

4. ControllerとURLの関係
第一セグメントがクラス名

http://localhost/welcome/index

{


{


}
}

第二セグメントがメソッド名


{


{


}
}

ブラウザから実行されるメソッド（アクションメソッ
ド）には、action_プレフィックスをつけます


{


{


}
}

第三セグメント以降はパラメータ
受け取りの際はデフォルト値を設定しておいた方が無難

http://localhost/welcome/index/123

{

public function action_index($page = null)

{


}
}

4. Controllerの定義済みメソッドとプロパティ
詳しい解説は省略します

メソッド/プロパティ意味
action_index() メソッド名を省略されたときに実行される

before() アクションメソッドが実行される前に自動実行

after() アクションメソッドが実行された後に自動実行

$request Requestクラスのオブジェクトを保持

$response Responseクラスのオブジェクトを保持

4. Controllerクラスの種類

クラス名意味
Controller ベースコントローラ

Controller_Template ビューでレイアウト機能を使うコントローラ

Controller_Rest RESTfulなコントローラ

RestコントローラにTemplateコントローラが備
Controller_Hybrid わったもの

4. FuelPHPの使い方 - View

• APPPATH/views以下に配置

• ファイル名は小文字にします

• 拡張子.phpをつけます

4.Viewファイル
Viewファイルの中身については、本日は割愛します。
PHPとHTMLで構成されたファイルです。
</head>
<body>

<div id="header">

<div class="row">

<div id="logo"></div>

</div>

</div>

<div class="container">

<div class="row">

<div class="span16">

<h1><?php echo e($title); ?> <small>We can't ﬁnd that!</small></h1>

<hr>

<p>The controller generating this page is found at <code>APPPATH/classes/controller/welcome.php</
code>.</p>

<p>This view is located at <code>APPPATH/views/welcome/404.php</code>.</p>

</div>

</div>

<footer>

<p class="pull-right">Page rendered in {exec_time}s using {mem_usage}mb of memory.</p>

<p>

<a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.<br>

<small>Version: <?php echo e(Fuel::VERSION); ?></small>

4.Viewの読み込み
コントローラからView::forge('path/view')として読み込む
APPPATH/views/までのパスは省略します

{


{

return View::forge('welcome/index');

}
}

4.Viewに値を渡す
連想配列で値を渡す
レンダリング時にextract()されるのでキーが変数名となります

{


{

$data = array();

$data['name'] = 'foo';

return View::forge('welcome/index', $data);

}
}

他にも
set()メソッドを利用して値を渡す

{


{

$view = View::forge('welcome/index');

$view->set('name', 'foo');

return $view;

}
}

他にも
プロパティに値をセットする

{


{

$view = View::forge('welcome/index');

$view->name = 'foo';

return $view;

}
}

4. テンプレートコントローラとView
テンプレートのレイアウトを行いたいときは、
Controller_Templateを継承します

コンテナ

メニューメイン

4. FuelPHPの使い方 - Model

4. FuelPHPの使い方 - Model

• APPPATH/classes/model以下に配置

• ファイル名はモデル名で小文字にします

• Modelクラスを継承します

• クラス名にはModel_プレフィックスをつけます



4. Modelでのお約束

•
Controllerと基本的には同じなので詳細解説は省略します
APPPATH/classes/model以下に配置

• ファイル名はモデル名で小文字にします

• Modelクラスを継承します

• クラス名にはModel_プレフィックスをつけます



4. Modelクラスの種類

クラス名意味
Model ベースモデル

Model_Crud CRUD処理をするモデル

OrmModel ORMパッケージ

4. oilコマンドでModelを作ってみる

名前とパスワードとemailを持つユーザテーブルを作りた
いとした場合

CREATE TABLE user (
id int(11) auto_increment
,name varchar(50)
,password varchar(255)
,email varchar(255)
);

oilコマンドだとこんな感じ

$ oil g model user name:varchar[50] password:string email:string

テーブル名


フィールド名


フィールドの型


マイグレーションを実行し、テーブルを作成します

$ oil reﬁne migrate

Userモデルができた！
テーブルもできた！
class Model_User extends OrmModel
{

protected static $_properties = array(

'id',

'name',

'password',

'email',

'created_at',

'updated_at'

);

protected static $_observers = array(

'OrmObserver_CreatedAt' => array(

'events' => array('before_insert'),

'mysql_timestamp' => false,

),

'OrmObserver_UpdatedAt' => array(

'events' => array('before_save'),

'mysql_timestamp' => false,

),

);
}

例えば、こんな風に書いておけば、Fieldsetクラスで自動
的にフォームを作ってくれたり、バリデートしてくれたり
{


'id',

'name' => array(

'data_type' => 'varchar',

'label' => 'お名前',

'validation' => array('required'),

'form' => array('type' => 'text'),

'default' => '',

),

'password',

'email',

'created_at',

'updated_at'

);

// 略

リレーションの設定はこんな感じ

{


'id',

'name',

'password',

'email',

'created_at',

'updated_at'

);

protected static $_has_many = array(

comments => array(

'model_to' => 'Model_Comment',

'key_from' => 'id',

'key_to' => 'user_id',

'cascade_save' => false,

'cascade_delete' => true,

));

// 略

4. FuelPHPの使い方
説明できてないことの方が多いですが、FuelPHPのざっく
りとした使い方は以上です

代表的なウェブアプリケーションのセキュリティリスク
と対応状況

リスク名対応状況
ビューへ渡す値は自動的にエ
XSS
スケープされる

クエリビルダ、ORMパッケー
SQLインジェクションジを使えば、自動的にエス
ケープされる
Cookieを使ったトークンを作
CSRF るクラスが用意されている。
手動で利用する

出力フィルタ、URIフィルタはSecurity::htmlentities()が使わ
れます

出力フィルタ、URIフィルタはSecurity::htmlentities()が使わ
れます
中身

public static function htmlentities($value, $flags = null, $encoding = null, $double_encode = null)

{

static $already_cleaned = array();

is_null($flags) and $flags = Config::get('security.htmlentities_flags', ENT_QUOTES);

is_null($encoding) and $encoding = Fuel::$encoding;

is_null($double_encode) and $double_encode = Config::get('security.htmlentities_double_encode', false);

// 略

if (is_string($value))

{

$value = htmlentities($value, $flags, $encoding, $double_encode);

}

// 略


• ある程度は、自動的に保護してくれる

• または保護をするクラスが用意されている

• ただ過信は禁物！

• ウェブアプリケーション制作に関わる以上、アンテナを
常に張りセキュリティに関する知識を高めておく必要が
ある

6. 開発補助 - デバッグ
エラーがあった場合は整形して表示してくれます

6. 開発補助 - プロファイラ
conﬁg で 'proﬁling' => true にすることで、プロファイラが
使えます

6. コアクラス一覧
• Agent • Form • Package
• Arr • Format • Pagination
• Asset • Ftp • Profiler
• Autoloader • Fuel • Redis
• Cache • Html • Request
• Cli • Image • Response
• Config • Inflector • Router
• Cookie • Input • Security
• Crypt • Lang • Session
• Database • Log • Str
• Date • Markdown • Theme
• Debug • Migrate • Upload
• Event • Model_Crud • Uri
• Fieldset • Module • Validation
• File • Mongo_Db • View
• Finder • Num

7月1日から20日間FuelPHPを触ってみた感想

• 必要な機能は大凡そろってるかなー

• シンプルで、やりたいことがサクッとできるイメージ

• ただ、フィーチャーフォン（いわゆるガラケー）向け
のウェブアプリを作ったりするのは苦手分野かな？
（ただ単に調べきれてないとも言う）

• その辺は、CakePHPとかの方が一日の長がある感じ

• まあ実質1週間くらいしか触ってないけどね！

こんな人にはFuelPHPを勧めてみます

• 現場から少し離れてたけど、やっぱり自分でもアプリ
ケーションを作りたい人

• WordPress等を通してPHPでのアプリケーション制作に
興味を持ったけど、何から手を付けたら良いかわから
ない人

• CodeIgniterのライセンス騒動に疲弊した人

• このスライドを通して興味を持ったもの皆

参考文献とかウェブページとか
FuelPHP 公式サイト（英語）
http://fuelphp.com/

FuelPHP日本語訳ドキュメント
http://press.nekoget.com/fuelphp_doc/

FuelPHP Google グループ
http://groups.google.com/group/fuelphp_jp

参考文献とかウェブページとか
FuelPHP 入門
2012年6月20日初版第1刷発行

ブログ作成を通して、FuelPHPの使い方等を学びます。
フォーム処理、認証管理、メール送信等。

はじめてのフレームワークとしての FuelPHP
2012年7月2日バージョン0.9.0発行

フレームワークとはなんぞやという所から始まって、FuelPHPを用いた
ウェブアプリケーション作成について学びます。テスト手法について
しっかりと書かれているのが好印象。電子書籍のみの販売。

達人出版会
http://tatsu-zine.com/books/fuelphp1st

勉強会のお知らせ

スイミー
http://swimmy.me/

勉強会のお知らせ

• ウェブプログラマ向けの勉強会をやってます

• PC持ち込んでやる勉強会です

• 月に1∼2回くらいのペースです

• 現在はPHPerも、ちゃんとCIしようってことで、
Jenkinsの勉強をしています

• 一人で悩んでても仕方ない！がコンセプトなので、
皆さんもお気軽に、ご参加ください！

さいごに

このような機会を与えてくださってあ
りがとうございました。
おかげで目標を持って勉強することが
できました。

さいごに

ご清聴ありがとうございました
@mawatarin

最近、僕がハマったFuelPHPの紹介

Recomendados

Recomendados

Mais conteúdo relacionado

Mais procurados

Mais procurados (20)

Destaque

Destaque (20)

Semelhante a 最近、僕がハマったFuelPHPの紹介

Semelhante a 最近、僕がハマったFuelPHPの紹介 (20)

Último

Último (12)

最近、僕がハマったFuelPHPの紹介

Notas do Editor