Step8：ユーティリティメソッドを使ってみる - Risoluto - Simple Framework for PHP - Wiki - Risoluto - Simple Frame...

戻る

Up: Risolutoユーザ向けドキュメント

Prev: Step7：セッションを使ってみる

Next: Step9：データベースを使ってみる

Step8：ユーティリティメソッドを使ってみる

このチュートリアルを行う前に……

• Risolutoのセットアップが終了している必要があります
• これまでのチュートリアルを理解している必要があります

ユーティリティメソッドを使ってみる（Base編）

このチュートリアルでは、Risolutoが提供している各種ユーティリティメソッドを使う方法についてご説明したいと思います。

こちらもさほど難しい話ではありませんので、実際のコードを見てみましょう。Step7で作成した「samples_base.ini」を下記のように修正してください。この手順を行うことによって、このsamples_baseクラスを継承したすべてのLogicでユーティリティメソッドを使うことができるようになります。

 <?php
 
   require_once( 'Smarty.class.php' );
   require_once( RISOLUTO_FUNC . 'risoluto_conf.php' );
   require_once( RISOLUTO_FUNC . 'risoluto_log.php'  );
   require_once( RISOLUTO_FUNC . 'risoluto_session.php' );
   require_once( RISOLUTO_FUNC . 'risoluto_util.php' );
 
   abstract class samples_base
   {
     protected $smarty;
     protected $obj_conf;
     protected $obj_log;
     protected $obj_sess;
     protected $obj_util;
 
     abstract function model();
     abstract function view();
 
     public function __construct()
     {
     }
 
     public function __clone()
     {
     }
 
     public function init()
     {
       $this->obj_conf = new RisolutoConf();
       $this->obj_conf->parse( RISOLUTO_CONF . 'risoluto.ini' );
 
       $this->obj_log = RisolutoLog::singleton();
 
       $this->obj_sess = RisolutoSession::singleton();
 
       $this->obj_util = RisolutoUtils::singleton();
 
       $this->smarty                = new Smarty;
       $this->smarty->template_dir  = RISOLUTO_USERLAND . $this->obj_sess->sessLoad( 'currentcage' );
       $this->smarty->config_dir    = RISOLUTO_USERLAND . $this->obj_sess->sessLoad( 'currentcage' );
       $this->smarty->compile_dir   = RISOLUTO_CACHE;
       $this->smarty->cache_dir     = RISOLUTO_CACHE;
       $this->smarty->caching       = false;
       $this->smarty->debugging     = false;
       $this->smarty->force_compile = true;
       $this->smarty->compile_check = true;
 
     }
 
     public function errHandler()
     {
     }
 
     public function clean()
     {
       unset( $this->smarty );
       unset( $this->obj_conf );
       unset( $this->obj_log );
       unset( $this->obj_sess );
       unset( $this->obj_util );
     }
 
   }
 ?>

追加したものについて、簡単にご説明したいとおもいます。

まず、「require_once( RISOLUTO_FUNC . 'risoluto_util.php' );」が追加されました。Risolutoが標準で用意しているユーティリティクラスを読み込みます。

「protected $obj_util;」という1行も追加されています。これはユーティリティクラスのインスタンスを保持するためのクラス変数です。名称は任意ですが慣例としてこの名称にしておくことが推奨されています。

「$this->obj_util = RisolutoUtils::singleton();」がinit()メソッドに追加されていることにお気づきでしょうか。ここでクラスインスタンスの生成を行っています。

clean()メソッドに「unset( $this->obj_util );」が追加されているのも確認いただけるかと思います。

これらを各Logicに組み込んでも構いません*1が、一般にBaseに記述する方がよいでしょう。

ユーティリティメソッドを使ってみる（Logic編）

それでは、Logicの方の処理を見てみましょう。下記のコードを「sample08.php」として保存してください。今回は画面表示を伴わないので、Designは作成しません。

 <?php
   require_once( 'samples_base.inc' );
 
   class sample08 extends samples_base
   {
 
     public function model()
     {
       $this->obj_util->redirectTo( 'sample07', 'samples' );
     }
 
     public function view()
     {
     }
 
   }
 ?>

おそらく、ユーティリティクラスの中で一番よく使うであろうメソッドは、この例で使っている「redirectTo()メソッド」です。このメソッドは、同一Risolutoシステム内の他画面にリダイレクトするメソッドです。

使い方は、「$this->obj_util->redirectTo( 'sample07', 'samples' );」のようになります。第1引数*2にAct、第2引数*3にCageを指定します。すると、その画面にリダイレクトするためのヘッダが出力されます*4。

これらのファイルをアップロードし、最初の画面にWebブラウザからアクセスすると、Step07の画面にリダイレクトされるのが確認できるかと思います。

このように、ユーティリティクラスには普段よく使うメソッドがいろいろと用意されています。ユーティリティクラスについて詳しく知りたい場合は、RisolutoUtilsクラス(risoluto_util.php)を参照してください。

Up: Risolutoユーザ向けドキュメント

Prev: Step7：セッションを使ってみる

Next: Step9：データベースを使ってみる

戻る

---

1. *1例えば、model()メソッド内の適切な位置にこれらを記述すればOKです
2. *2この例で言うと「sample07」がそれですね
3. *3この例で言うと「samples」がそれですね
4. *4内部ではheader()をコールしています