Source for file Ethna_ClassFactory.php

Documentation is available at Ethna_ClassFactory.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Ethna_ClassFactory.php
  5.  *
  6.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id: Ethna_ClassFactory.php 527 2008-05-07 02:40:15Z mumumu-org $
  10.  */
  11.  
  12. // {{{ Ethna_ClassFactory
  13. /**
  14.  *  Ethnaフレームワークのオブジェクト生成ゲートウェイ
  15.  *
  16.  *  DIコンテナか、ということも考えましたがEthnaではこの程度の単純なものに
  17.  *  留めておきます。アプリケーションレベルDIしたい場合はフィルタチェインを
  18.  *  使って実現することも出来ます。
  19.  *
  20.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  21.  *  @access     public
  22.  *  @package    Ethna
  23.  */
  24. class Ethna_ClassFactory
  25. {
  26.     /**#@+
  27.      *  @access private
  28.      */
  29.  
  30.     /** @var    object  Ethna_Controller    controllerオブジェクト */
  31.     var $controller;
  32.  
  33.     /** @var    object  Ethna_Controller    controllerオブジェクト(省略形) */
  34.     var $ctl;
  35.     
  36.     /** @var    array   クラス定義 */
  37.     var $class = array();
  38.  
  39.     /** @var    array   生成済みオブジェクトキャッシュ */
  40.     var $object = array();
  41.  
  42.     /** @var    array   生成済みアプリケーションマネージャオブジェクトキャッシュ */
  43.     var $manager = array();
  44.  
  45.     /** @var    array   メソッド一覧キャッシュ */
  46.     var $method_list = array();
  47.  
  48.     /**#@-*/
  49.  
  50.  
  51.     /**
  52.      *  Ethna_ClassFactoryクラスのコンストラクタ
  53.      *
  54.      *  @access public
  55.      *  @param  object  Ethna_Controller    &$controller    controllerオブジェクト
  56.      *  @param  array                       $class          クラス定義
  57.      */
  58.     function Ethna_ClassFactory(&$controller, $class)
  59.     {
  60.         $this->controller =& $controller;
  61.         $this->ctl =& $controller;
  62.         $this->class = $class;
  63.     }
  64.  
  65.     /**
  66.      *  typeに対応するアプリケーションマネージャオブジェクトを返す
  67.      *
  68.      *  @access public
  69.      *  @param  string  $type   クラスキー
  70.      *  @param  bool    $weak   オブジェクトが未生成の場合の強制生成フラグ(default: false)
  71.      *  @return object  Ethna_AppManager    マネージャオブジェクト
  72.      *
  73.      *   TODO: 現状の実装では、typeを名前として扱っているのに、
  74.      *         大文字小文字を区別して違うインスタンスを返しているのを修正する
  75.      */
  76.     function &getManager($type, $weak = false)
  77.     {
  78.         $obj = null;
  79.  
  80.         // check if object class exists
  81.         $obj_class_name = $this->controller->getObjectClassName($type);
  82.         if (class_exists($obj_class_name) === false) {
  83.             // try include.
  84.             $this->_include($obj_class_name);
  85.         }
  86.  
  87.         // check if manager class exists
  88.         $class_name = $this->controller->getManagerClassName($type);
  89.         if (class_exists($class_name) === false
  90.             && $this->_include($class_name) === false) {
  91.             return $obj;
  92.         }
  93.  
  94.         if (isset($this->method_list[$class_name]) == false) {
  95.             $this->method_list[$class_name] = get_class_methods($class_name);
  96.             for ($i = 0; $i < count($this->method_list[$class_name]); $i++) {
  97.                 $this->method_list[$class_name][$i] = strtolower($this->method_list[$class_name][$i]);
  98.             }
  99.         }
  100.  
  101.         // see if this should be singlton or not
  102.         if ($this->_isCacheAvailable($class_name, $this->method_list[$class_name], $weak)) {
  103.             if (isset($this->manager[$type]) && is_object($this->manager[$type])) {
  104.                 return $this->manager[$type];
  105.             }
  106.         }
  107.  
  108.         // see if we have helper methods
  109.         if (in_array("getinstance", $this->method_list[$class_name])) {
  110.             $obj = call_user_func(array($class_name, 'getInstance'));
  111.         } else {
  112.             $backend =& $this->controller->getBackend();
  113.             $obj =& new $class_name($backend);
  114.         }
  115.  
  116.         if (isset($this->manager[$type]) == false || is_object($this->manager[$type]) == false) {
  117.             $this->manager[$type] =& $obj;
  118.         }
  119.  
  120.         return $obj;
  121.     }
  122.  
  123.     /**
  124.      *  クラスキーに対応するオブジェクトを返す/クラスキーが未定義の場合はAppObjectを探す
  125.      *
  126.      *  @access public
  127.      *  @param  string  $key    クラスキー
  128.      *  @param  bool    $weak   オブジェクトが未生成の場合の強制生成フラグ(default: false)
  129.      *  @return object  生成されたオブジェクト(エラーならnull) 
  130.      *
  131.      *   TODO: 現状の実装では、typeを名前として扱っているのに、
  132.      *         大文字小文字を区別して違うインスタンスを返しているのを修正する
  133.      */
  134.     function &getObject($key, $ext = false)
  135.     {
  136.         $object = null;
  137.  
  138.         $ext = to_array($ext);
  139.         if (isset($this->class[$key]) == false) {
  140.             // app object
  141.             $class_name = $this->controller->getObjectClassName($key);
  142.             $ext = array_pad($ext, 3, null);
  143.             list($key_type, $key_value, $prop) = $ext;
  144.         } else {
  145.             // ethna classes
  146.             $class_name = $this->class[$key];
  147.             $ext = array_pad($ext, 1, null);
  148.             list($weak) = $ext;
  149.         }
  150.  
  151.         // try to include if not defined
  152.         if (class_exists($class_name) == false) {
  153.             if ($this->_include($class_name) == false) {
  154.                 return $object;
  155.             }
  156.         }
  157.  
  158.         // handle app object first
  159.         if (isset($this->class[$key]) == false) {
  160.             $backend =& $this->controller->getBackend();
  161.             $object =& new $class_name($backend, $key_type, $key_value, $prop);
  162.             return $object;
  163.         }
  164.  
  165.         if (isset($this->method_list[$class_name]) == false) {
  166.             $this->method_list[$class_name] = get_class_methods($class_name);
  167.             for ($i = 0; $i < count($this->method_list[$class_name]); $i++) {
  168.                 $this->method_list[$class_name][$i] = strtolower($this->method_list[$class_name][$i]);
  169.             }
  170.         }
  171.  
  172.         // see if this should be singlton or not
  173.         if ($this->_isCacheAvailable($class_name, $this->method_list[$class_name], $weak)) {
  174.             if (isset($this->object[$key]) && is_object($this->object[$key])) {
  175.                 return $this->object[$key];
  176.             }
  177.         }
  178.  
  179.         // see if we have helper methods
  180.         $method = sprintf('_getObject_%s', ucfirst($key));
  181.         if (method_exists($this, $method)) {
  182.             $object =& $this->$method($class_name);
  183.         } else if (in_array("getinstance", $this->method_list[$class_name])) {
  184.             $object = call_user_func(array($class_name, 'getInstance'));
  185.         } else {
  186.             $object =& new $class_name();
  187.         }
  188.  
  189.         if (isset($this->object[$key]) == false || is_object($this->object[$key]) == false) {
  190.             $this->object[$key] =& $object;
  191.         }
  192.  
  193.         return $object;
  194.     }
  195.  
  196.     /**
  197.      *  クラスキーに対応するクラス名を返す
  198.      *
  199.      *  @access public
  200.      *  @param  string  $key    クラスキー
  201.      *  @return string  クラス名
  202.      */
  203.     function getObjectName($key)
  204.     {
  205.         if (isset($this->class[$key]) == false) {
  206.             return null;
  207.         }
  208.  
  209.         return $this->class[$key];
  210.     }
  211.  
  212.     /**
  213.      *  オブジェクト生成メソッド(backend)
  214.      *
  215.      *  @access protected
  216.      *  @param  string  $class_name     クラス名
  217.      *  @return object  生成されたオブジェクト(エラーならnull) 
  218.      */
  219.     function &_getObject_Backend($class_name)
  220.     {
  221.         $_ret_object =& new $class_name($this->ctl);
  222.         return $_ret_object;
  223.     }
  224.  
  225.     /**
  226.      *  オブジェクト生成メソッド(config)
  227.      *
  228.      *  @access protected
  229.      *  @param  string  $class_name     クラス名
  230.      *  @return object  生成されたオブジェクト(エラーならnull) 
  231.      */
  232.     function &_getObject_Config($class_name)
  233.     {
  234.         $_ret_object =& new $class_name($this->ctl);
  235.         return $_ret_object;
  236.     }
  237.  
  238.     /**
  239.      *  オブジェクト生成メソッド(i18n)
  240.      *
  241.      *  @access protected
  242.      *  @param  string  $class_name     クラス名
  243.      *  @return object  生成されたオブジェクト(エラーならnull) 
  244.      */
  245.     function &_getObject_I18n($class_name)
  246.     {
  247.         $_ret_object =& new $class_name($this->ctl->getDirectory('locale'), $this->ctl->getAppId());
  248.         return $_ret_object;
  249.     }
  250.  
  251.     /**
  252.      *  オブジェクト生成メソッド(logger)
  253.      *
  254.      *  @access protected
  255.      *  @param  string  $class_name     クラス名
  256.      *  @return object  生成されたオブジェクト(エラーならnull) 
  257.      */
  258.     function &_getObject_Logger($class_name)
  259.     {
  260.         $_ret_object =& new $class_name($this->ctl);
  261.         return $_ret_object;
  262.     }
  263.  
  264.     /**
  265.      *  オブジェクト生成メソッド(plugin)
  266.      *
  267.      *  @access protected
  268.      *  @param  string  $class_name     クラス名
  269.      *  @return object  生成されたオブジェクト(エラーならnull) 
  270.      */
  271.     function &_getObject_Plugin($class_name)
  272.     {
  273.         $_ret_object =& new $class_name($this->ctl);
  274.         return $_ret_object;
  275.     }
  276.  
  277.     /**
  278.      *  オブジェクト生成メソッド(renderer)
  279.      *
  280.      *  @access protected
  281.      *  @param  string  $class_name     クラス名
  282.      *  @return object  生成されたオブジェクト(エラーならnull) 
  283.      */
  284.     function &_getObject_Renderer($class_name)
  285.     {
  286.         $_ret_object =& new $class_name($this->ctl);
  287.         return $_ret_object;
  288.     }
  289.  
  290.     /**
  291.      *  オブジェクト生成メソッド(session)
  292.      *
  293.      *  @access protected
  294.      *  @param  string  $class_name     クラス名
  295.      *  @return object  生成されたオブジェクト(エラーならnull) 
  296.      */
  297.     function &_getObject_Session($class_name)
  298.     {
  299.         $_ret_object =& new $class_name($this->ctl->getAppId(), $this->ctl->getDirectory('tmp'), $this->ctl->getLogger());
  300.         return $_ret_object;
  301.     }
  302.  
  303.     /**
  304.      *  オブジェクト生成メソッド(sql)
  305.      *
  306.      *  @access protected
  307.      *  @param  string  $class_name     クラス名
  308.      *  @return object  生成されたオブジェクト(エラーならnull) 
  309.      */
  310.     function &_getObject_Sql($class_name)
  311.     {
  312.         $_ret_object =& new $class_name($this->ctl);
  313.         return $_ret_object;
  314.     }
  315.  
  316.     /**
  317.      *  指定されたクラスから想定されるファイルをincludeする
  318.      *
  319.      *  @access protected
  320.      */
  321.     function _include($class_name)
  322.     {
  323.         $file = sprintf("%s.%s", $class_name, $this->controller->getExt('php'));
  324.         if (file_exists_ex($file)) {
  325.             include_once $file;
  326.             return true;
  327.         }
  328.  
  329.         if (preg_match('/^(\w+?)_(.*)/', $class_name, $match)) {
  330.             // try ethna app style
  331.             // App_Foo_Bar_Baz -> Foo/Bar/App_Foo_Bar_Baz.php
  332.             $tmp = explode("_", $match[2]);
  333.             $tmp[count($tmp)-1] = $class_name;
  334.             $file = sprintf('%s.%s',
  335.                             implode(DIRECTORY_SEPARATOR, $tmp),
  336.                             $this->controller->getExt('php'));
  337.             if (file_exists_ex($file)) {
  338.                 include_once $file;
  339.                 return true;
  340.             }
  341.  
  342.             // try ethna app & pear mixed style
  343.             // App_Foo_Bar_Baz -> Foo/Bar/Baz.php
  344.             $file = sprintf('%s.%s',
  345.                             str_replace('_', DIRECTORY_SEPARATOR, $match[2]),
  346.                             $this->controller->getExt('php'));
  347.             if (file_exists_ex($file)) {
  348.                 include_once $file;
  349.                 return true;
  350.             }
  351.  
  352.             // try ethna master style
  353.             // Ethna_Foo_Bar -> class/Ethna/Foo/Ethna_Foo_Bar.php
  354.             array_unshift($tmp, 'Ethna', 'class');
  355.             $file = sprintf('%s.%s',
  356.                             implode(DIRECTORY_SEPARATOR, $tmp),
  357.                             $this->controller->getExt('php'));
  358.             if (file_exists_ex($file)) {
  359.                 include_once $file;
  360.                 return true;
  361.             }
  362.  
  363.             // try pear style
  364.             // Foo_Bar_Baz -> Foo/Bar/Baz.php
  365.             $file = sprintf('%s.%s',
  366.                             str_replace('_', DIRECTORY_SEPARATOR, $class_name),
  367.                             $this->controller->getExt('php'));
  368.             if (file_exists_ex($file)) {
  369.                 include_once $file;
  370.                 return true;
  371.             }
  372.         }
  373.         return false;
  374.     }
  375.  
  376.     /**
  377.      *  指定されたクラスがキャッシュを利用可能かどうかをチェックする
  378.      *
  379.      *  @access protected
  380.      */
  381.     function _isCacheAvailable($class_name, $method_list, $weak)
  382.     {
  383.         // if we have getInstance(), use this anyway
  384.         if (in_array('getinstance', $method_list)) {
  385.             return false;
  386.         }
  387.  
  388.         // if not, see if weak or not
  389.         return $weak ? false : true;
  390.     }
  391. }
  392. // }}}
  393. ?>

Documentation generated on Thu, 08 May 2008 00:14:37 +0900 by phpDocumentor 1.4.2