Source for file Container.php

Documentation is available at Container.php

  1. <?php
  2. /**
  3.  * Teeple2 - PHP5 Web Application Framework inspired by Seasar2
  4.  *
  5.  * PHP versions 5
  6.  *
  7.  * LICENSE: This source file is subject to version 3.0 of the PHP license
  8.  * that is available through the world-wide-web at the following URI:
  9.  * http://www.php.net/license/3_0.txt.  If you did not receive a copy of
  10.  * the PHP License and are unable to obtain it through the web, please
  11.  * send a note to license@php.net so we can mail you a copy immediately.
  12.  *
  13.  * @package     teeple
  14.  * @author      Mitsutaka Sato <miztaka@gmail.com>
  15.  * @license     http://www.php.net/license/3_0.txt  PHP License 3.0
  16.  */
  17.  
  18. /**
  19.  * DIコンテナ
  20.  *
  21.  * @package     teeple
  22.  */
  23. class Teeple_Container
  24. {
  25.  
  26.     const SESSION_KEY = '__SESSION_COMPONENTS';
  27.     
  28.     /**
  29.      * Teeple_Container
  30.      * @var unknown_type 
  31.      */
  32.     private static $instance;
  33.     
  34.     /**
  35.      * Containerとして管理するインスタンスを格納
  36.      * @var array 
  37.      */
  38.     protected $_components = array();
  39.  
  40.     /**
  41.      * 設定内容を保持する配列
  42.      * @var array 
  43.      */
  44.     protected $_dicon = array();
  45.     
  46.     /**
  47.      * @var Logger 
  48.      */
  49.     protected $log;
  50.     
  51.     /**
  52.      * ContainerのSingletonインスタンスを取得します。
  53.      *
  54.      * @return Teeple_Container 
  55.      */
  56.     public static function getInstance() {
  57.  
  58.         if (self::$instance === NULL) {
  59.             self::$instance = new Teeple_Container();
  60.         }
  61.         return self::$instance;
  62.     }
  63.  
  64.     /**
  65.      * コンストラクタ
  66.      *
  67.      */
  68.     public function __construct() {
  69.         $this->log = LoggerManager::getLogger(get_class($this));
  70.         // 自分を登録
  71.         $this->_components['container'] = $this;
  72.     }
  73.  
  74.     /**
  75.      * コンテナをセットアップします。
  76.      *
  77.      * @param string $configfile 
  78.      */
  79.     public function setup($configfile) {
  80.  
  81.         $config = parse_ini_file($configfile, TRUE);
  82.         if (count($config) < 1) {
  83.             throw new Teeple_Exception("コンテナの設定ファイルを読込めませんでした。");
  84.         }
  85.         
  86.         foreach($config as $key => $value) {
  87.             list($clsname, $path) = explode(':', $key);
  88.             $this->_dicon[$clsname] = array(
  89.                 'path' => $path,
  90.                 'attributes' => $value
  91.             );
  92.         }
  93.         
  94.     }
  95.     
  96.     /**
  97.      * ContainerにComponentのインスタンスをセット
  98.      *
  99.      * @param   string  $name   Component名
  100.      * @param   Object  $component  Componentのインスタンス
  101.      */
  102.     public function register($name, $component) {
  103.         if (!is_object($component)) {
  104.             throw new Teeple_Exception("登録しようとしたコンポーネントはオブジェクトではありません。({$name})");
  105.             return;
  106.         }
  107.         $this->_components[$name] = $component;
  108.         return;
  109.     }
  110.     
  111.     /**
  112.      * Componentのインスタンスを取得します。
  113.      * (RequestスコープのComponent)
  114.      *
  115.      * @param   string  $name   Component名
  116.      * @return  Object  Componentのインスタンス
  117.      */
  118.     public function getComponent($name) {
  119.         
  120.         $component = NULL;
  121.         if (isset($this->_components[$name])) {
  122.             $component = $this->_components[$name];
  123.         } else {
  124.             $component = $this->_createComponent($name);
  125.         }
  126.         
  127.         return $component;
  128.     }
  129.     
  130.     /**
  131.      * SessionスコープのComponentを取得します。
  132.      *
  133.      * @param string $name 
  134.      * @return Object 
  135.      */
  136.     public function getSessionComponent($name) {
  137.  
  138.         $component = NULL;
  139.         if (! isset($_SESSION[self::SESSION_KEY])) {
  140.             $_SESSION[self::SESSION_KEY] = array();
  141.         }
  142.         if (isset($_SESSION[self::SESSION_KEY][$name])) {
  143.             $component = $_SESSION[self::SESSION_KEY][$name];
  144.         } else {
  145.             $this->log->debug("セッションに存在しないので作成します。");
  146.             $component = $this->_createComponent($name, FALSE);
  147.             $_SESSION[self::SESSION_KEY][$name] = $component;
  148.         }
  149.         
  150.         return $component;
  151.     }
  152.  
  153.     /**
  154.      * prototypeのComponentを取得します。
  155.      *
  156.      * @param string $name 
  157.      * @return Object 
  158.      */
  159.     public function getPrototype($name) {
  160.         return $this->_createComponent($name, FALSE);
  161.     }
  162.  
  163.     /**
  164.      * Teeple_ActiveRecordのエンティティを取得します。
  165.      * DefaultTxから取得されます。
  166.      *
  167.      * @param string $name 
  168.      * @return Teeple_ActiveRecord 
  169.      */
  170.     public function getEntity($name) {
  171.         
  172.         $defaultTx = $this->getComponent('DefaultTx');
  173.         if (is_object($defaultTx)) {
  174.             return $defaultTx->$name;
  175.         }
  176.         return NULL;
  177.     }
  178.     
  179.     /**
  180.      * コンポーネントをインスタンス化します。
  181.      *
  182.      * @param string $name 
  183.      * @return Object 
  184.      */
  185.     private function _createComponent($name, $register=TRUE) {
  186.         
  187.         $this->log->debug("コンポーネント {$name} を作成します。");
  188.  
  189.         // インスタンスを作成
  190.         if (isset($this->_dicon[$name])) {
  191.             $className = $this->_dicon[$name]['class'];
  192.         } else {
  193.             $className = $name;
  194.         }
  195.         if (! Teeple_Util::includeClassFile($className)) {
  196.             throw new Teeple_Exception("クラス{$className}の定義が存在しません。");
  197.         }
  198.         $instance = new $className();
  199.         if ($register) {
  200.             $this->register($name, $instance);
  201.         }
  202.         
  203.         // 自動インジェクション
  204.         $methods = get_class_methods($className);
  205.         foreach($methods as $method) {
  206.             if (preg_match('/^setComponent_(.+)$/', $method, $m)) {
  207.                 $this->log->debug("自動セット: {$m[1]}");
  208.                 $cp = $this->getComponent($m[1]);
  209.                 $instance->$method($cp);
  210.             }
  211.             elseif (preg_match('/^setSessionComponent_(.+)$/', $method, $m)) {
  212.                 $this->log->debug("自動セット(s): {$m[1]}");
  213.                 $cp = $this->getSessionComponent($m[1]);
  214.                 $instance->$method($cp);
  215.             }
  216.             elseif (preg_match('/^setPrototype_(.+)$/', $method, $m)) {
  217.                 $this->log->debug("自動セット(p): {$m[1]}");
  218.                 $cp = $this->getPrototype($m[1]);
  219.                 $instance->$method($cp);
  220.             }
  221.             elseif (preg_match('/^set(Entity_.+)$/', $method, $m)) {
  222.                 $this->log->debug("自動セット(e): {$m[1]}");
  223.                 $cp = $this->getEntity($m[1]);
  224.                 $instance->$method($cp);
  225.             }
  226.         }
  227.         
  228.         return $instance;
  229.     }
  230.  
  231. }
  232. ?>
Documentation generated on Mon, 26 Apr 2010 08:59:37 +0900 by phpDocumentor 1.4.3