Ticket #5: daoRecordExtended.diff

build/manifests/jelix-lib.mn

@@ -270 +270 @@
-  jDao.class.php
-* jDaoCompiler.class.php
-  jDaoConditions.class.php
+  jDaoExtended.class.php
+  jDaoRecordBaseExtended.class.php
-
-cd lib/jelix/db
-* jDb.class.php

lib/jelix/dao/jDaoExtended.class.php

@@ +1 @@
+<?php
+/**
+* @package    jelix
+* @subpackage dao
+* @author     Sylvain de vathaire
+* @contributor
+* @copyright   2008 Neov
+* @link        http://www.jelix.org
+* @licence  http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
+*/
+
+/**
+ *
+ */
+require_once(JELIX_LIB_PATH.'dao/jDao.class.php');
+
+/**
+ * Factory to create DAO objects with supports of the extended records
+ * @package  jelix
+ * @subpackage dao
+ */
+class jDaoExtended extends jDao {
+
+    /**
+    * creates a new instance of a DAO.
+    * If no dao is founded, try to compile a DAO from the dao xml file
+    * @param string|jSelectorDao $Daoid the dao selector
+    * @param string $profil the db profil name to use for the connection. 
+    *   If empty, use the default profil
+    * @return jDaoFactoryBase  the dao object
+    */
+    public static function create ($DaoId, $recordClassName = '', $profil=''){
+
+        if(!is_object($DaoId))
+            $sel = new jSelectorDao($DaoId, $profil);
+        else $sel = $DaoId;
+
+
+        $c = $sel->getDaoClass();
+        if(!class_exists($c,false)){
+            jIncluder::inc($sel);
+        }
+        $conn = jDb::getConnection ($profil);
+        if($recordClassName!= ''){
+            jClasses::inc($sel->module.'~'.$recordClassName);
+            $obj = new $c ($conn, $recordClassName);
+        }else{
+            $obj = new $c ($conn);
+        }
+        return $obj;
+    }
+
+    /**
+    * return a DAO instance. It Handles a singleton of the DAO.
+    * If no dao is founded, try to compile a DAO from the dao xml file
+    * @param string|jSelectorDao $Daoid the dao selector
+    * @param string $profil the db profil name to use for the connection. 
+    *   If empty, use the default profil
+    * @return jDaoFactoryBase  the dao object
+    */
+    public static function get ($DaoId, $recordClassName='', $profil='') {
+       static $_daoSingleton=array();
+
+       $sel = new jSelectorDao($DaoId, $profil);
+       $DaoId = $sel->toString ();
+
+        if (! isset ($_daoSingleton[$DaoId.$recordClassName])){
+            $_daoSingleton[$DaoId.$recordClassName] = self::create ($sel, $recordClassName, $profil);
+        }
+        return $_daoSingleton[$DaoId.$recordClassName];
+    }
+}
+?>

lib/jelix/dao/jDaoGenerator.class.php

@@ -136 +136 @@
-        $src[] = '   public static $_pkFields = array('.$this->_writeFieldNamesWith ($start = '\'', $end='\'', $beetween = ',', $pkFields).');';
-
-        $src[] = ' ';
-
+, $DaoRecordClassName = \'\'
-        $src[] = '   parent::__construct($conn);';
-        $src[] = '   $this->_fromClause = \''.$sqlFromClause.'\';';
+        $src[] = '      if($DaoRecordClassName != \'\'){';
+        $src[] = '          $this->_DaoRecordClassName = $DaoRecordClassName;';
+        $src[] = '      }';
-        $src[] = '}';
-
-        // cannot put this methods directly into jDaoBase because of a php bug on static methods/properties

lib/jelix/dao/jDaoRecordBaseExtended.class.php

@@ +1 @@
+<?php
+/**
+ * @package     jelix
+ * @subpackage  dao
+ * @author      Sylvain de Vathaire
+ * @contributor Loic Mathaud
+ * @copyright   2008 Neov
+ * @copyright   2007 Loic Mathaud
+ * @link        http://www.jelix.org
+ * @licence     http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
+ */
+
+
+/**
+ *
+ */
+require_once(JELIX_LIB_PATH.'dao/jDaoRecordBase.class.php');
+
+
+/**
+ * Base class for all extended record classes
+ * @package  jelix
+ * @subpackage dao
+ * @see jDaoExtended
+ */
+class jDaoRecordBaseExtended extends jDaoRecordBase{
+
+    private $_properties;
+
+    function __construct(){
+       $propertiesName = array_keys($this->getProperties());
+       foreach($propertiesName as $propertyName){
+           $this->_properties[$propertyName] = null;
+       }
+    }
+
+    final private function __get($property) {
+        if (array_key_exists($property, $this->_properties)) {
+            return $this->_properties[$property];
+        }else{
+            return null;
+        }
+      }
+
+    final private function __set($property, $val){
+        if (array_key_exists($property, $this->_properties)){
+            $this->_properties[$property] = $val;
+        }else{
+            //TODO : A revoir comment faire propre
+            throw new Exception('Invalid property '.$property.' for class '.get_class($this));
+        }
+    }
+
+    private function __isset($property){
+        return array_key_exists($property, $this->_properties);
+    }
+
+    private function __unset($property){
+        unset($this->_properties[$property]);
+    }
+
+    
+    /**
+     * @return array informations on all properties
+     * @see jDaoFactoryBase::getProperties()
+     */
+    public function getProperties(){
+        $vars = get_class_vars($this->_getFactoryClassName());
+        return $vars['_properties'];
+    }
+
+    /**
+     * @return array list of properties name which contains primary keys
+     * @see jDaoFactoryBase::getPrimaryKeyNames()
+     * @since 1.0b3
+     */
+     public function getPrimaryKeyNames(){
+        $vars = get_class_vars($this->_getFactoryClassName());
+        return $vars['_pkFields'];
+     }
+
+    /**
+     * @return string class name of the factory used to instanciate the record
+     */
+    private function _getFactoryClassName(){
+
+        static $factoryClassName = '';
+        if($factoryClassName != ''){
+            return $factoryClassName;
+        }
+        //Hack : In order to get a dao selector, we look for the module name in the class file path
+        $className = get_class($this);
+        $class = new ReflectionClass($className);
+        $classPath = $class->getFileName();
+        $classPath = substr($classPath, strrpos($classPath, DIRECTORY_SEPARATOR.'modules'.DIRECTORY_SEPARATOR)); 
+        $moduleName = substr($classPath, 9, strrpos($classPath, DIRECTORY_SEPARATOR.'classes'.DIRECTORY_SEPARATOR)-9); 
+
+        $daoId = substr($className, 0, strrpos($className, 'Record'));
+        $daoId = $moduleName.'~'.$daoId;
+
+        $sel = new jSelectorDao($daoId, '');
+        $factoryClassName = $sel->getDaoClass();
+
+        return $factoryClassName;
+    }
+
+}
+
+?>