Changeset 281

Timestamp:

07/12/07 11:01:18 (1 year ago)

Author:

bermiferrer

Message:

Classifying Active Record source by functionality as required by the upcoming API documentation generator.

Files:

• trunk/README.txt (modified) (1 diff)
• trunk/config/locales/en.php (modified) (1 diff)
• trunk/config/locales/es.php (modified) (1 diff)
• trunk/lib/AkActiveRecord.php (modified) (40 diffs)
• trunk/script/setup (modified) (1 diff)
• trunk/test/unit/lib/AkActiveRecord/_AkActiveRecord_1.php (modified) (1 diff)
• trunk/version.txt (modified) (1 diff)

trunk/README.txt

@@ -11 +11 @@
-
-You can find more information at the Akelos Framework website at
-
+www.
-
-

trunk/config/locales/en.php

@@ -33 +33 @@
-$dictionary['Unable to fetch current model name'] = 'Unable to fetch current model name';
-$dictionary['Unable to set "%table_name" table for the model "%model".  There is no "%table_name" available into current database layout. Set AK_ACTIVE_CONTROLLER_VALIDATE_TABLE_NAMES constant to false in order to avoid table name validation'] = 'Unable to set "%table_name" table for the model "%model".  There is no "%table_name" available into current database layout. Set AK_ACTIVE_CONTROLLER_VALIDATE_TABLE_NAMES constant to false in order to avoid table name validation';
-l
-l
+
+
-$dictionary['Error'] = 'Error';
-$dictionary['There was an error while setting the composed field "%field_name", the following mapping column/s "%columns" do not exist'] = 'There was an error while setting the composed field "%field_name", the following mapping column/s "%columns" do not exist';

trunk/config/locales/es.php

@@ -31 +31 @@
-$dictionary['Unable to fetch current model name'] = 'No se ha podido averiguar el nombre del modelo actual';
-$dictionary['Unable to set "%table_name" table for the model "%model".  There is no "%table_name" available into current database layout. Set AK_ACTIVE_CONTROLLER_VALIDATE_TABLE_NAMES constant to false in order to avoid table name validation'] = 'No se ha podido relacionar la tabla "%table_name" con el modelo "%model". No se ha encontrado ninguna tabla llamada "%table_name" entre las tablas de la base de datos. Defina la constante AK_ACTIVE_CONTROLLER_VALIDATE_TABLE_NAMES como falsa en config/config.php para desactivar la auto-averiguación de los nombres de tablas';
-l
-l
+
+
-$dictionary['Error'] = 'Error';
-$dictionary['There was an error while setting the composed field "%field_name", the following mapping column/s "%columns" do not exist'] = 'There was an error while setting the composed field "%field_name", the following mapping column/s "%columns" do not exist';

trunk/lib/AkActiveRecord.php

@@ -12 +12 @@
- * @package AkelosFramework
- * @subpackage AkActiveRecord
+ * @component Active Record
- * @author Bermi Ferrer <bermi a.t akelos c.om> 2004 - 2007
- * @author Kaste 2007
@@ -118 +119 @@
-* == Saving arrays, hashes, and other non-mappable objects in text columns ==
-* 
-h
+
-* a comma separated list of columns or an array. 
-* This makes it possible to store arrays, hashes, and other non-mappeable objects without doing any additional work. Example:
@@ -295 +296 @@
-    }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    /**
-    * Creates an object, instantly saves it as a record (if the validation permits it), and returns it. 
@@ -407 +388 @@
-    }
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    /**
-      * Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
@@ -430 +557 @@
-        return @(integer)$rs->fields[0];
-    }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-    /**
-    * Finds the record from the passed id, instantly saves it with the passed attributes (if the validation permits it), 
@@ -507 +610 @@
-    }
-
-
-
-
-    /**
-    * Updates all records with the SET-part of an SQL update statement in updates and returns an 
@@ -515 +615 @@
-    * <code>$Billing->updateAll("category = 'authorized', approved = 1", "author = 'David'");</code>
-    * 
-fit
+ti
-    * variable conditions when using this function
-    */
@@ -534 +634 @@
-
-    /**
+    * Updates the associated record with values matching those of the instance attributes.
+    * Must be called as a result of a call to createOrUpdate.
+    */
+    function _update()
+    {
+        if($this->isFrozen()){
+            $this->transactionFail();
+            return false;
+        }
+        if($this->beforeUpdate()){
+            $this->notifyObservers('beforeUpdate');
+
+            if($this->_recordTimestamps){
+                if ($this->hasColumn('updated_at')){
+                    $this->setAttribute('updated_at', Ak::getDate());
+                }
+                if ($this->hasColumn('updated_on')){
+                    $this->setAttribute('updated_on', Ak::getDate(null, 'Y-m-d'));
+                }
+            }
+
+
+            $lock_check = '';
+            if ($this->isLockingEnabled()){
+                $previous_value = $this->lock_version;
+                $this->setAttribute('lock_version', $previous_value + 1);
+                $lock_check = ' AND lock_version = '.$previous_value;
+            }
+
+            $quoted_attributes = $this->getAvailableAttributesQuoted();
+
+            if(!empty($quoted_attributes)){
+                $sql = 'UPDATE '.$this->getTableName().' '.
+                'SET '.join(', ', $quoted_attributes) .' '.
+                'WHERE '.$this->getPrimaryKey().'='.$this->quotedId().$lock_check;
+            }
+
+            if(!$this->_executeSql($sql, false)){
+                $this->transactionFail();
+                AK_DEBUG ? trigger_error($this->_db->ErrorMsg(), E_USER_NOTICE) : null;
+            }
+
+            if ($this->isLockingEnabled()){
+                if($this->_db->Affected_Rows() != 1){
+                    $this->setAttribute('lock_version', $previous_value);
+                    $this->transactionFail();
+                    trigger_error(Ak::t('Attempted to update a stale object'), E_USER_NOTICE);
+                    return false;
+                }
+            }
+
+            if(!$this->transactionHasFailed()){
+                if($this->afterUpdate()){
+                    $this->notifyObservers('afterUpdate');
+                }else {
+                    $this->transactionFail();
+                }
+            }
+
+        }else{
+            $this->transactionFail();
+        }
+        return $this;
+    }
+    
+    /*/Updating records*/
+    
+    
+    
+    /** 
+                          Deleting records
+    ====================================================================
+    See also: Callbacks.
+    */
+    
+    /**
-    * Deletes the record with the given id without instantiating an object first. If an array of 
-    * ids is provided, all of them are deleted.
@@ -545 +721 @@
-        return $this->deleteAll($this->getPrimaryKey().' IN ('.(is_array($id) ? join(', ',$id) : $id).')');
-    }
-
-
-    /**
-    * Returns an array of names for the attributes available on this object sorted alphabetically.
-    */
-    function getAttributeNames()
-    {
-        if(!isset($this->_activeRecordHasBeenInstantiated)){
-            return Ak::handleStaticCall();
-        }
-        $attributes = array_keys($this->getAvailableAttributes());
-        $names = array_combine($attributes,array_map(array(&$this,'getAttributeCaption'), $attributes));
-        natsort($names);
-        return $names;
-    }
-
-
-    /**
-    * Returns true if the specified attribute has been set by the user or by a database load and is neither null nor empty?
-    */
-    function isAttributePresent($attribute)
-    {
-        $value = $this->getAttribute($attribute);
-        return !empty($value);
-    }
-
-
-
@@ -579 +729 @@
-    * <code>$Post->destroyAll("person_id = 5 AND (category = 'Something' OR category = 'Else')");</code>
-    * 
-fit
+ti
-    * variable conditions when using this function
-    */
@@ -666 +816 @@
-
-
-
-    /**
-    * Destroys the objects for all the records that matches the condition by instantiating 
@@ -690 +839 @@
-        }
-    }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-
-    /**
@@ -760 +859 @@
-        return $this->find('first',array('conditions' => array($this->getPrimaryKey().' = '.$id))) !== false;
-    }
-
-
-
-
-    /**
@@ -1009 +1105 @@
-
-
-    function &objectCache()
-    {
-        static $cache;
-        $args =& func_get_args();
-        if(count($args) == 2){
-            if(!isset($cache[$args[0]])){
-                $cache[$args[0]] =& $args[1];
-            }
-        }elseif(!isset($cache[$args[0]])){
-            return false;
-        }
-        return $cache[$args[0]];
-    }
-
-    /**
-    * Gets an array from a string.
-    *
-    * Acts like Php explode() function but uses any of this as valid separators ' AND ',' and ',' + ',' ',',',';'
-    */
-    function getArrayFromAkString($string)
-    {
-        if(is_array($string)){
-            return $string;
-        }
-        $string = str_replace(array(' AND ',' and ',' + ',' ',',',';'),array('|','|','|','','|','|'),trim($string));
-        return strstr($string,'|') ? explode('|', $string) : array($string);
-    }
-
-    // Gets the column name for use with single table inheritance ? can be overridden in subclasses.
-    function getInheritanceColumn()
-    {
-        return empty($this->_inheritanceColumn) ? ($this->hasColumn('type') ? 'type' : false ) : $this->_inheritanceColumn;
-    }
-
-    // Defines the column name for use with single table inheritance ? can be overridden in subclasses.
-    function setInheritanceColumn($column_name)
-    {
-        if(!$this->hasColumn($column_name)){
-            trigger_error(Ak::t('Could not set "%column_name" as the inheritance column as this column is not available on the database.',array('%column_name'=>$column_name)), E_USER_NOTICE);
-            return false;
-        }elseif($this->getColumnType($column_name) != 'string'){
-            trigger_error(Ak::t('Could not set %column_name as the inheritance column as this column type is "%column_type" instead of "string".',array('%column_name'=>$column_name,'%column_type'=>$this->getColumnType($column_name))), E_USER_NOTICE);
-            return false;
-        }else{
-            $this->_inheritanceColumn = $column_name;
-            return true;
-        }
-    }
-
-    function getColumnsWithRegexBoundaries()
-    {
-        $columns = array_keys($this->getColumns());
-        foreach ($columns as $k=>$column){
-            $columns[$k] = '/([^\.])\b('.$column.')\b/';
-        }
-        return $columns;
-    }
-
-
-
-    //SELECT t.code as codigo , c.description  as descripcion FROM technical_listings as t LEFT OUTER JOIN categories as c ON c.id = t.category_id
-
-
-
-    /**
-    * Works like find_all, but requires a complete SQL string. Examples:
@@ -1117 +1149 @@
-    }
-
-
-
-
-
+
+
-    * @todo use PHP5 __call method for handling the magic finder methods like findFirstByUnsenameAndPassword('bermi','pass')
-    */
@@ -1166 +1196 @@
-    }
-
+    /**
+    * This method allows you to use finders in a more flexible way like:
+    * 
+    *   findBy('username AND password', $username, $password);
+    *   findBy('age > ? AND name:contains', 18, 'Joe');
+    *   findBy('is_active = true AND session_id', session_id());
+    *   
+    */
-    function &findBy()
-    {
@@ -1294 +1332 @@
-
-
-    /**
-    * Finder methods must instantiate through this method to work with the single-table inheritance model and
-    * eager loading associations.
-    * that makes it possible to create objects of different types from the same table.
-    */
-    function &instantiate($record, $set_as_new = true)
-    {
-        $inheritance_column = $this->getInheritanceColumn();
-        if(!empty($record[$inheritance_column])){
-            $inheritance_column = $record[$inheritance_column];
-            $inheritance_model_name = AkInflector::camelize($inheritance_column);
-            @require_once(AkInflector::toModelFilename($inheritance_model_name));
-            if(!class_exists($inheritance_model_name)){
-                trigger_error($this->t("The single-table inheritance mechanism failed to locate the subclass: '%class_name'. ".
-                "This error is raised because the column '%column' is reserved for storing the class in case of inheritance. ".
-                "Please rename this column if you didn't intend it to be used for storing the inheritance class ".
-                "or overwrite #{self.to_s}.inheritance_column to use another column for that information.",
-                array('%class_name'=>$inheritance_model_name, '%column'=>$this->getInheritanceColumn())),E_USER_ERROR);
-            }
-        }
-
-        $model_name = isset($inheritance_model_name) ? $inheritance_model_name : $this->getModelName();
-        $object =& new $model_name('attributes', $record);
-
-        $object->_newRecord = $set_as_new;
-
-        (AK_CLI && AK_ENVIRONMENT == 'development') ? $object ->toString() : null;
-
-        return $object;
-    }
-
-
-
-    function constructFinderSql($options, $select_from_prefix = 'default')
-    {
@@ -1409 +1414 @@
-    }
-
-
-    function descendsFromActiveRecord(&$object)
-    {
-        if(substr(strtolower(get_parent_class($object)),-12) == 'activerecord'){
-            return true;
-        }
-        if(!method_exists($object, 'getInheritanceColumn')){
-            return false;
-        }
-        $inheritance_column = $object->getInheritanceColumn();
-        return !empty($inheritance_column);
-    }
-
-
-    function typeCondition()
-    {
-        $inheritance_column = $this->getInheritanceColumn();
-        $type_condition = array();
-        $table_name = $this->getTableName();
-        $available_types = array_merge(array($this->getModelName()),$this->getSubclasses());
-        foreach ($available_types as $subclass){
-            $type_condition[] = ' '.$table_name.'.'.$inheritance_column.' = \''.AkInflector::demodulize($subclass).'\' ';
-        }
-        return empty($type_condition) ? '' : '('.join('OR',$type_condition).') ';
-    }
-
-    function getSubclasses()
-    {
-        $current_class = get_class($this);
-        $subclasses = array();
-        $classes = get_declared_classes();
-
-        while ($class = array_shift($classes)) {
-            $parent_class = get_parent_class($class);
-            if($parent_class == $current_class || in_array($parent_class,$subclasses)){
-                $subclasses[] = $class;
-            }elseif(!empty($parent_class)){
-                $classes[] = $parent_class;
-            }
-        }
-        $subclasses = array_unique(array_map(array(&$this,'_getModelName'),$subclasses));
-        return $subclasses;
-    }
-
-    function _quoteColumnName($column_name)
-    {
@@ -1459 +1420 @@
-
-
-    /**
-    * Parses an special formated array as a list of keys and values
-    * 
-    * This function generates an array with values and keys from an array with numeric keys.
-    * 
-    * This allows to parse an array to a function in the following manner.
-    * create('first_name->', 'Bermi', 'last_name->', 'Ferrer');
-    * //Previous code will be the same that
-    * create(array('first_name'=>'Bermi', 'last_name'=> 'Ferrer'));
-    *
-    * Use this syntax only for quick testings, not for production environments. If the number of arguments varies, the result might be unpredictable.
-    *
-    * This function syntax is disabled by default. You need to define('AK_ENABLE_AKELOS_ARGS', true)
-    * if you need this functionality.
-    *
-    * @deprecated
-    */
-    function parseAkelosArgs(&$args)
-    {
-        if(!AK_ENABLE_AKELOS_ARGS){
-            return ;
-        }
-        $k = array_keys($args);
-        if(isset($k[1]) && substr($args[$k[0]],-1) == '>'){
-            $size = sizeOf($k);
-            $params = array();
-            for($i = 0; $i < $size; $i++ ) {
-                $v = $args[$k[$i]];
-                if(!isset($key) && is_string($args[$k[$i]]) && substr($v,-1) == '>'){
-                    $key = rtrim($v, '=-> ');
-                }elseif(isset($key)) {
-                    $params[$key] = $v;
-                    unset($key);
-                }else{
-                    $params[$k[$i]] = $v;
-                }
-            }
-            if(!empty($params)){
-                $args = $params;
-            }
-        }
-        $this->_castDateParametersFromDateHelper_($args);
-    }
-
-    /**
-    * Joins date arguments into a single attribute. Like the array generated by the date_helper, so
-    * array('published_on(1i)' => 2002, 'published_on(2i)' => 'January', 'published_on(3i)' => 24)
-    * Will be converted to array('published_on'=>'2002-01-24')
-    */
-    function _castDateParametersFromDateHelper_(&$params)
-    {
-        if(empty($params)){
-            return;
-        }
-        $date_attributes = array();
-        foreach ($params as $k=>$v) {
-            if(preg_match('/^([A-Za-z0-9_]+)\(([1-5]{1})i\)$/',$k,$match)){
-                $date_attributes[$match[1]][$match[2]] = $v;
-                unset($params[$k]);
-            }
-        }
-        foreach ($date_attributes as $attribute=>$date){
-            $params[$attribute] = Ak::getDate(Ak::getTimestamp(trim(@$date[1].'-'.@$date[2].'-'.@$date[3].' '.@$date[4].':'.@$date[5],' :-')));
-        }
-    }
-
-
@@ -1567 +1463 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+