diff options
| -rw-r--r-- | .gitattributes | 1 | ||||
| -rw-r--r-- | HISTORY | 1 | ||||
| -rw-r--r-- | framework/Caching/TPdoCache.php | 323 | ||||
| -rw-r--r-- | framework/Caching/TSqliteCache.php | 23 | ||||
| -rw-r--r-- | framework/Data/TDbCommand.php | 17 | ||||
| -rw-r--r-- | framework/Data/TDbConnection.php | 6 |
6 files changed, 347 insertions, 24 deletions
diff --git a/.gitattributes b/.gitattributes index eafd0a98..0c3585e0 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1491,6 +1491,7 @@ framework/3rdParty/readme.html -text framework/Caching/TAPCCache.php -text framework/Caching/TCache.php -text framework/Caching/TMemCache.php -text +framework/Caching/TPdoCache.php -text framework/Caching/TSqliteCache.php -text framework/Collections/TAttributeCollection.php -text framework/Collections/TDummyDataSource.php -text @@ -14,6 +14,7 @@ ENH: Added renderer feature to TRepeater, TDataList and TDataGrid (Qiang) ENH: Added support to include external application configuration files (Qiang) ENH: Added PRADO version info in PRADO-generated directories to avoid upgrading issue (Qiang) NEW: TShellApplication (Qiang) +NEW: TDbCache (Qiang) NEW: Active Record driver for IBM DB2 (Cesar Ramos) Version 3.1.0 alpha January 15, 2007 diff --git a/framework/Caching/TPdoCache.php b/framework/Caching/TPdoCache.php new file mode 100644 index 00000000..78fc6849 --- /dev/null +++ b/framework/Caching/TPdoCache.php @@ -0,0 +1,323 @@ +<?php
+/**
+ * TDbCache class file
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.pradosoft.com/
+ * @copyright Copyright © 2005-2007 PradoSoft
+ * @license http://www.pradosoft.com/license/
+ * @version $Id$
+ * @package System.Caching
+ */
+
+Prado::using('System.Data.TDbConnection');
+
+/**
+ * TDbCache class
+ *
+ * TDbCache implements a cache application module by storing cached data in a database.
+ *
+ * TDbCache relies on {@link http://www.php.net/manual/en/ref.pdo.php PDO} to retrieve
+ * data from databases. In order to use TDbCache, you need to enable the PDO extension
+ * as well as the corresponding PDO DB driver. For example, to use SQLite database
+ * to store cached data, you need both php_pdo and php_pdo_sqlite extensions.
+ *
+ * By default, TDbCache creates and uses an SQLite database under the application
+ * runtime directory. You may change this default setting by specifying the following
+ * properties:
+ * - {@link setConnectionString ConnectionString}
+ * - {@link setUsername Username}
+ * - {@link setPassword Pasword}
+ *
+ * The cached data is stored in a table in the specified database.
+ * By default, the name of the table is called 'pradocache'. If the table does not
+ * exist in the database, it will be automatically created with the following structure:
+ * (key CHAR(128) PRIMARY KEY, value BLOB, expire INT)
+ *
+ * If you want to change the cache table name, or if you want to create the table by yourself,
+ * you may set {@link setCacheTableName CacheTableName} and {@link setAutoCreateCacheTable AutoCreateCacheTableName} properties.
+ *
+ * The following basic cache operations are implemented:
+ * - {@link get} : retrieve the value with a key (if any) from cache
+ * - {@link set} : store the value with a key into cache
+ * - {@link add} : store the value only if cache does not have this key
+ * - {@link delete} : delete the value with the specified key from cache
+ * - {@link flush} : delete all values from cache
+ *
+ * Each value is associated with an expiration time. The {@link get} operation
+ * ensures that any expired value will not be returned. The expiration time by
+ * the number of seconds. A expiration time 0 represents never expire.
+ *
+ * By definition, cache does not ensure the existence of a value
+ * even if it never expires. Cache is not meant to be an persistent storage.
+ *
+ * Do not use the same database file for multiple applications using TDbCache.
+ * Also note, cache is shared by all user sessions of an application.
+ *
+ * To use this module, the sqlite PHP extension must be loaded. Note, Sqlite extension
+ * is no longer loaded by default since PHP 5.1.
+ *
+ * Some usage examples of TDbCache are as follows,
+ * <code>
+ * $cache=new TDbCache; // TDbCache may also be loaded as a Prado application module
+ * $cache->init(null);
+ * $cache->add('object',$object);
+ * $object2=$cache->get('object');
+ * </code>
+ *
+ * If loaded, TDbCache will register itself with {@link TApplication} as the
+ * cache module. It can be accessed via {@link TApplication::getCache()}.
+ *
+ * TDbCache may be configured in application configuration file as follows
+ * <code>
+ * <module id="cache" class="System.Caching.TDbCache" />
+ * </code>
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id$
+ * @package System.Caching
+ * @since 3.1.0
+ */
+class TDbCache extends TCache
+{
+ /**
+ * @var TDbConnection the DB connection instance
+ */
+ private $_db;
+ /**
+ * @var string name of the DB cache table
+ */
+ private $_cacheTable='pradocache';
+ /**
+ * @var boolean whether the cache DB table should be created automatically
+ */
+ private $_autoCreate=true;
+
+ /**
+ * Destructor.
+ * Disconnect the db connection.
+ */
+ public function __destruct()
+ {
+ if($this->_db!==null)
+ $this->_db->setActive(false);
+ }
+
+ /**
+ * Initializes this module.
+ * This method is required by the IModule interface. It checks if the DbFile
+ * property is set, and creates a SQLiteDatabase instance for it.
+ * The database or the cache table does not exist, they will be created.
+ * Expired values are also deleted.
+ * @param TXmlElement configuration for this module, can be null
+ * @throws TConfigurationException if sqlite extension is not installed,
+ * DbFile is set invalid, or any error happens during creating database or cache table.
+ */
+ public function init($config)
+ {
+ $db=$this->getDbConnection();
+ if($db->getConnectionString()==='')
+ {
+ // default to SQLite3 database
+ $dbFile=$this->getApplication()->getRuntimePath().'/sqlite3.cache';
+ $db->setConnectionString('sqlite:'.$dbFile);
+ }
+
+ $db->setActive(true);
+
+ $sql='DELETE FROM '.$this->_cacheTable.' WHERE expire<>0 AND expire<'.time();
+ try
+ {
+ $db->createCommand($sql)->execute();
+ }
+ catch(Exception $e)
+ {
+ // DB table not exists
+ if($this->_autoCreate)
+ {
+ $sql='CREATE TABLE '.$this->_cacheTable.' (key CHAR(128) PRIMARY KEY, value BLOB, expire INT)';
+ $db->createCommand($sql)->execute();
+ }
+ else
+ throw TConfigurationException('pdocache_cachetable_inexistent',$this->_cacheTable);
+ }
+
+ parent::init($config);
+ }
+
+ /**
+ * @return TDbConnection the DB connection instance
+ */
+ public function getDbConnection()
+ {
+ if($this->_db===null)
+ $this->_db=new TDbConnection;
+ return $this->_db;
+ }
+
+ /**
+ * @return string The Data Source Name, or DSN, contains the information required to connect to the database.
+ */
+ public function getConnectionString()
+ {
+ return $this->getDbConnection()->getConnectionString();
+ }
+
+ /**
+ * @param string The Data Source Name, or DSN, contains the information required to connect to the database.
+ * @see http://www.php.net/manual/en/function.pdo-construct.php
+ */
+ public function setConnectionString($value)
+ {
+ $this->getDbConnection()->getConnectionString($value);
+ }
+
+ /**
+ * @return string the username for establishing DB connection. Defaults to empty string.
+ */
+ public function getUsername()
+ {
+ return $this->getDbConnection()->getUsername();
+ }
+
+ /**
+ * @param string the username for establishing DB connection
+ */
+ public function setUsername($value)
+ {
+ $this->getDbConnection()->setUsername($value);
+ }
+
+ /**
+ * @return string the password for establishing DB connection. Defaults to empty string.
+ */
+ public function getPassword()
+ {
+ return $this->getDbConnection()->getPassword();
+ }
+
+ /**
+ * @param string the password for establishing DB connection
+ */
+ public function setPassword($value)
+ {
+ $this->getDbConnection()->setPassword($value);
+ }
+
+ /**
+ * @return string the name of the DB table to store cache content. Defaults to 'pradocache'.
+ * @see setAutoCreateCacheTable
+ */
+ public function getCacheTableName()
+ {
+ return $this->_cacheTable;
+ }
+
+ /**
+ * Sets the name of the DB table to store cache content.
+ * Note, if {@link setAutoCreateCacheTable AutoCreateCacheTable} is false
+ * and you want to create the DB table manually by yourself,
+ * you need to make sure the DB table is of the following structure:
+ * (key CHAR(128) PRIMARY KEY, value BLOB, expire INT)
+ * @param string the name of the DB table to store cache content
+ * @see setAutoCreateCacheTable
+ */
+ public function setCacheTableName($value)
+ {
+ $this->_cacheTable=$value;
+ }
+
+ /**
+ * @return boolean whether the cache DB table should be automatically created if not exists. Defaults to true.
+ * @see setAutoCreateCacheTable
+ */
+ public function getAutoCreateCacheTable()
+ {
+ return $this->_autoCreate;
+ }
+
+ /**
+ * @param boolean whether the cache DB table should be automatically created if not exists.
+ * @see setCacheTableName
+ */
+ public function setAutoCreateCacheTable($value)
+ {
+ $this->_autoCreate=TPropertyValue::ensureBoolean($value);
+ }
+
+ /**
+ * Retrieves a value from cache with a specified key.
+ * This is the implementation of the method declared in the parent class.
+ * @param string a unique key identifying the cached value
+ * @return string the value stored in cache, false if the value is not in the cache or expired.
+ */
+ protected function getValue($key)
+ {
+ $sql='SELECT value FROM '.$this->_cacheTable.' WHERE key=\''.$key.'\' AND (expire=0 OR expire>'.time().')';
+ return $this->_db->createCommand($sql)->queryScalar();
+ }
+
+ /**
+ * Stores a value identified by a key in cache.
+ * This is the implementation of the method declared in the parent class.
+ *
+ * @param string the key identifying the value to be cached
+ * @param string the value to be cached
+ * @param integer the number of seconds in which the cached value will expire. 0 means never expire.
+ * @return boolean true if the value is successfully stored into cache, false otherwise
+ */
+ protected function setValue($key,$value,$expire)
+ {
+ $this->deleteValue($key);
+ return $this->addValue($key,$value,$expire);
+ }
+
+ /**
+ * Stores a value identified by a key into cache if the cache does not contain this key.
+ * This is the implementation of the method declared in the parent class.
+ *
+ * @param string the key identifying the value to be cached
+ * @param string the value to be cached
+ * @param integer the number of seconds in which the cached value will expire. 0 means never expire.
+ * @return boolean true if the value is successfully stored into cache, false otherwise
+ */
+ protected function addValue($key,$value,$expire)
+ {
+ $sql="INSERT INTO {$this->_cacheTable} (key,value,expire) VALUES('$key',:value,$expire)";
+ try
+ {
+ $command=$this->_db->createCommand($sql);
+ $command->bindValue(':value',$value,PDO::PARAM_LOB);
+ $command->execute();
+ return true;
+ }
+ catch(Exception $e)
+ {
+ return false;
+ }
+ }
+
+ /**
+ * Deletes a value with the specified key from cache
+ * This is the implementation of the method declared in the parent class.
+ * @param string the key of the value to be deleted
+ * @return boolean if no error happens during deletion
+ */
+ protected function deleteValue($key)
+ {
+ $this->_db->createCommand("DELETE FROM {$this->_cacheTable} WHERE key='$key'")->execute();
+ return true;
+ }
+
+ /**
+ * Deletes all values from cache.
+ * Be careful of performing this operation if the cache is shared by multiple applications.
+ */
+ public function flush()
+ {
+ $this->_db->createCommand("DELETE FROM {$this->_cacheTable}")->execute();
+ return true;
+ }
+}
+
+?>
\ No newline at end of file diff --git a/framework/Caching/TSqliteCache.php b/framework/Caching/TSqliteCache.php index 89c2cdcc..1ca45863 100644 --- a/framework/Caching/TSqliteCache.php +++ b/framework/Caching/TSqliteCache.php @@ -15,6 +15,14 @@ *
* TSqliteCache implements a cache application module based on SQLite database.
*
+ * To use this module, the sqlite PHP extension must be loaded. Note, Sqlite extension
+ * is no longer loaded by default since PHP 5.1.
+ *
+ * Sine PRADO v3.1.0, a new DB-based cache module called {@link TDbCache}
+ * is provided. If you have PDO extension installed, you may consider using
+ * the new cache module instead as it allows you to use different database
+ * to store the cached data.
+ *
* The database file is specified by the {@link setDbFile DbFile} property.
* If not set, the database file will be created under the system state path.
* If the specified database file does not exist, it will be created automatically.
@@ -38,9 +46,6 @@ * Do not use the same database file for multiple applications using TSqliteCache.
* Also note, cache is shared by all user sessions of an application.
*
- * To use this module, the sqlite PHP extension must be loaded. Note, Sqlite extension
- * is no longer loaded by default since PHP 5.1.
- *
* Some usage examples of TSqliteCache are as follows,
* <code>
* $cache=new TSqliteCache; // TSqliteCache may also be loaded as a Prado application module
@@ -117,17 +122,11 @@ class TSqliteCache extends TCache $error='';
if(($this->_db=new SQLiteDatabase($this->_file,0666,$error))===false)
throw new TConfigurationException('sqlitecache_connection_failed',$error);
- if(($res=$this->_db->query('SELECT * FROM sqlite_master WHERE tbl_name=\''.self::CACHE_TABLE.'\' AND type=\'table\' LIMIT 1'))!=false)
+ if(@$this->_db->query('DELETE FROM '.self::CACHE_TABLE.' WHERE expire<>0 AND expire<'.time())===false)
{
- if($res->numRows()===0)
- {
- if($this->_db->query('CREATE TABLE '.self::CACHE_TABLE.' (key CHAR(128) PRIMARY KEY, value BLOB, expire INT)')===false)
- throw new TConfigurationException('sqlitecache_table_creation_failed',sqlite_error_string(sqlite_last_error()));
- }
+ if($this->_db->query('CREATE TABLE '.self::CACHE_TABLE.' (key CHAR(128) PRIMARY KEY, value BLOB, expire INT)')===false)
+ throw new TConfigurationException('sqlitecache_table_creation_failed',sqlite_error_string(sqlite_last_error()));
}
- else
- throw new TConfigurationException('sqlitecache_table_creation_failed',sqlite_error_string(sqlite_last_error()));
- $this->_db->query('DELETE FROM '.self::CACHE_TABLE.' WHERE expire<>0 AND expire<'.time());
$this->_initialized=true;
parent::init($config);
}
diff --git a/framework/Data/TDbCommand.php b/framework/Data/TDbCommand.php index 102bdf34..f5d7d647 100644 --- a/framework/Data/TDbCommand.php +++ b/framework/Data/TDbCommand.php @@ -180,7 +180,9 @@ class TDbCommand extends TComponent {
try
{
- Prado::trace('Execute Command: '.$this->getDebugStatementText(), 'System.Data');
+ // Do not trace because it will remain even in
+ // Performance mode or when pradolite.php is used
+ // Prado::trace('Execute Command: '.$this->getDebugStatementText(), 'System.Data');
if($this->_statement instanceof PDOStatement)
{
$this->_statement->execute();
@@ -216,7 +218,7 @@ class TDbCommand extends TComponent {
try
{
- Prado::trace('Query: '.$this->getDebugStatementText(), 'System.Data');
+ // Prado::trace('Query: '.$this->getDebugStatementText(), 'System.Data');
if($this->_statement instanceof PDOStatement)
$this->_statement->execute();
else
@@ -241,7 +243,7 @@ class TDbCommand extends TComponent {
try
{
- Prado::trace('Query Row: '.$this->getDebugStatementText(), 'System.Data');
+ // Prado::trace('Query Row: '.$this->getDebugStatementText(), 'System.Data');
if($this->_statement instanceof PDOStatement)
$this->_statement->execute();
else
@@ -260,24 +262,21 @@ class TDbCommand extends TComponent * Executes the SQL statement and returns the value of the first column in the first row of data.
* This is a convenient method of {@link query} when only a single scalar
* value is needed (e.g. obtaining the count of the records).
- * @return mixed the value of the first column in the first row of the query result.
+ * @return mixed the value of the first column in the first row of the query result. False is returned if there is no value.
* @throws TDbException execution failed or there is no data
*/
public function queryScalar()
{
try
{
- Prado::trace('Query Scalar: '.$this->getDebugStatementText(), 'System.Data');
+ // Prado::trace('Query Scalar: '.$this->getDebugStatementText(), 'System.Data');
if($this->_statement instanceof PDOStatement)
$this->_statement->execute();
else
$this->_statement=$this->getConnection()->getPdoInstance()->query($this->getText());
$result=$this->_statement->fetchColumn();
$this->_statement->closeCursor();
- if($result!==false)
- return $result;
- else
- throw new TDbException('dbcommand_column_empty');
+ return $result;
}
catch(Exception $e)
{
diff --git a/framework/Data/TDbConnection.php b/framework/Data/TDbConnection.php index be61e0a4..55d2710c 100644 --- a/framework/Data/TDbConnection.php +++ b/framework/Data/TDbConnection.php @@ -79,9 +79,9 @@ Prado::using('System.Data.TDbCommand'); */
class TDbConnection extends TComponent
{
- private $_dsn;
- private $_username;
- private $_password;
+ private $_dsn='';
+ private $_username='';
+ private $_password='';
private $_attributes=array();
private $_active=false;
private $_pdo=null;
|