From 9241aa79ff8ab8a940cee01a301162187c24d198 Mon Sep 17 00:00:00 2001
From: Andreas Fischer <bantu@phpbb.com>
Date: Tue, 19 Apr 2011 10:13:18 +0200
Subject: [ticket/10139] Rename $cache to $use_cache to avoid confusion with
 cache object

PHPBB3-10139
---
 phpBB/includes/config/config.php | 26 +++++++++++++-------------
 phpBB/includes/config/db.php     | 38 +++++++++++++++++++-------------------
 2 files changed, 32 insertions(+), 32 deletions(-)

(limited to 'phpBB')

diff --git a/phpBB/includes/config/config.php b/phpBB/includes/config/config.php
index 4ba05a98ec..a273391dc8 100644
--- a/phpBB/includes/config/config.php
+++ b/phpBB/includes/config/config.php
@@ -106,12 +106,12 @@ class phpbb_config implements ArrayAccess, IteratorAggregate, Countable
 	/**
 	* Removes a configuration option
 	*
-	* @param  String $key   The configuration option's name
-	* @param  bool   $cache Whether this variable should be cached or if it
-	*                       changes too frequently to be efficiently cached
+	* @param  String $key       The configuration option's name
+	* @param  bool   $use_cache Whether this variable should be cached or if it
+	*                           changes too frequently to be efficiently cached
 	* @return void
 	*/
-	public function delete($key, $cache = true)
+	public function delete($key, $use_cache = true)
 	{
 		unset($this->config[$key]);
 	}
@@ -119,12 +119,12 @@ class phpbb_config implements ArrayAccess, IteratorAggregate, Countable
 	/**
 	* Sets a configuration option's value
 	*
-	* @param string $key   The configuration option's name
-	* @param string $value New configuration value
-	* @param bool   $cache Whether this variable should be cached or if it
-	*                      changes too frequently to be efficiently cached.
+	* @param string $key       The configuration option's name
+	* @param string $value     New configuration value
+	* @param bool   $use_cache Whether this variable should be cached or if it
+	*                          changes too frequently to be efficiently cached.
 	*/
-	public function set($key, $value, $cache = true)
+	public function set($key, $value, $use_cache = true)
 	{
 		$this->config[$key] = $value;
 	}
@@ -136,11 +136,11 @@ class phpbb_config implements ArrayAccess, IteratorAggregate, Countable
 	* @param  string $key       The configuration option's name
 	* @param  string $old_value Current configuration value
 	* @param  string $value     New configuration value
-	* @param  bool   $cache     Whether this variable should be cached or if it
+	* @param  bool   $use_cache Whether this variable should be cached or if it
 	*                           changes too frequently to be efficiently cached.
 	* @return bool              True if the value was changed, false otherwise.
 	*/
-	public function set_atomic($key, $old_value, $value, $cache = true)
+	public function set_atomic($key, $old_value, $value, $use_cache = true)
 	{
 		if (!isset($this->config[$key]) || $this->config[$key] == $old_value)
 		{
@@ -155,10 +155,10 @@ class phpbb_config implements ArrayAccess, IteratorAggregate, Countable
 	*
 	* @param string $key       The configuration option's name
 	* @param int    $increment Amount to increment by
-	* @param bool   $cache     Whether this variable should be cached or if it
+	* @param bool   $use_cache Whether this variable should be cached or if it
 	*                          changes too frequently to be efficiently cached.
 	*/
-	function increment($key, $increment, $cache = true)
+	function increment($key, $increment, $use_cache = true)
 	{
 		if (!isset($this->config[$key]))
 		{
diff --git a/phpBB/includes/config/db.php b/phpBB/includes/config/db.php
index f98056e013..a2db4056df 100644
--- a/phpBB/includes/config/db.php
+++ b/phpBB/includes/config/db.php
@@ -93,12 +93,12 @@ class phpbb_config_db extends phpbb_config
 	/**
 	* Removes a configuration option
 	*
-	* @param  String $key   The configuration option's name
-	* @param  bool   $cache Whether this variable should be cached or if it
-	*                       changes too frequently to be efficiently cached
+	* @param  String $key       The configuration option's name
+	* @param  bool   $use_cache Whether this variable should be cached or if it
+	*                           changes too frequently to be efficiently cached
 	* @return void
 	*/
-	public function delete($key, $cache = true)
+	public function delete($key, $use_cache = true)
 	{
 		$sql = 'DELETE FROM ' . $this->table . "
 			WHERE config_name = '" . $this->db->sql_escape($key) . "'";
@@ -106,7 +106,7 @@ class phpbb_config_db extends phpbb_config
 
 		unset($this->config[$key]);
 
-		if ($cache)
+		if ($use_cache)
 		{
 			$this->cache->destroy('config');
 		}
@@ -115,14 +115,14 @@ class phpbb_config_db extends phpbb_config
 	/**
 	* Sets a configuration option's value
 	*
-	* @param string $key   The configuration option's name
-	* @param string $value New configuration value
-	* @param bool   $cache Whether this variable should be cached or if it
-	*                      changes too frequently to be efficiently cached.
+	* @param string $key       The configuration option's name
+	* @param string $value     New configuration value
+	* @param bool   $use_cache Whether this variable should be cached or if it
+	*                          changes too frequently to be efficiently cached.
 	*/
-	public function set($key, $value, $cache = true)
+	public function set($key, $value, $use_cache = true)
 	{
-		$this->set_atomic($key, false, $value, $cache);
+		$this->set_atomic($key, false, $value, $use_cache);
 	}
 
 	/**
@@ -133,11 +133,11 @@ class phpbb_config_db extends phpbb_config
 	* @param  mixed  $old_value Current configuration value or false to ignore
 	*                           the old value
 	* @param  string $new_value New configuration value
-	* @param  bool   $cache     Whether this variable should be cached or if it
+	* @param  bool   $use_cache Whether this variable should be cached or if it
 	*                           changes too frequently to be efficiently cached
 	* @return bool              True if the value was changed, false otherwise
 	*/
-	public function set_atomic($key, $old_value, $new_value, $cache = true)
+	public function set_atomic($key, $old_value, $new_value, $use_cache = true)
 	{
 		$sql = 'UPDATE ' . $this->table . "
 			SET config_value = '" . $this->db->sql_escape($new_value) . "'
@@ -160,11 +160,11 @@ class phpbb_config_db extends phpbb_config
 			$sql = 'INSERT INTO ' . $this->table . ' ' . $this->db->sql_build_array('INSERT', array(
 				'config_name'	=> $key,
 				'config_value'	=> $new_value,
-				'is_dynamic'	=> ($cache) ? 0 : 1));
+				'is_dynamic'	=> ($use_cache) ? 0 : 1));
 			$this->db->sql_query($sql);
 		}
 
-		if ($cache)
+		if ($use_cache)
 		{
 			$this->cache->destroy('config');
 		}
@@ -181,14 +181,14 @@ class phpbb_config_db extends phpbb_config
 	*
 	* @param string $key       The configuration option's name
 	* @param int    $increment Amount to increment by
-	* @param bool   $cache     Whether this variable should be cached or if it
+	* @param bool   $use_cache Whether this variable should be cached or if it
 	*                          changes too frequently to be efficiently cached.
 	*/
-	function increment($key, $increment, $cache = true)
+	function increment($key, $increment, $use_cache = true)
 	{
 		if (!isset($this->config[$key]))
 		{
-			$this->set($key, '0', $cache);
+			$this->set($key, '0', $use_cache);
 		}
 
 		$sql_update = $this->db->cast_expr_to_string($this->db->cast_expr_to_bigint('config_value') . ' + ' . (int) $increment);
@@ -197,7 +197,7 @@ class phpbb_config_db extends phpbb_config
 			SET config_value = ' . $sql_update . "
 			WHERE config_name = '" . $this->db->sql_escape($key) . "'");
 
-		if ($cache)
+		if ($use_cache)
 		{
 			$this->cache->destroy('config');
 		}
-- 
cgit v1.2.1