Permalink
Browse files

Merge branch 'dbo-source-cache' into 1.3

  • Loading branch information...
2 parents 5ec9658 + 32432e8 commit a51cceab1827b84457902a35e0ccf7d62d1fdbe7 @markstory markstory committed Mar 14, 2010
@@ -60,6 +60,15 @@ class DboSource extends DataSource {
*/
var $methodCache = array();
+/**
+ * Whether or not to cache the results of DboSource::name() and DboSource::conditions()
+ * into the memory cache. Set to false to disable the use of the memory cache.
+ *
+ * @var boolean.
+ * @access public
+ */
+ var $cacheMethods = true ;
+
/**
* Bypass automatic adding of joined fields/associations.
*
@@ -460,6 +469,41 @@ function field($name, $sql) {
}
}
+/**
+ * Empties the method caches.
+ * These caches are used by DboSource::name() and DboSource::conditions()
+ *
+ * @return void
+ */
+ function flushMethodCache() {
+ $this->methodCache = array();
+ }
+
+/**
+ * Cache a value into the methodCaches. Will respect the value of DboSource::$cacheMethods.
+ * Will retrieve a value from the cache if $value is null.
+ *
+ * If caching is disabled and a write is attempted, the $value will be returned.
+ * A read will either return the value or null.
+ *
+ * @param string $method Name of the method being cached.
+ * @param string $key The keyname for the cache operation.
+ * @param mixed $value The value to cache into memory.
+ * @return mixed Either null on failure, or the value if its set.
+ */
+ function cacheMethod($method, $key, $value = null) {
+ if ($this->cacheMethods === false) {
+ if ($value !== null) {
+ return $value;
+ }
+ return null;
+ }
+ if ($value === null) {
+ return (isset($this->methodCache[$method][$key])) ? $this->methodCache[$method][$key] : null;
+ }
+ return $this->methodCache[$method][$key] = $value;
+ }
+
/**
* Returns a quoted name of $data for use in an SQL statement.
* Strips fields out of SQL functions before quoting.
@@ -482,27 +526,40 @@ function name($data) {
return $data;
}
$cacheKey = crc32($this->startQuote.$data.$this->endQuote);
- if (isset($this->methodCache[__FUNCTION__][$cacheKey])) {
- return $this->methodCache[__FUNCTION__][$cacheKey];
+ if ($return = $this->cacheMethod(__FUNCTION__, $cacheKey)) {
+ return $return;
}
$data = trim($data);
if (preg_match('/^[\w-]+(\.[\w-]+)*$/', $data)) { // string, string.string
if (strpos($data, '.') === false) { // string
- return $this->methodCache[__FUNCTION__][$cacheKey] = $this->startQuote . $data . $this->endQuote;
+ return $this->cacheMethod(__FUNCTION__, $cacheKey, $this->startQuote . $data . $this->endQuote);
}
$items = explode('.', $data);
- return $this->methodCache[__FUNCTION__][$cacheKey] = $this->startQuote . implode($this->endQuote . '.' . $this->startQuote, $items) . $this->endQuote;
+ return $this->cacheMethod(__FUNCTION__, $cacheKey,
+ $this->startQuote . implode($this->endQuote . '.' . $this->startQuote, $items) . $this->endQuote
+ );
}
if (preg_match('/^[\w-]+\.\*$/', $data)) { // string.*
- return $this->methodCache[__FUNCTION__][$cacheKey] = $this->startQuote . str_replace('.*', $this->endQuote . '.*', $data);
+ return $this->cacheMethod(__FUNCTION__, $cacheKey,
+ $this->startQuote . str_replace('.*', $this->endQuote . '.*', $data)
+ );
}
if (preg_match('/^([\w-]+)\((.*)\)$/', $data, $matches)) { // Functions
- return $this->methodCache[__FUNCTION__][$cacheKey] = $matches[1] . '(' . $this->name($matches[2]) . ')';
+ return $this->cacheMethod(__FUNCTION__, $cacheKey,
+ $matches[1] . '(' . $this->name($matches[2]) . ')'
+ );
}
- if (preg_match('/^([\w-]+(\.[\w-]+|\(.*\))*)\s+' . preg_quote($this->alias) . '\s*([\w-]+)$/', $data, $matches)) {
- return $this->methodCache[__FUNCTION__][$cacheKey] = preg_replace('/\s{2,}/', ' ', $this->name($matches[1]) . ' ' . $this->alias . ' ' . $this->name($matches[3]));
+ if (
+ preg_match('/^([\w-]+(\.[\w-]+|\(.*\))*)\s+' . preg_quote($this->alias) . '\s*([\w-]+)$/', $data, $matches
+ )) {
+ return $this->cacheMethod(
+ __FUNCTION__, $cacheKey,
+ preg_replace(
+ '/\s{2,}/', ' ', $this->name($matches[1]) . ' ' . $this->alias . ' ' . $this->name($matches[3])
+ )
+ );
}
- return $this->methodCache[__FUNCTION__][$cacheKey] = $data;
+ return $this->cacheMethod(__FUNCTION__, $cacheKey, $data);
}
/**
@@ -1993,8 +2050,8 @@ function conditions($conditions, $quoteValues = true, $where = true, $model = nu
$cacheKey = array($conditions, $quoteValues, $where);
}
$cacheKey = crc32(serialize($cacheKey));
- if (isset($this->methodCache[__FUNCTION__][$cacheKey])) {
- return $this->methodCache[__FUNCTION__][$cacheKey];
+ if ($return = $this->cacheMethod(__FUNCTION__, $cacheKey)) {
+ return $return;
}
$clause = $out = '';
@@ -2007,16 +2064,16 @@ function conditions($conditions, $quoteValues = true, $where = true, $model = nu
$out = $this->conditionKeysToString($conditions, $quoteValues, $model);
if (empty($out)) {
- return $this->methodCache[__FUNCTION__][$cacheKey] = $clause . ' 1 = 1';
+ return $this->cacheMethod(__FUNCTION__, $cacheKey, $clause . ' 1 = 1');
}
- return $this->methodCache[__FUNCTION__][$cacheKey] = $clause . implode(' AND ', $out);
+ return $this->cacheMethod(__FUNCTION__, $cacheKey, $clause . implode(' AND ', $out));
}
if ($conditions === false || $conditions === true) {
- return $this->methodCache[__FUNCTION__][$cacheKey] = $clause . (int)$conditions . ' = 1';
+ return $this->cacheMethod(__FUNCTION__, $cacheKey, $clause . (int)$conditions . ' = 1');
}
if (empty($conditions) || trim($conditions) == '') {
- return $this->methodCache[__FUNCTION__][$cacheKey] = $clause . '1 = 1';
+ return $this->cacheMethod(__FUNCTION__, $cacheKey, $clause . '1 = 1');
}
$clauses = '/^WHERE\\x20|^GROUP\\x20BY\\x20|^HAVING\\x20|^ORDER\\x20BY\\x20/i';
@@ -2028,7 +2085,7 @@ function conditions($conditions, $quoteValues = true, $where = true, $model = nu
} else {
$conditions = $this->__quoteFields($conditions);
}
- return $this->methodCache[__FUNCTION__][$cacheKey] = $clause . $conditions;
+ return $this->cacheMethod(__FUNCTION__, $cacheKey, $clause . $conditions);
}
/**
@@ -4043,6 +4043,33 @@ function testName() {
$this->assertEqual($result, $expected);
}
+/**
+ * test that cacheMethod works as exepected
+ *
+ * @return void
+ */
+ function testCacheMethod() {
+ $this->testDb->cacheMethods = true;
+ $result = $this->testDb->cacheMethod('name', 'some-key', 'stuff');
+ $this->assertEqual($result, 'stuff');
+
+ $result = $this->testDb->cacheMethod('name', 'some-key');
+ $this->assertEqual($result, 'stuff');
+
+ $result = $this->testDb->cacheMethod('conditions', 'some-key');
+ $this->assertNull($result);
+
+ $result = $this->testDb->cacheMethod('name', 'other-key');
+ $this->assertNull($result);
+
+ $this->testDb->cacheMethods = false;
+ $result = $this->testDb->cacheMethod('name', 'some-key', 'stuff');
+ $this->assertEqual($result, 'stuff');
+
+ $result = $this->testDb->cacheMethod('name', 'some-key');
+ $this->assertNull($result);
+ }
+
/**
* testLog method
*

0 comments on commit a51ccea

Please sign in to comment.