Changeset 256

Timestamp:

02/11/07 12:33:23 (1 year ago)

Author:

mikey

Message:

Stubbles Database Persistence API (still experimental):

• reworked serializer
  
• added finder
  
• moved querybuilder package one down, is now part of rdbms instead of rdbms.persistence
  

for example usage see experiments/people/mikey/persistence

Files:

• trunk/experiments/people/mikey/persistence/MyNewsArticle.php (modified) (5 diffs)
• trunk/experiments/people/mikey/persistence/README (added)
• trunk/experiments/people/mikey/persistence/connection.php (added)
• trunk/experiments/people/mikey/persistence/createTable.php (modified) (1 diff)
• trunk/experiments/people/mikey/persistence/fetchEntry.php (added)
• trunk/experiments/people/mikey/persistence/insertEntry.php (added)
• trunk/experiments/people/mikey/persistence/listEntries.php (added)
• trunk/experiments/people/mikey/persistence/updateEntry.php (added)
• trunk/src/main/php/net/stubbles/rdbms/persistence/EXPERIMENTAL (modified) (1 diff)
• trunk/src/main/php/net/stubbles/rdbms/persistence/finder (added)
• trunk/src/main/php/net/stubbles/rdbms/persistence/finder/stubDatabaseFinder.php (added)
• trunk/src/main/php/net/stubbles/rdbms/persistence/finder/stubDatabaseFinderException.php (added)
• trunk/src/main/php/net/stubbles/rdbms/persistence/serializer (added)
• trunk/src/main/php/net/stubbles/rdbms/persistence/serializer/stubDatabaseSerializer.php (moved) (moved from trunk/src/main/php/net/stubbles/rdbms/persistence/stubDatabaseSerializer.php) (5 diffs)
• trunk/src/main/php/net/stubbles/rdbms/persistence/serializer/stubDatabaseSerializerException.php (moved) (moved from trunk/src/main/php/net/stubbles/rdbms/persistence/stubDatabaseSerializerException.php)
• trunk/src/main/php/net/stubbles/rdbms/persistence/stubDatabaseSerializedValue.php (deleted)
• trunk/src/main/php/net/stubbles/rdbms/persistence/stubPersistenceException.php (added)
• trunk/src/main/php/net/stubbles/rdbms/persistence/stubSetterMethodFactory.php (added)
• trunk/src/main/php/net/stubbles/rdbms/querybuilder (moved) (moved from trunk/src/main/php/net/stubbles/rdbms/persistence/querybuilder)
• trunk/src/main/php/net/stubbles/rdbms/querybuilder/stubDatabaseMySQLQueryBuilder.php (modified) (2 diffs)
• trunk/src/main/php/net/stubbles/rdbms/querybuilder/stubDatabaseQueryBuilder.php (modified) (1 diff)
• trunk/src/main/php/net/stubbles/rdbms/querybuilder/stubDatabaseQueryBuilderException.php (added)
• trunk/src/main/php/net/stubbles/rdbms/querybuilder/stubDatabaseQueryBuilderFactory.php (added)
• trunk/src/main/php/net/stubbles/rdbms/stubDatabaseConnection.php (modified) (1 diff)
• trunk/src/main/php/net/stubbles/rdbms/stubDatabaseResult.php (modified) (1 diff)
• trunk/src/main/php/net/stubbles/rdbms/stubDatabaseStatement.php (modified) (1 diff)

trunk/experiments/people/mikey/persistence/MyNewsArticle.php

@@ -12 +12 @@
-     * @var  int
-     */
-
+           = null
-    /**
-     * switch whether news is stored persistent or not
@@ -54 +54 @@
-     * @var  int
-     */
-0
+null
-    /**
-     * status of article
@@ -60 +60 @@
-     * @var  int
-     */
-0
+null
-    
-    /**
@@ -217 +217 @@
-    public function setStatus($status)
-    {
-lastChanged
+status
-    }
-    
@@ -256 +256 @@
-        return $this->isPersistent;
-    }
+    
+    /**
+     * returns a list of all instances with status $status
+     *
+     * @param   stubDatabaseFinder  $finder  the finder to use
+     * @param   int                 $status  status that the instances must have
+     * @return  array<MyNewsArticle>
+     */
+    public static function findByStatus(stubDatabaseFinder $finder, $status)
+    {
+        $equalCriterion = new stubEqualCriterion('status', $status, 'news');
+        return $finder->findByCriterion($equalCriterion, __CLASS__);
+    }
-}
-?>

trunk/experiments/people/mikey/persistence/createTable.php

@@ -4 +4 @@
-stubClassLoader::load('net.stubbles.rdbms.rdbms',
-                      'net.stubbles.rdbms.persistence.stubPersistable',
-
-
-
-
+
-);
-require_once 'MyNewsArticle.php';
+require_once 'connection.php';
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-?>

trunk/src/main/php/net/stubbles/rdbms/persistence/EXPERIMENTAL

@@ -1 @@
-
-
-
+
+

trunk/src/main/php/net/stubbles/rdbms/persistence/serializer/stubDatabaseSerializer.php

@@ -5 +5 @@
- * @author      Frank Kleine <mikey@stubbles.net>
- * @package     stubbles
-
+_serializer
- */
-stubClassLoader::load('net.stubbles.rdbms.stubDatabaseConnection',
-
+
+
+
-                      'net.stubbles.rdbms.persistence.stubPersistable',
-
-
-
+
+
+
+
+
-);
-/**
@@ -18 +22 @@
- *
- * @package     stubbles
-
+_serializer
- */
-class stubDatabaseSerializer extends stubBaseObject
-{
+    /**
+     * list of serializer instances
+     *
+     * @var  array<string,stubDatabaseSerializer>
+     */
+    protected static $instances = array();
-    /**
-     * the connection to use for making the object persistent
@@ -28 +38 @@
-     */
-    protected $connection;
-    /**
-     * the querybuilder to use
-     *
-     * @var  stubDatabaseQueryBuilder
-     */
-    protected $queryBuilder;
-    /**
-     * information about the single primary key
-     *
-     * @var  array
-     */
-    protected $singlePrimaryKey = null;
-    
-    /**
@@ -45 +43 @@
-     *
-     * @param  stubDatabaseConnection    $connection
-     * @param  stubDatabaseQueryBuilder  $queryBuilder
-     */
-ublic function __construct(stubDatabaseConnection $connection, stubDatabaseQueryBuilder $queryBuilder
+rotected function __construct(stubDatabaseConnection $connection
-    {
-        $this->connection   = $connection;
-        $this->queryBuilder = $queryBuilder;
-    }
-    
-    /**
-
+
+
+
+
+
-     *
-
-
-
+
+
-     */
-serialize(stubPersistable $stubPersistable
+getInstance(stubDatabaseConnection $connection
-    {
-
-
-
-
+
+
-        }
-        
-
-
-
-
-
-
-
-
-
-
+
-    }
-    
-    /**
-process the properties of the persistable object
+cloning is forbidden
-     *
-
-
-
-
+
-     */
-unction processProperties(array $refProperties, $baseTable, stubPersistable $stubPersistable, stubDatabaseSerializedValue $serializedValue
+inal function __clone(
-    {
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                continue;
-            }
-            
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                }
-                
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            }
-            
-
-
-
-
-
-
-
-
-
-
+
-        }
+        
+        try {
+            $this->processQueries($this->getQueries($serializedValue, $persistable->isPersistent()), $persistable, $singlePrimaryKey);
+        } catch (stubDatabaseException $dbe) {
+            throw new stubDatabaseSerializerException('Can not persist ' . $refObject->getFullQualifiedClassName() . ': a database error occured.', $dbe);
+        }
+        
+        $persistable->setPersistent(true);
-    }
-
-    /**
-     * process the methods of the persistable object
-     *
-     * @param array <stubReflectionMethod>  $refMethods
-     * @param string                        $baseTable
-     * @param stubPersistable               $stubPersistable
-     * @param stubDatabaseSerializedValue   $serializedValue
-     */
-    protected function processMethods(array $refMethods, $baseTable, stubPersistable $stubPersistable, stubDatabaseSerializedValue $serializedValue)
-    {
-        foreach ($refMethods as $refMethod) {
-            if ($refMethod->isPublic() == false || $refMethod->hasAnnotation('DBColumn') == false) {
-                continue;
-            }
-            
-            $table = $baseTable;
-            if (null === $table) {
-                if ($refMethod->hasAnnotation('DBTable') == false) {
-                    throw new stubDatabaseSerializerException('No database table defined for return value of ' . $stubPersistable->getClassName() . '::' . $refMethod->getName() . '()');
-                }
-                
-                $table = $refMethod->getAnnotation('DBTable')->getName();
-            }
-            
-            try {
-                $value = $refMethod->invoke($stubPersistable);
-            } catch (ReflectionException $re) {
-                throw new stubDatabaseSerializerException('Can not get return value of ' . $stubPersistable->getClassName() . '::' . $refMethod->getName() . '(), invokation failed.', $re);
-            }
-            
-            if (null == $value && $refMethod->getAnnotation('DBColumn')->isPrimaryKey() == true) {
-                if ($stubPersistable->isPersistent() == true) {
-                    throw new stubDatabaseSerializerException('Data inconsistent: persistable object is already persistent, but the primary key ' . $stubPersistable->getClassName() . '::' . $refMethod->getName() . '() is null.');
-                }
-                
-                $this->setSinglePrimaryKey($refMethod->getName(), $refMethod->getAnnotation('DBColumn')->getName(), $table);
-            }
-            
-            $serializedValue->setColumnValue($table, $refMethod->getAnnotation('DBColumn')->getName(), $value, $refMethod->getAnnotation('DBColumn')->isPrimaryKey());
-        }
-    }
-    
-    /**
-     * sets the single primary key which may be null
-     *
-     * @param  string  $propertyName  name of the property or method
-     * @param  string  $columnName    name of the column where primary key is stored
-     * @param  string  $tableName     name of the table where primary key is stored
-     */
-    protected function setSinglePrimaryKey($propertyName, $columnName, $tableName)
-    {
-        if (null != $this->singlePrimaryKey) {
-            throw new stubDatabaseSerializerException('Persistence error: only one primary key can be null, but at least two primary keys are null: ' . $$this->singlePrimaryKey['propertyName'] . ' and ' . $propertyName);
-        }
-
-        $this->singlePrimaryKey = array('propertyName' => $propertyName,
-                                        'columnName'   => $columnName,
-                                        'tableName'    => $tableName
-                                  );
-    }
-    
-    /**
-     * build the queries out of the serialized value
-     *
-stubDatabaseSerializedValue  $value
-   
-<string,string>         tableName => query
+array                     $values
+
+(tableName => query)
-     */
-stubDatabaseSerializedValue $value
+array $values
-    {
+        $queryBuilder = stubDatabaseQueryBuilderFactory::create($this->connection);
-        if (true == $isPersistent) {
-this->queryBuilder->createUpdate($value
+queryBuilder->createUpdate($values
-        }
-        
-this->queryBuilder->createInsert($value
+queryBuilder->createInsert($values
-    }
-    
@@ -197 +168 @@
-     * process the queries
-     *
-
+
+
+
-     * @throws  stubDatabaseException
-     */
-stubPersistable
+persistable, array $singlePrimaryKey = null
-    {
-        foreach ($queries as $tableName => $query) {
-            $this->connection->exec($query);
- $this->singlePrimaryKey && $this->singlePrimaryKey['tabl
-stubP
+= $singlePrimaryKey && $singlePrimaryKey['tableNam
+p
-            }
-        }
-    }
+    
+    /**
+     * returns a unique hash code for the class
+     * 
+     * Two serializers are equal if they use the same connection.
+     *
+     * @return  string
+     */
+    public function hashCode()
+    {
+        return 'serializer:' . $this->connection->hashCode();
+    }
-}
-?>

trunk/src/main/php/net/stubbles/rdbms/querybuilder/stubDatabaseMySQLQueryBuilder.php

@@ -5 +5 @@
- * @author      Frank Kleine <mikey@stubbles.net>
- * @package     stubbles
-persistence_
+
- */
-persistence.
+
-/**
- * Class for creating MySQL specific queries.
- *
- * @package     stubbles
-persistence_
+
- */
-class stubDatabaseMySQLQueryBuilder extends stubBaseObject implements stubDatabaseQueryBuilder
-{
-    /**
+     * creates a select query
+     *
+     * @param   stubCriterion   $criterion  condition for query
+     * @param   array           $tables     list of tables to use in query
+     * @return  string
+     */
+    public function createSelect(stubCriterion $criterion, array $tables)
+    {
+        return 'SELECT * FROM `' . join('`, `', $tables) . '` WHERE ' . $criterion->toSQL();
+    }
+    
+    /**
-     * creates insert queries from a serialized value
-     *
-stubDatabaseSerializedValue  $value
-<string,string>         tableName => query
+array(tableName => array(columns => array(columnName => columnValue)))  $values
+(tableName => query)
-     */
-stubDatabaseSerializedValue $value
+array $values
-    {
-        $queries    = array();
-$value->getTableNames(
+array_keys($values
-        foreach ($tableNames as $tableName) {
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        }
-        
@@ -37 +64 @@
-     * creates update queries from a serialized value
-     *
-stubDatabaseSerializedValue  $value
-<string,string>         tableName => query
+array(tableName => array(criterion => stubCrition, columns => array(columnName => columnValue)))  $values
+(tableName => query)
-     */
-stubDatabaseSerializedValue $value
+array $values
-    {
-        $queries    = array();
-$value->getTableNames(
+array_keys($values
-        foreach ($tableNames as $tableName) {
-            $columns = $value->getColumnsForTable($tableName);
-            $query   = 'UPDATE `' . $tableName . '` SET ';
-            $where   = array();
-            $counter = 0;
-columns
+values[$tableName]['columns']
-                if (0 < $counter) {
-                    $query .= ', ';
-                }
-                
-
+
+
+
+
+
+
-                $counter++;
-                
-                if ($value->isPrimaryKey($tableName, $columnName) == true) {
-                    $where[] = '`' . $columnName . "` = '" . $columnValue . "'";
-                }
-            }
-            
-join(' AND ', $where
+$values[$tableName]['criterion']->toSQL(
-        }
-        
-        return $queries;
-    }
+    
+    /**
+     * creates the query to create a table for the given class
+     *
+     * @param   string  $fqClassName  the full qualified classname of the class to create the table for
+     * @throws  stubDatabaseQueryBuilderException
+     * @todo    put all reflection related stuff to persistence package, 
+     *          introduce a class that represents a table description
+     */
+    public function createTable($fqClassName)
+    {
+        $nqClassName = stubClassLoader::getNonQualifiedClassName($fqClassName);
+        if (class_exists($nqClassName, false) == false) {
+            stubClassLoader::load($fqClassName);
+        }
+        
+        $refClass = new stubReflectionClass($nqClassName);
+        if ($refClass->hasAnnotation('DBTable') == false) {
+            throw new stubDatabaseQueryBuilderException('Class ' . $refClass->getName() . ' is missing the DBTable annotation.');
+        }
+        
+        $dbTable     = $refClass->getAnnotation('DBTable');
+        $tableName   = $dbTable->getName();
+        $query       = 'CREATE TABLE `' . $tableName . "` (\n";
+        $methods     = $refClass->getMethods();
+        $primaryKeys = array();
+        $keys        = array();
+        foreach ($methods as $method) {
+            if ($method->hasAnnotation('DBColumn') == false || $method->getDeclaringClass()->equals($refClass) == false) {
+                continue;
+            } elseif ($method->hasAnnotation('DBTable') == true && $method->getAnnotation('DBTable')->getName() != $tableName) {
+                continue;
+            }
+            
+            $dbColumn = $method->getAnnotation('DBColumn');
+            $query   .= '  ' . $dbColumn->getName() . ' ' . $dbColumn->getType();
+            if (strtoupper($dbColumn->getType()) != 'TEXT') {
+                $query   .= '(' . str_replace('_', ',', $dbColumn->getSize()) . ')';
+            }
+            
+            if ($dbColumn->isUnsigned() == true) {
+                $query .= ' UNSIGNED';
+            }
+            
+            if ($dbColumn->isNullable() == true && $dbColumn->getDefaultValue() == null) {
+                $query .= ' DEFAULT NULL';
+            } else {
+                if ($dbColumn->isNullable() == false) {
+                    $query .= ' NOT NULL';
+                }
+                
+                if ($dbColumn->getDefaultValue() !== null) {
+                    $query .= " DEFAULT '" . $dbColumn->getDefaultValue() . "'";
+                }
+            }
+            
+            if ($dbColumn->isPrimaryKey() == true) {
+                $query        .= ' AUTO_INCREMENT';
+                $primaryKeys[] = $dbColumn->getName();
+            } elseif ($dbColumn->isKey() == true) {
+                $keys[] = $dbColumn->getName();
+            }
+            
+            $query .= ",\n";
+        }
+        if (count($primaryKeys) > 0) {
+            if (count($primaryKeys) > 1) {
+                $query = str_replace(' AUTO_INCREMENT', '', $query);
+            }
+            
+            $query .= '  PRIMARY KEY (`' . join('`, `', $primaryKeys) . '`)';
+        }
+        if (count($keys) > 0) {
+            foreach ($keys as $key) {
+                $query .= ",\n  KEY (`" . $key . '`)';
+            }
+        }
+        
+        $query .= "\n) TYPE=" . $dbTable->getType();
+        if ($dbTable->hasCharacterSet() == true) {
+            $query .= ' CHARACTER SET=' . $dbTable->getCharacterSet();
+        }
+        
+        if ($dbTable->hasCollation() == true) {
+            $query .= ' COLLATE=' . $dbTable->getCollation();
+        }
+        
+        if ($dbTable->hasComment() == true) {
+            $query .= ' COMMENT=' . $dbTable->getComment();
+        }
+        
+        return $query;
+    }
-}
-?>

trunk/src/main/php/net/stubbles/rdbms/querybuilder/stubDatabaseQueryBuilder.php

@@ -5 +5 @@
- * @author      Frank Kleine <mikey@stubbles.net>
- * @package     stubbles
-persistence_
+
- */
-
+
+
+
+
+
+
-/**
- * Interface for database specific query builders.
- *
- * @package     stubbles
-persistence_
+
- */
-interface stubDatabaseQueryBuilder
-{
-    /**
+     * creates a select query
+     *
+     * @param   stubCriterion   $criterion  condition for query
+     * @param   array           $tables     list of tables to use in query
+     * @return  string
+     */
+    public function createSelect(stubCriterion $criterion, array $tables);
+    
+    /**
-     * creates insert queries from a serialized value
-     *
-stubDatabaseSerializedValue  $value
-<string,string>         tableName => query
+array(tableName => array(columns => array(columnName => columnValue)))  $values
+(tableName => query)
-     */
-stubDatabaseSerializedValue $value
+array $values
-    
-    /**
-     * creates update queries from a serialized value
-     *
-stubDatabaseSerializedValue  $value
-<string,string>         tableName => query
+array(tableName => array(criterion => stubCrition, columns => array(columnName => columnValue)))  $values
+(tableName => query)
-     */
-
+
+
+
+
+
+
+
+
+
-}
-?>

trunk/src/main/php/net/stubbles/rdbms/stubDatabaseConnection.php

@@ -16 +16 @@
- * @subpackage  rdbms
- */
-
+ extends stubObject
-{
-    /**

trunk/src/main/php/net/stubbles/rdbms/stubDatabaseResult.php

@@ -14 +14 @@
- * @subpackage  rdbms
- */
-
+ extends stubObject
-{
-    /**

trunk/src/main/php/net/stubbles/rdbms/stubDatabaseStatement.php

@@ -14 +14 @@
- * @subpackage  rdbms
- */
-
+ extends stubObject
-{
-    /**