CodeIgniterでコントローラーでbefore_filterやafter_filterするにはどうすればいいんだろう？と思い、調べてみたところ、CodeIgniterではフックが使えるらしいです。

フックとは、決められたタイミングで行われるコールバックのことです。
今回は認証機能をフックで呼んでみるような感じのサンプルを作ってみます。

1. application/config/config.phpの$config[‘enable_hooks’]をTRUEに設定します。
2. application/config/hooks.phpに、フックで使用するクラスを指定します。ここでは、BeforeFilterクラスを指定してみます。
   SyntaxHighlighterについて

   1 2 3 4 5 6 7 8

   <?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed'); // コントローラーのコンストラクタが終了したタイミングで呼ばれるフック名 $hook['post_controller_constructor'] = array(   'class'     => 'BeforeFilter', // 呼ぶクラス名   'function'  => 'is_login', // 呼ぶメソッド   'filename'  => 'before_filter.php', // ファイル名   'filepath'  => 'hooks' // applicationフォルダからの相対パス );

   フックのタイミングは色々あります。一覧を記述します。

   pre_system

   システム実行の最初に呼ばれる。ベンチマーククラスとフッククラスだけロードされている。ルーティングはまだ。

   pre_controller

   コントローラーが呼ばれる直前に呼ばれる。すべての基本クラスのロード、ルーティング、セキュリティチェックなどが終わっている

   post_controller_constructor

   コントローラーがインスタンスされた直後。Railsのbefore_filterのタイミング。

   post_controller

   コントローラーが完全に実行された直後。Railsのafter_filterのタイミング。

   display_override

   ブラウザに送信するdisplayメソッドをオーバーライドした動きになる。処理済みのデータは$this->output->get_output()で取得可能。

   cache_override

   display_cacheメソッドの代わりに独自のメソッドを呼び出すことが可能なタイミング。独自キャッシュメカニズムとかに使える。

   post_system

   ブラウザに送信し終わったときのタイミング。ベンチマークをとるようなところ。

   今回はbefore_filterのようなフックを作りたかったので、post_controller_constructorを指定しています。また、同じタイミングで複数のフックを仕掛けたい場合は、二次元配列にすることで指定できます。次のようにするとよいでしょう。

   SyntaxHighlighterについて

   01 02 03 04 05 06 07 08 09 10 11 12 13 14

   <?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed'); // コントローラーのコンストラクタが終了したタイミングで呼ばれるフック名 $hook['post_controller_constructor'][] = array(   'class'     => 'Hoge',   'function'  => 'foo',   'filename'  => 'hoge.php',   'filepath'  => 'hooks' ); $hook['post_controller_constructor'][] = array(   'class'     => 'Fuga',   'function'  => 'bar',   'filename'  => 'fuga.php',   'filepath'  => 'hooks' );

3. さて、あとはフックで呼ばれる対象のクラスを作成するだけです。application/hooks/before_filter.phpを作成します。
4. before_filter.phpを以下のように記述します。
   SyntaxHighlighterについて

   01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17

   <?php class BeforeFilter {   private $CI;     public function __construct() {     // CIオブジェクトを取得     $this->CI =& get_instance();   }     function is_login() {     if(!$this->CI->session->userdata('logged_in') &&        $this->CI->uri->uri_string != '/auth/login') {       // ログインしていない       redirect('auth/login');     }   } }

   CIオブジェクトをget_instance()で取得してしまえば、あとはどうとでもなると思います。ここでは、セッションにログイン情報が入っているかを見てます。ただし、ログイン画面でもチェックしてしまうと無限ループになるので、ログイン画面以外でのチェックにしています。

Rails風なものと違って、別ファイルでフィルタ（フック）を定義するのですが、まぁ使い方はほとんど同じだなーという感じです。とりあえずこれでログインチェックをいちいち全てで行わなくて済むようになったので一安心です。

Tweet

現在、仕事ではなく個人的な用途でCodeIgniterを使っています。既存のコンテンツのCMS脱却を図ろうとしているためです(CMSでないほうが楽な場合のほうが多い。ブログは除く)。
CodeIgniterはシンプルなMVCモデルのフレームワークなのですが、Modelを使わない場合はわかりやすいテンプレート型のCMSとして活用できるな！と思ったので、これを採用しました。

しかし、データベースを使ったアプリ部分も新たに追加しようかなと思ったので、Modelも使ってみようかなと思い、調べていました。仕事でRailsをやるようになったので、CodeIgniterにもMigrationのような機能はないかなー？と思って調べてみたところ、ありました。でもまだ日本語のマニュアルはなさげです。

英語マニュアルにリンクをはっときます。
CodeIgniter User Guide Version 2.1.2 : Migration Class

1. まず、application/config/migration.phpの$config[‘migration_enabled’]をTRUEに設定します。
2. そして、applicationフォルダの下にmigrationsフォルダを作成します。
3. そして、001_create_users.phpを作成し、以下のように定義します。
   SyntaxHighlighterについて

   01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

   <?php defined('BASEPATH') OR exit('No direct script access allowed');   class Migration_Create_users CI_Migration {     public function up()   {     $this->dbforge->add_field('id');     $this->dbforge->add_field(array(       'name' => array(         'type' => 'VARCHAR',         'constraint' => '100',       ),       'password' => array(         'type' => 'VARCHAR',         'constraint' => '100'       )     ));       $this->dbforge->create_table('users');   }     public function down()   {     $this->dbforge->drop_table('users');   } }

4. 次に、application/config/migration.phpの$config[‘migration_version’]を1にします。
5. migrateするには、Migrateライブラリを使う必要があるため、それを呼びます。呼ぶには、コントローラーからアクセスして呼ぶっぽいです。コマンドラインでもできるかもしれないけど、そのやり方は書いてなかったですね。例えば、Migrateコントローラーを作って呼んでみます。
   SyntaxHighlighterについて

   01 02 03 04 05 06 07 08 09 10

   <?php class Migrate extends CI_Controller{     public function index() {     $this->load->library('migration');     if (!$this->migration->current()) {       show_error($this->migration->error_string());     }   } }

6. http://localhost/index.php?migrate/indexにアクセスしてみましょう(URLルーティングいじってたら別になりますので注意。まぁ普通はいじってると思いますが)
7. エラーになったら、原因を直してリロードしましょう。何も表示されなかったらマイグレーション成功です。phpMyAdminなどで見てみましょう。

一カ所、ハマった点がありまして、それはprimary keyを設定するところでした。
$this->dbforge->add_field(‘id’);
とすると、自動的にそれがプライマリキーになります。
CodeIgniterのサイトのサンプルコードが’blog_id’となっていたので、それを’id’に修正してからmigrateしたら、エラーで怒られてしまいました。先にadd_fieldしておくとよいでしょう。
SQLを書かなくてもデータベースのテーブルを作ることができて、バージョンも管理できるという点が、やっぱり好きですねぇ。

Tweet