From cbc261fe33be4018a4e1b63d98c0f2fcf77d4e82 Mon Sep 17 00:00:00 2001
From: wangchunsheng <chunsheng@cnezsoft.com>
Date: Tue, 9 Nov 2010 08:28:19 +0000
Subject: [PATCH]  * recomment the model.

---
 framework/model.class.php | 75 +++++++++++++++++++++++----------------
 1 file changed, 45 insertions(+), 30 deletions(-)

diff --git a/framework/model.class.php b/framework/model.class.php
index 7ec2025151..855ca40c82 100755
--- a/framework/model.class.php
+++ b/framework/model.class.php
@@ -10,14 +10,14 @@
  * @link        http://www.zentao.net
  */
 /**
- * 模型基类。
+ * The base class of model.
  * 
- * @package ZenTaoPHP
+ * @package ZenTaoCMS
  */
 class model
 {
     /**
-     * 全局的$app对象。
+     * The global $app object.
      * 
      * @var object
      * @access protected
@@ -25,7 +25,7 @@ class model
     protected $app;
 
     /**
-     * 全局的$config对象。 
+     * The global $config object.
      * 
      * @var object
      * @access protected
@@ -33,7 +33,7 @@ class model
     protected $config;
 
     /**
-     * 全局的$lang对象。
+     * The global $lang object.
      * 
      * @var object
      * @access protected
@@ -41,7 +41,7 @@ class model
     protected $lang;
 
     /**
-     * 全局的$dbh（数据库访问句柄）对象。
+     * The global $dbh object, the database connection handler.
      * 
      * @var object
      * @access protected
@@ -49,7 +49,7 @@ class model
     protected $dbh;
 
     /**
-     * dao对象。
+     * The $dao object, used to access or update database.
      * 
      * @var object
      * @access protected
@@ -57,7 +57,7 @@ class model
     public $dao;
 
     /**
-     * POST对象。
+     * The $post object, used to access the $_POST var.
      * 
      * @var ojbect
      * @access public
@@ -65,7 +65,7 @@ class model
     public $post;
 
     /**
-     * get对象。
+     * The $get object, used to access the $_GET var.
      * 
      * @var ojbect
      * @access public
@@ -73,7 +73,7 @@ class model
     public $get;
 
     /**
-     * session对象。
+     * The $sesion object, used to access the $_SESSION var.
      * 
      * @var ojbect
      * @access public
@@ -81,7 +81,7 @@ class model
     public $session;
 
     /**
-     * server对象。
+     * The $server object, used to access the $_SERVER var.
      * 
      * @var ojbect
      * @access public
@@ -89,7 +89,7 @@ class model
     public $server;
 
     /**
-     * cookie对象。
+     * The $cookie object, used to access the $_COOKIE var.
      * 
      * @var ojbect
      * @access public
@@ -97,7 +97,7 @@ class model
     public $cookie;
 
     /**
-     * global对象。
+     * The $global object, used to access the $_GLOBAL var.
      * 
      * @var ojbect
      * @access public
@@ -105,10 +105,10 @@ class model
     public $global;
 
     /**
-     * 构造函数：
+     * The construct function.
      *
-     * 1. 引用全局变量，使之可以通过成员属性访问。
-     * 2. 设置当前模块的路径、配置、语言等信息，并加载相应的文件。
+     * 1. global the global vars, refer them by the class member such as $this->app.
+     * 2. set the pathes, config, lang of current module
      * 
      * @access public
      * @return void
@@ -125,17 +125,19 @@ class model
         $this->app->loadLang($moduleName,   $exit = false);
         $this->app->loadConfig($moduleName, $exit = false);
      
-        if(isset($config->db->dao)   and $config->db->dao)   $this->loadDAO();
-        if(isset($config->super2OBJ) and $config->super2OBJ) $this->setSuperVars();
+        $this->loadDAO();
+        $this->setSuperVars();
     }
 
     /**
-     * 设置模块名：将类名中的model替换掉即为模块名。
-     * 没有使用$app->getModule()方法，因为它返回的是当前调用的模块。
-     * 而在一次请求中，当前模块的control文件很有可能会调用其他模块的model。
+     * Get the module name of this model. Not the module user visiting.
+     *
+     * This method replace the 'ext' and 'model' string from the model class name, thus get the module name.
+     * Not useing $app->getModuleName() because it return the module user is visiting. But one module can be
+     * loaded by loadModel() so we must get the module name of thie model.
      * 
      * @access protected
-     * @return void
+     * @return string       the module name.
      */
     protected function getModuleName()
     {
@@ -146,7 +148,7 @@ class model
     }
 
     /**
-     * 设置超全局变量。
+     * Set the super vars.
      * 
      * @access protected
      * @return void
@@ -162,11 +164,11 @@ class model
     }
 
     /**
-     * 加载某一个模块的model文件。
+     * Load the model of one module. After loaded, can use $this->modulename to visit the model object.
      * 
-     * @param   string  $moduleName     模块名字，如果为空，则取当前的模块名作为model名。
+     * @param   string  $moduleName
      * @access  public
-     * @return  void
+     * @return  object  the model object
      */
     public function loadModel($moduleName)
     {
@@ -182,10 +184,10 @@ class model
         return $this->$moduleName;
     }
 
-    //-------------------- 数据库操作相应的方法。--------------------//
+    //-------------------- DAO related method s--------------------//
 
     /**
-     * 加载DAO类，并返回对象。
+     * Load DAO.
      * 
      * @access private
      * @return void
@@ -195,7 +197,14 @@ class model
         $this->dao = $this->app->loadClass('dao');
     }
 
-    /* 将一条记录标记为已删除。*/
+    /**
+     * Delete one record.
+     * 
+     * @param  string    $table  the table name
+     * @param  string    $id     the id value of the record to be deleted
+     * @access public
+     * @return void
+     */
     public function delete($table, $id)
     {
         $this->dao->update($table)->set('deleted')->eq(1)->where('id')->eq($id)->exec();
@@ -203,7 +212,13 @@ class model
         $this->loadModel('action')->create($object, $id, 'deleted', '', $extra = ACTIONMODEL::CAN_UNDELETED);
     }
 
-    /* 还原已经标记为删除的记录。*/
+    /**
+     * Undelete an record.
+     * 
+     * @param  int      $actionID 
+     * @access public
+     * @return void
+     */
     public function undelete($actionID)
     {
         $action = $this->loadModel('action')->getById($actionID);