FuelPHP
認証 その2 SimpleAuthの認証画面を試す
oil g admin
コマンドを使うとスキャフォールドと認証画面を一気に生成することができます。
ここでは、認証用ユーザ管理テーブルのスキャフォールドと認証画面をまとめて作ってみます。
まず、ユーザ管理テーブルのスキャフォールドを生成します。
FuelPHP 1.5ではfuel/packages/auth/exampleにSimpleAuth用のマイグレーションファイルがありますが、ここではoil g admin
を使うことが目的なので、oilコマンドでマイグレーションを生成します。
$ oil g admin user username:varchar[50] password:varchar[255] group:int:default[1] email:varchar[255] last_login:varchar[25] login_hash:varchar[255] profile_fields:text
マイグレーションをデータベースに反映させます。
$ oil r migrate
テーブルが出来たら、ユーザーを新規追加します。
oilコマンドでテストコンソールを開き、Authパッケージのcreate_userメソッドを実行します。
$ oil c
Fuel 1.4 - PHP 5.3.10-1ubuntu3.5 (cli) (Jan 18 2013 23:39:11) [Linux]
>>> Auth::create_user('admin', 'pass', 'admin@example.com', 100)
1
>>>
create_userメソッドの引数は、ユーザ名、パスワード、メールアドレスのほか、グループIDが必須です。
ここで指定している値100は、simpleauth.phpで設定している管理者グループのIDです。
成功すると追加されたレコードのidが表示されます。成功したらCtrl+Cでコンソールを終了します。
これだけで完了です。
public/adminをブラウザで開いてみましょう。
認証画面が表示されます。
さきほど新規追加したユーザでログインします。
ダッシュボードが表示されます。
上部のリンクUserをクリックするとスキャフォールドで作成されたUsersテーブル管理画面が表示されます。
以上でSimpleAuthの認証画面を確認できました。
ただし、この例ではAuth::create_user
の処理を入れていないので、このスキャフォールドを使った新規ユーザ追加や変更はできません。
追補
いろいろやっているうちに、ログインすると310リダイレクトループエラーになるようになってしまったときは、マイグレーションをやり直すと解消します。
認証 その1 SimpleAuthのシンプルな設定
Authパッケージを使うと、ユーザ認証(Authentication)と認可(Authorization)のインターフェースを利用できます。
ここでは実装サンプルとして添付されているSimpleAuthを試してみます。
まずはfuel/app/config/config.phpにauthパッケージを読み込む記述を追加します。
1 2 3 4 5 6 7 8 9 10 11 12 |
return array( 'language' => 'ja', 'log_threshold' => Fuel::L_ALL, 'always_load' => array( 'packages' => array( # Authパッケージを読み込みます 'auth', # ユーザ管理にORMを使います 'orm', ) ) ); |
次にfuel/packages/auth/config/auth.phpとfuel/packages/auth/config/simpleauth.phpをfuel/app/configディレクトリにコピーします。
auth.phpではAuthドライバの設定を行います。これはこのままで構いません。
simpleauth.phpではSimpleAuthの設定を行います。ユーザにアクセス権限を与えるためにグループIDの設定が必要ですが、コメントアウトされているので、これを外します。
1 2 3 4 5 6 7 |
'groups' => array( -1 => array('name' => 'Banned', 'roles' => array('banned')), 0 => array('name' => 'Guests', 'roles' => array()), 1 => array('name' => 'Users', 'roles' => array('user')), 50 => array('name' => 'Moderators', 'roles' => array('user', 'moderator')), 100 => array('name' => 'Administrators', 'roles' => array('user', 'moderator', 'admin')), ), |
以上でとりあえずSimpleAuthを動かす設定ができました。
チュートリアル Smartyの使い方
おはようございます。あぁん?ゆうきんじゃねーの?
この記事を読む前に ツグツグ が書いた を舐める様に参照して下さい。(^ω^)ペロペロ
では、Smarty の使い方について説明していきたいと思います。
ちなみに Smarty は拡張子を好き※に変更することができますが、今回は .samrty にしているとして話を進めます。
※プロジェクトで使用している他の拡張子と同じにするのは無理です
なお、Smartyの使い方を全部説明するわけではありません。
今回は基本的なことだけです。詳しくは公式のマニュアルを参照して下さい。
Smartyファイルの生成方法
おさらいです。
1 2 3 4 5 |
// 方法その1 $view1 = View_Smarty::forge('view1'); // 方法その2 $view2 = View::forge('view2.smarty'); |
この2つで生成することが可能です。
Smarty内で変数、PHPコードの呼び出し方
おさらいです。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
<!DOCTYPE html> <html lang="ja"> <head> <meta charset="utf-8"> <title>Smarty</title> </head> <body> <!-- 変数の呼び出し --> <p>ユーザ名:{$username}</p> <!-- PHPコードの呼び出し --> {Html::Anchor('top/index','トップページ')} </body> </html> |
Smarty でPHPコードの結果を画面上に表示する場合でも、 echo を記述しる必要はありません。
Smartyでの連想配列の扱い方
1 2 |
// Smarty での配列の扱い {Form::input('userid', Input::post('userid'), ['required'=>'required'])} |
これが連想配列の使い方です。
通常のPHPコードと違い array() ではなく、 [] で囲むだけですので注意して下さい。
Smartyで覚えておくと便利な事
※この項目に関しては、随時増やしていきます
コメント
1 |
{* この中に書いたものはコメントです *} |
if文
1 2 3 4 5 6 |
{$age = 24} {if $age < 20} <p>未成年</p> {else} <p>成年</p> {/if} |
現在の時刻
1 2 |
{$date = $smarty.now|date_format:'%Y-%m-%d %H:%M:%S'} <p>現在の日付と時間:{$date}</p> |
文字の連結
1 2 3 |
{$text1 = 'あんかけ'} {$text2 = 'ちゃーはん'} <p>連結した文字 = {$text1|cat:$text2}</p> |
文字数
1 2 3 |
{$text = 'ひゃっはー! ここは通さねぇぜ!'} <p>文字数:{$text|count_characters}</p> <p>空白を含めた文字数:{$text|count_characters:true}</p> |
変数のデフォルト値
1 |
<p>変数に何が入ってる?:{$var|default:'何もねぇ!'}</p> |
大文字化。小文字化
1 2 3 |
{$text = 'Small or Large'} <p>全部大文字:{$text|upper}</p> <p>全部小文字:{$text|lower}</p> |
文字数の規制
1 2 3 |
{$text = 'いやに長い文章考えるのって逆に困るよね特に俺みたいに寡黙な人間にとっては長い文章考えるなんて拷問に等しいよ本当に'} <p>原文:{$text}</p> <p>切捨:{$text|truncate:32:'..'}</p> |
前述しましたが、この記事はちょくちょく更新したいと思います。
では、おやすみなさい。
チュートリアル HTTPエラー処理その2
おはようございます。SAN値0のゆうきんです。
前回に引き続きHTTPエラー処理の説明を行います。
今回は、404と500以外のエラーを返す方法について説明します。
方法は2種類あります。順に説明します。
1,404と500以外のエラーを返す簡単な方法
1 2 3 4 |
public function action_error() { return new Response(null, 405); } |
これで、明示的に405エラーを返すことができます。
今回はnullとしましたが、第1引数にビューオブジェクトを渡すと、それが表示されます。
なお、nullだと真っ白の画面が表示されます。
Response クラスには他の使い方もあるのですが、記事の項目が違うため割愛します。
2,エラーを定義し、それを投げる
1の方法で全て解決できますが、1の方法だとエラーを返したい場所ごとに書かなければならないため、非常に面倒くさいです。
404と500を明示的に返すときと同じように、例外を投げるだけにしたいですよね?
そこでエラーを定義したクラスを作り、それを例外として投げる方法を説します。
今回は405エラーを作成することを前提にして説明します。
まずは、 fuel/app/classes/ に httpexceptions.php というファイルを作成して下さい。
そして、以下のクラスを記述して下さい。
1 2 3 4 5 6 7 |
class HttpMethodNotAllowd extends FuelCoreHttpException { public function response() { return new Response(View::forge('errors/405'), 405); } } |
1の方法とほぼ同じです。
今回は、第1引数でビューオブジェクトを生成して渡していますが、適当なビューファイルを用意して下さい。
この場合は405エラーだと視覚的にわかるビューが最適だと思われます。
定義したいエラーが増えるたびに、この httpexceptions.php にクラスを追加していくことになるので、覚えておいて下さい。
クラス名は定義したいHTTPエラーコードに準じた名前にするとわかりやすくていいです。
記述が終わったら、 fuel/app/bootstrap.php を開き、次のように書き加えて下さい。
1 2 3 4 5 |
Autoloader::add_classes(array( // Add classes you want to override here // Example: 'View' => APPPATH.'classes/view.php', 'HttpMethodNotAllowd' => APPPATH.'classes/httpexceptions.php', )); |
‘HttpMethodNotAllowd’ が定義したエラークラス名、 APPPATH.’classess/httpexceptions.php’ がエラークラスを定義しているファイル名となります。
ここまで終わったら下準備は同じです。
後は、404と500と同じように例外を投げるだけです。
1 2 3 4 |
public function action_405error() { throw new HttpMethodNotAllowd; } |
これで405エラーを明示的に返すことが可能となります。
さらに。この方法を使用すれば、404と同じように405が発生したらこのページにルーティングするという設定を適用することができます。
ただし、またいろいろと手を加える必要があります。
その方法は次の項目をご覧ください。
3,2で発生させた例外にルート設定を行う
この項目は2の項目で定義した405に対してルーティングを行うことを前提とします。
2で発生させた例外は public/index.php で受け取ることが可能です。
なので、以下の通りに書き加えて下さい。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
// Generate the request, execute it and send the output. try { $response = Request::forge()->execute()->response(); } catch (HttpNotFoundException $e) { $route = array_key_exists('_404_', Router::$routes) ? Router::$routes['_404_']->translation : Config::get('routes._404_'); if($route instanceof Closure) { $response = $route(); if( ! $response instanceof Response) { $response = Response::forge($response); } } elseif ($route) { $response = Request::forge($route, false)->execute()->response(); } else { throw $e; } } catch (HttpMethodNotAllowd $e) { $route = array_key_exists('_405_', Router::$routes) ? Router::$routes['_405_']->translation : Config::get('routes._405_'); if($route instanceof Closure) { $response = $route(); if( ! $response instanceof Response) { $response = Response::forge($response); } } elseif ($route) { $response = Request::forge($route, false)->execute()->response(); } else { throw $e; } } |
catch文で、さきほど定義した例外 HttpMethodNotAllowd を受け取り、ルート設定があれば、そちらにルーティングし、なければ2で生成したビューがそのまま表示されます。
ルート _405_ を fuel/config/routes.php で定義していれば、そちらにルートされるということです。
catch文の中で _405_ があれば・・・とやっています。
つまり _405_ という名前は自由に変更できます。が、変数の命名はなるべく揃えた方がわかりやすので、このままで良いでしょう。
以上で、HTTPエラー処理の説明を終わります。
以前説明した、モードで処理を切り替える方法などを複合すれば、開発環境では405エラーを発生させるが、製品環境では404エラーとする、ということが可能です。
下準備は手間ですが、一度作成してしまえば繰り返し使えるので非常に便利です。
では、おやすみなさい。
チュートリアル HTTPエラー処理その1
おはようございます。†ゆうきん†です。
今回はエラー処理について説明します。
Webサイトである以上、特に404エラーと500エラーは避けて通れないエラーです。
404と500がなんであるかは別に説明の必要ないですよね。
FuelPHPではこの404と500を明示的に投げる処理が組み込まれています。
うまく、活用して役立てましょう。
404エラーをスローする
1 |
throw new HttpNotFoundException; |
上記で404エラーを投げることが出来ます。
FuelPHPは404エラーがスローされたら、以前説明した routes.php の404ルートを元にページを表示します。
404エラーをスローするのが好ましい状況
例えば、以下のコードを見て下さい。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
<?php /** * サンプルクラス */ class Controller_Sample extends Controller_Hybrid { /** * アクションインデックス */ public function action_index() { // 省略 } /** * post メソッド */ public function post_rasta() { // 省略 } } |
psot_rasta というメソッドがありますが、このままだと、GETで http://localhost/fuelphp/sample/rasta にアクセスできてしまいます。
POSTでのみアクセスを許可したい、許可しなければならない場合は次のようにして下さい。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
/** * サンプルクラス */ class Controller_Sample extends Controller_Hybrid { /** * アクションインデックス */ public function action_index() { // 省略 } /** * post メソッド */ public function post_rasta() { // 省略 } /** * get メソッド */ public function get_rasta() { throw new HttpNotFoundException; } } |
同じく rasta という名前でGETメソッド get_rasta を用意し、そのメソッドで 404エラーをスローするようにします。
こうすれば、GETメソッドでアクセスした場合、404エラーページが表示されるようになります。
また、以下の方法でもGETでのアクセス可を回避できます。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
<?php /** * サンプルクラス */ class Controller_Sample extends Controller_Hybrid { /** * アクションインデックス */ public function action_index() { // 省略 } /** * アクションrastaメソッド */ public function action_rasta() { if( Input::method() != 'POST' ) { throw new HttpNotFoundException; } // 省略 } } |
ちなみに、RestコントローラでPOSTメソッドのみ用意した場合、そのURLにGETでアクセスすると405エラーになります。
しかし、405エラーだとユーザにわかりにくくなるので、404エラーを返したほうが親切です。
なぜ、405エラーだとダメなのかというと、405エラーの場合、特に設定しなければ真っ白い画面が表示されてしまうからです。
ユーザからして見れば、ポルナレフのような状態になってしまいます。
403エラーも同じ理由で404エラーを返したほうがいいです。
さらに403エラーは。404エラーを返したほうがセキュリティが向上します。
今回はPOSTのみ用意してGETでのアクセスを回避するというものですが、逆もまた然りです。
GETのみ用意して、POSTのアクセスを禁止したい場合でも似たようなことを行なって下さい。
500エラーをスローする
1 |
throw new HttpServerErrorException; |
上記で500エラーを投げることが出来ます。
500エラーがスローされた場合、アプリケーションを停止し、専用のページを表示します。
こっちは、スローしなければならない状況が多すぎるためサンプルは割愛します。
パッと思いつくのが、送信されたファイルのデータが大きすぎて処理しきれないとかですかね。
何かしらのデータやファイルを送信したけれど、規格外のものが送られてきて処理しきれないから、ユーザに警告を出すという使い方が多いと思います。
ユーザに知らせるのは404と500だけでいいと思いますが、それだけではデバッグするときは非常に不便です。
ですので、開発環境と製品環境で返すエラーを切り替えるという処理が必須になります。
モードによる処理の切り替えは前回説明しました。
後は404と500以外のエラーを発生させる方法だけですね。
その方法は、長くなるので次で説明します。
では、おやすみなさい。
データベースを使う その5 スキャフォールド生成
スキャフォールドは足場という意味で、これを生成することでORMの機能に加えてテーブル管理のコントローラとビューまでコマンドひとつで出来てしまうという、恐ろしく便利なものです。
さっそく試してみましょう。
ここではnameフィールドとageフィールドを持つuserテーブルを作成することとします。
$ oil g scaffold user name:varchar[32] age:int
fuel/app/classes/model/user/phpから見ていきます。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
<?php use OrmModel; class Model_User extends Model { protected static $_properties = array( 'id', 'name', 'age', '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, ), ); public static function validate($factory) { $val = Validation::forge($factory); $val->add_field('name', 'Name', 'required|max_length[32]'); $val->add_field('age', 'Age', 'required|valid_string[numeric]'); return $val; } } |
ORMパッケージのModelを継承しているのはORMモデル生成の場合と同様ですが、validateメソッドが追加されています。このメソッドはコントローラから呼び出され、データのバリデーション条件を返します。
また、マイグレーションファイルもモデル生成時と同じくfuel/app/migrationsディレクトリに生成されています。
次に、fuel/app/classes/controller/user.phpを見てみましょう。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
<?php class Controller_User extends Controller_Template { public function action_index() { $data['users'] = Model_User::find('all'); $this->template->title = "Users"; $this->template->content = View::forge('user/index', $data); } public function action_view($id = null) { $data['user'] = Model_User::find($id); is_null($id) and Response::redirect('User'); $this->template->title = "User"; $this->template->content = View::forge('user/view', $data); } public function action_create() { if (Input::method() == 'POST') { $val = Model_User::validate('create'); if ($val->run()) { $user = Model_User::forge(array( 'name' => Input::post('name'), 'age' => Input::post('age'), )); if ($user and $user->save()) { Session::set_flash('success', 'Added user #'.$user->id.'.'); Response::redirect('user'); } else { Session::set_flash('error', 'Could not save user.'); } } else { Session::set_flash('error', $val->error()); } } $this->template->title = "Users"; $this->template->content = View::forge('user/create'); } public function action_edit($id = null) { is_null($id) and Response::redirect('User'); $user = Model_User::find($id); $val = Model_User::validate('edit'); if ($val->run()) { $user->name = Input::post('name'); $user->age = Input::post('age'); if ($user->save()) { Session::set_flash('success', 'Updated user #' . $id); Response::redirect('user'); } else { Session::set_flash('error', 'Could not update user #' . $id); } } else { if (Input::method() == 'POST') { $user->name = $val->validated('name'); $user->age = $val->validated('age'); Session::set_flash('error', $val->error()); } $this->template->set_global('user', $user, false); } $this->template->title = "Users"; $this->template->content = View::forge('user/edit'); } public function action_delete($id = null) { if ($user = Model_User::find($id)) { $user->delete(); Session::set_flash('success', 'Deleted user #'.$id); } else { Session::set_flash('error', 'Could not delete user #'.$id); } Response::redirect('user'); } } |
メソッド | 処理内容 |
action_index | 一覧表示 |
action_view | 個別データ表示 |
action_create | 新規追加 |
action_edit | 変更 |
action_delete | 削除 |
action_createとaction_editでは、入力されたデータがモデルのvalidateから得た規定に合っているかを確認しています。
fuel/app/views/userディレクトリにはビューのコードが生成されています。
template.php | ページのテンプレート |
_form.php | 入力フォーム |
index.php | 一覧表示 |
view.php | 個別表示 |
create.php | 新規追加 |
edit.php | 変更 |
コードが生成されているのを確認したらデータベースに反映させます。
$ oil r migrate
それではページを表示してみましょう。ブラウザでpublic/usersを開きます。
データ一覧ページが表示されます。
まだデータはありません。
Addボタンをクリックすると新規追加ページが表示されます。
データを入力したらSaveボタンをクリックします。
データ一覧ページに戻ります。
入力したデータが追加されています。
次にViewをクリックしてデータを表示してみます。
選択したデータが表示されます。
Editをクリックしてデータを変更してみます。
変更してSaveボタンをクリックすると、再び一覧ページが表示されます。
変更が反映されているのがわかります。
最後にDeleteをクリックして削除してみます。
一覧が表示され、データは削除されています。
このように、スキャフォールドを使うことで簡単にデータベースアプリケーションの基本機能を構築することができます。
チュートリアル モードを切り替える
前 チュートリアル css と javascript のリンク方法
おはようございます。北斗神拳伝承者ゆうきんです。
今回はモードの切り替え方について説明します。
モードとはつまりデバッグモードだったり、リリースモードだったりです。
では、見て行きましょう。
定義済み環境
- 製品環境 Fuel::PRODUCTION
- 開発環境 Fuel::DEVELOPMENT
- テスト環境 Fuel::TEST
- ステージング環境 Fuel::STAGE
の、4種類が存在します。
それぞれに切り替える方法は次の項目を読んで下さい。
モードを切り替える
FuelPHPでは public/.htaccess で、 production を宣言すると開発環境になります。
宣言の仕方は、
1 |
SetEnv FUEL_ENV production |
という感じです。
特に弄った記憶がなければ、2行目でコメントアウトされているはずなので、外してあげるだけでいいです。
それ以外にも、 development, test, stage を宣言することが出来ます。
それぞれのモードは読んで字の如くなので、特に説明する必要はないかと思われます。
また、何も宣言しなければ自動で development が適用される仕様です。
他にも fuel/app/bootstrap.php を編集することで、モードの切り替えが行えます。
1 2 3 4 5 6 7 8 9 |
/** * Your environment. Can be set to any of the following: * * Fuel::DEVELOPMENT * Fuel::TEST * Fuel::STAGE * Fuel::PRODUCTION */ Fuel::$env = (isset($_SERVER['FUEL_ENV']) ? $_SERVER['FUEL_ENV'] : Fuel::DEVELOPMENT); |
この部分の Fuel::DEVELOPMENT を Fuel::TEST or Fuel::STAGE or Fuel::PRODUCTION のいずれかに適用したいモードによって切り替えて下さい。
※ public/.htaccess を編集する方法でモードを指定している場合は。そちらが優先されます。
モードによって処理を切り替える
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
public function action_modecheck() { if( Fuel::$env == Fuel::PRODUCTION ) { return '製品環境'; } else if( Fuel::$env == Fuel::DEVELOPMENT ) { return '開発環境'; } else if( Fuel::$env == Fuel::TEST ) { return 'テスト環境'; } else if( Fuel::$env == Fuel::STAGE ) { return 'ステージング環境'; } else { return 'いったい何を宣言したんですか!'; } } |
これが全てです。
特に説明することはありません。
では、おやすみなさい。
データベースを使う その2 フィールド型
データベースを使うにはoilコマンドのマイグレーション機能とモデル生成機能を利用します。
oilコマンドで使用できるフィールド型は以下のとおりです。
フィールドの書式はフィールド名:フィールド型
です。
string[n]
varchar[n]
int[n]
enum[value1, value2]
decimal[n n]
float[n n]
text
blob
datetime
date
timestamp
time
データベースを使う その6 マイグレーション
oilコマンドでデータベースをいろいろと変更してみましょう。
これらのコマンドはfuel/migrationsディレクトリにマイグレーションファイルを生成します。
マイグレーションファイルを実際にデータベースに反映させるにはoil r migrate
を実行します。
マイグレーションによる変更はデータベースに対してのみ有効です。oil g model
で生成したコードのテーブルやフィールドには反映されません。
テーブル作成
書式:
oil g migration create_テーブル名 フィールド [フィールド] ...
例:
$ oil generate migration create_users name:text email:string[50] password:string[125]
テーブル名変更
書式:
oil g migration rename_table_テーブル名_to_新しいテーブル名
例:
$ oil generate migration rename_table_users_to_accounts
フィールド追加
書式:
oil g migration add_フィールド名_to_テーブル名 フィールド
例:
$ oil generate migration add_bio_to_accounts bio:text
フィールド名変更
書式:
oil generate migration rename_field_フィールド名_to_新しいフィールド名_in_テーブル名
例:
$ oil generate migration rename_field_name_to_username_in_accounts
テーブル削除
書式:
oil generate migration drop_テーブル名
例:
$ oil generate migration drop_accounts
FuelPHP tips Uploadクラス
FuelPHPでのアップロードについて書きます。
FuelPHPにはUploadクラスというものがあり、簡単にアップロードについて処理を行う事が出来ます。
サンプルでも書いてみます。
まずViewから。up_viewという名前で。
1 2 3 4 5 6 7 8 9 10 11 12 13 |
<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" > <title>sample_upload</title> </head> <body> <form action="upload" method="post" enctype="multipart/form-data"> ファイル:<input type="file" name="upfile" id="upfile"/> <input type="submit" value="アップロード" /> <?php echo $file_size; ?> </form> </body> </html> |
よし。
次にコントローラー。uploadtestというクラスで。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
<?php class Controller_Uploadtest extends Controller { public function action_index() { //省略 /*ここでアップロードページを表示してあげるといいかも*/ return View::forge('up_view',array('file_size'=>0)); } public function action_upload() { //Uploadクラスの設定 $config=array( 'path'=>DOCROOT.'/file', 'auto_rename'=>true, 'ext_whitelist'=>array('jpg','jpeg','gif','png'), 'max_size'=>1024*1024*2, ); //上記の設定で$_FILEの情報を取得 Upload::process($config); //検証がOKなら処理に入る if(Upload::is_valid()){ //上記の設定でアップロードされたファイルを「path」で指定した場所に保存します。 Upload::save(); $data = 0;//例のための変数 //アップロードされたファイルの各種情報を取得します。 foreach (Upload::get_files() as $file){ /*ここにいろいろ処理を書く*/ //例:アップロードされたファイルの合計ファイルサイズを表示する。 $data = $data + $file['size']; } //例の続き return View::forge('up_view',array('file_size'=>$data)); } } } |
「例」って書いてるところは今回のサンプルのための変数とかです。ファイルサイズ表示します。
見ての通り、普通のコントローラーの中でUploadクラスを呼び出してるだけです。
ファイルサイズや拡張子を指定して、ファイル保存して、ファイルがあるかどうかチェックして、ファイルサイズを取得する。っていうのをちょっと生のPHPで検索してみるといいですね。
簡単ですね。
大体はコメントアウトの説明で分かるかと思います。
configで設定しているところ(15行目)
・path:ファイルの保存場所。save()関数で保存します。
・auto_rename:名前が同じファイルがアップロードされた時、末尾に「_1」「_2」を追加するかの設定。
・ext_whitelist:許可する拡張子。
・max_size:最大ファイルサイズ(※最後の方にちょっと注意書きます)
そして、Upload::process()に引数として渡してあげると、デフォルトの設定を上書きして処理してくれます。
このconfigを毎回設定するのは面倒ですね。
なので、core/config/にupload.phpがあるので、それをapp/config/にコピーして、いろいろ中身を書き換えればそれがデフォルト設定となります。
Upload::is_valid() (26行目)
バリデーションなのかバリッドって読むのかスマイルスマイルヴェリィドゥって読むのか分かりませんが。
つまりはconfigで設定した条件に合うかどうかのチェックです。
trueかfalseが返ってきます。
例の条件で言うと、「virus.exe」とかだと拡張子が条件に合わないのでfalseが返ってきます。
(ちなみに、拡張子なし「sample」ってファイルとかでもfalseが返ってきましたね。)
あとは、1MBを越えるファイルでもfalseが返ってきます。
Upload::get_files() の部分(33行目)
このget_files()は、ファイルの情報を取得します。
foreachを使ってるいるのは、引数なしでget_files()を使うと、アップロードされた全てのファイルを配列にして返してくるからです。
(確実に1つ以上アップロードされている場合get_files(0)とか出来ちゃう。)
33行目では、関数から返ってくる値を$fileとして受け取っています。
$fileはアップロードされたファイルの各種情報を収めた連想配列です。
1 2 3 4 5 6 7 8 9 10 11 12 |
name {string} ファイル名(拡張子あり) type {string} FILE_TYPE error {boolean} エラーの有無 size {int} ファイルサイズ field {string} アップロードファイルのフィールド名 file {string} 保存されているパス errors {array} エラーの配列 extension {string} 拡張子 filename {string} ファイル名(拡張子なし) mimetype {string} MIME_TYPE saved_to {string} save()メソッドの保存先パス saved_as {string} save()メソッドの保存ファイル名 |
※型とかなんか間違ってたらごめんなさい。
左から連想ワード・型名・説明
$file[‘size’] とかでファイルサイズを取得できるわけです。
アップロードファイルのデータサイズ
configのmax_sizeでアップロードファイルの最大サイズを指定していますが。が。が!
ここで好きなように設定できるわけではありません。
若干面倒ですが、php.iniの設定もいじらないといけないです。
また別の機会にそれ書きます。→php.iniの設定はこちらです
例のコードはあくまで例なので・・・
ファイルの保存場所なんて、公開フォルダの直下ですよ。URL打ち込めば見れちゃいますよ