EGroupware / egroupware

api/src/Cache/Memcache.php

Braces +9 added lines, -2 removed lines

@@ -14,7 +14,10 @@ 
 namespace EGroupware\Api\Cache;
 
 // fix warning in tests, if memcache extension not available
-if (defined('MEMCACHE_COMPRESSED')) define('MEMCACHE_COMPRESSED', 2);
+if (defined('MEMCACHE_COMPRESSED'))
+{
+	define('MEMCACHE_COMPRESSED', 2);
+}
 
 /**
  * Caching provider storing data in memcached via PHP's memcache extension
@@ -62,7 +65,11 @@ 
 		check_load_extension('memcache',true);
 		$this->memcache = new \Memcache();
 
-		if (!$params) $params = array('localhost');	// some reasonable default
+		if (!$params)
+		{
+			$params = array('localhost');
+		}
+		// some reasonable default
 
 		$ok = false;
 		foreach($params as $host_port)

api/src/Cache.php

Spacing +71 added lines, -74 removed lines

@@ -82,7 +82,7 @@ 
 	 *
 	 * @var array
 	 */
-	static $default_provider;	// = array('EGroupware\Api\Cache\Files');// array('EGroupware\Api\Cache\Memcache','localhost');
+	static $default_provider; // = array('EGroupware\Api\Cache\Files');// array('EGroupware\Api\Cache\Memcache','localhost');
 
 	/**
 	 * Maximum expiration time, if set unlimited expiration (=0) or bigger expiration times are replaced with that time
@@ -108,10 +108,10 @@ 
 	 * @param int $expiration =0 expiration time in seconds, default 0 = never
 	 * @return boolean true if data could be stored, false otherwise incl. key already existed
 	 */
-	static public function addCache($level,$app,$location,$data,$expiration=0)
+	static public function addCache($level, $app, $location, $data, $expiration = 0)
 	{
 		//error_log(__METHOD__."('$level','$app','$location',".array2string($data).",$expiration)");
-		switch($level)
+		switch ($level)
 		{
 			case self::SESSION:
 			case self::REQUEST:
@@ -129,7 +129,7 @@ 
 				{
 					$expiration = self::$max_expiration;
 				}
-				return $provider->add(self::keys($level,$app,$location),$data,$expiration);
+				return $provider->add(self::keys($level, $app, $location), $data, $expiration);
 		}
 		throw new Exception\WrongParameter(__METHOD__."() unknown level '$level'!");
 	}
@@ -144,14 +144,14 @@ 
 	 * @param int $expiration =0 expiration time in seconds, default 0 = never
 	 * @return boolean true if data could be stored, false otherwise
 	 */
-	static public function setCache($level,$app,$location,$data,$expiration=0)
+	static public function setCache($level, $app, $location, $data, $expiration = 0)
 	{
 		//error_log(__METHOD__."('$level','$app','$location',".array2string($data).",$expiration)");
-		switch($level)
+		switch ($level)
 		{
 			case self::SESSION:
 			case self::REQUEST:
-				return call_user_func(array(__CLASS__,'set'.$level),$app,$location,$data,$expiration);
+				return call_user_func(array(__CLASS__, 'set'.$level), $app, $location, $data, $expiration);
 
 			case self::INSTANCE:
 			case self::TREE:
@@ -165,7 +165,7 @@ 
 				{
 					$expiration = self::$max_expiration;
 				}
-				return $provider->set(self::keys($level,$app,$location),$data,$expiration);
+				return $provider->set(self::keys($level, $app, $location), $data, $expiration);
 		}
 		throw new Exception\WrongParameter(__METHOD__."() unknown level '$level'!");
 	}
@@ -182,15 +182,15 @@ 
 	 * @return mixed NULL if data not found in cache (and no callback specified) or
 	 * 	if $location is an array: location => data pairs for existing location-data, non-existing is not returned
 	 */
-	static public function getCache($level,$app,$location,$callback=null,array $callback_params=array(),$expiration=0)
+	static public function getCache($level, $app, $location, $callback = null, array $callback_params = array(), $expiration = 0)
 	{
-		switch($level)
+		switch ($level)
 		{
 			case self::SESSION:
 			case self::REQUEST:
-				foreach((array)$location as $l)
+				foreach ((array)$location as $l)
 				{
-					$data[$l] = call_user_func(array(__CLASS__,'get'.$level),$app,$l,$callback,$callback_params,$expiration);
+					$data[$l] = call_user_func(array(__CLASS__, 'get'.$level), $app, $l, $callback, $callback_params, $expiration);
 				}
 				return is_array($location) ? $data : $data[$l];
 
@@ -210,34 +210,34 @@ 
 						}
 						if (is_a($provider, 'EGroupware\Api\Cache\ProviderMultiple'))
 						{
-							$data = $provider->mget($keys=self::keys($level,$app,$location));
+							$data = $provider->mget($keys = self::keys($level, $app, $location));
 						}
 						else	// default implementation calls get multiple times
 						{
 							$data = array();
-							foreach($location as $l)
+							foreach ($location as $l)
 							{
-								$data[$l] = $provider->get($keys=self::keys($level,$app,$l));
+								$data[$l] = $provider->get($keys = self::keys($level, $app, $l));
 								if (!isset($data[$l])) unset($data[$l]);
 							}
 						}
 					}
 					else
 					{
-						$data = $provider->get($keys=self::keys($level,$app,$location));
+						$data = $provider->get($keys = self::keys($level, $app, $location));
 						if (is_null($data) && !is_null($callback))
 						{
-							$data = call_user_func_array($callback,$callback_params);
+							$data = call_user_func_array($callback, $callback_params);
 							// limit expiration to configured maximum time
 							if (isset(self::$max_expiration) && (!$expiration || $expiration > self::$max_expiration))
 							{
 								$expiration = self::$max_expiration;
 							}
-							$provider->set($keys,$data,$expiration);
+							$provider->set($keys, $data, $expiration);
 						}
 					}
 				}
-				catch(Exception $e) {
+				catch (Exception $e) {
 					unset($e);
 					$data = null;
 				}
@@ -254,13 +254,13 @@ 
 	 * @param string $location location name for data
 	 * @return boolean true if data was set, false if not (like isset())
 	 */
-	static public function unsetCache($level,$app,$location)
+	static public function unsetCache($level, $app, $location)
 	{
-		switch($level)
+		switch ($level)
 		{
 			case self::SESSION:
 			case self::REQUEST:
-				return call_user_func(array(__CLASS__,'unset'.$level),$app,$location);
+				return call_user_func(array(__CLASS__, 'unset'.$level), $app, $location);
 
 			case self::INSTANCE:
 			case self::TREE:
@@ -269,7 +269,7 @@ 
 				{
 					return false;
 				}
-				return $provider->delete(self::keys($level,$app,$location));
+				return $provider->delete(self::keys($level, $app, $location));
 		}
 		throw new Exception\WrongParameter(__METHOD__."() unknown level '$level'!");
 	}
@@ -283,10 +283,10 @@ 
 	 * @param int $expiration =0 expiration time in seconds, default 0 = never
 	 * @return boolean true if data could be stored, false otherwise
 	 */
-	static public function setTree($app,$location,$data,$expiration=0)
+	static public function setTree($app, $location, $data, $expiration = 0)
 	{
 		//error_log(__METHOD__."('$app','$location',".array2string($data).",$expiration)");
-		return self::setCache(self::TREE,$app,$location,$data,$expiration);
+		return self::setCache(self::TREE, $app, $location, $data, $expiration);
 	}
 
 	/**
@@ -299,9 +299,9 @@ 
 	 * @param int $expiration =0 expiration time in seconds, default 0 = never
 	 * @return mixed NULL if data not found in cache (and no callback specified)
 	 */
-	static public function getTree($app,$location,$callback=null,array $callback_params=array(),$expiration=0)
+	static public function getTree($app, $location, $callback = null, array $callback_params = array(), $expiration = 0)
 	{
-		return self::getCache(self::TREE,$app,$location,$callback,$callback_params,$expiration);
+		return self::getCache(self::TREE, $app, $location, $callback, $callback_params, $expiration);
 	}
 
 	/**
@@ -311,9 +311,9 @@ 
 	 * @param string $location location name for data
 	 * @return boolean true if data was set, false if not (like isset())
 	 */
-	static public function unsetTree($app,$location)
+	static public function unsetTree($app, $location)
 	{
-		return self::unsetCache(self::TREE,$app,$location);
+		return self::unsetCache(self::TREE, $app, $location);
 	}
 
 	/**
@@ -325,9 +325,9 @@ 
 	 * @param int $expiration =0 expiration time in seconds, default 0 = never
 	 * @return boolean true if data could be stored, false otherwise
 	 */
-	static public function setInstance($app,$location,$data,$expiration=0)
+	static public function setInstance($app, $location, $data, $expiration = 0)
 	{
-		return self::setCache(self::INSTANCE,$app,$location,$data,$expiration);
+		return self::setCache(self::INSTANCE, $app, $location, $data, $expiration);
 	}
 
 	/**
@@ -340,9 +340,9 @@ 
 	 * @param int $expiration =0 expiration time in seconds, default 0 = never
 	 * @return mixed NULL if data not found in cache (and no callback specified)
 	 */
-	static public function getInstance($app,$location,$callback=null,array $callback_params=array(),$expiration=0)
+	static public function getInstance($app, $location, $callback = null, array $callback_params = array(), $expiration = 0)
 	{
-		return self::getCache(self::INSTANCE,$app,$location,$callback,$callback_params,$expiration);
+		return self::getCache(self::INSTANCE, $app, $location, $callback, $callback_params, $expiration);
 	}
 
 	/**
@@ -352,9 +352,9 @@ 
 	 * @param string $location location name for data
 	 * @return boolean true if data was set, false if not (like isset())
 	 */
-	static public function unsetInstance($app,$location)
+	static public function unsetInstance($app, $location)
 	{
-		return self::unsetCache(self::INSTANCE,$app,$location);
+		return self::unsetCache(self::INSTANCE, $app, $location);
 	}
 
 	/**
@@ -371,18 +371,18 @@ 
 	 * @param int $expiration =0 expiration time in seconds, default 0 = never
 	 * @return boolean true if data could be stored, false otherwise
 	 */
-	static public function setSession($app,$location,$data,$expiration=0)
+	static public function setSession($app, $location, $data, $expiration = 0)
 	{
 		if (isset($_SESSION[Session::EGW_SESSION_ENCRYPTED]))
 		{
 			if (Session::ERROR_LOG_DEBUG) error_log(__METHOD__.' called after session was encrypted --> ignored!');
-			return false;	// can no longer store something in the session, eg. because commit_session() was called
+			return false; // can no longer store something in the session, eg. because commit_session() was called
 		}
 		$_SESSION[Session::EGW_APPSESSION_VAR][$app][$location] = $data;
 
 		if ($expiration > 0)
 		{
-			$_SESSION[Session::EGW_APPSESSION_VAR][self::SESSION_EXPIRATION_PREFIX.$app][$location] = time()+$expiration;
+			$_SESSION[Session::EGW_APPSESSION_VAR][self::SESSION_EXPIRATION_PREFIX.$app][$location] = time() + $expiration;
 		}
 
 		return true;
@@ -400,12 +400,12 @@ 
 	 * @param int $expiration =0 expiration time in seconds, default 0 = never
 	 * @return mixed NULL if data not found in cache (and no callback specified)
 	 */
-	static public function &getSession($app,$location,$callback=null,array $callback_params=array(),$expiration=0)
+	static public function &getSession($app, $location, $callback = null, array $callback_params = array(), $expiration = 0)
 	{
 		if (isset($_SESSION[Session::EGW_SESSION_ENCRYPTED]))
 		{
 			if (Session::ERROR_LOG_DEBUG) error_log(__METHOD__.' called after session was encrypted --> ignored!');
-			return null;	// can no longer store something in the session, eg. because commit_session() was called
+			return null; // can no longer store something in the session, eg. because commit_session() was called
 		}
 		// check if entry is expired and clean it up in that case
 		if (isset($_SESSION[Session::EGW_APPSESSION_VAR][self::SESSION_EXPIRATION_PREFIX.$app][$location]) &&
@@ -416,7 +416,7 @@ 
 		}
 		if (!isset($_SESSION[Session::EGW_APPSESSION_VAR][$app][$location]) && !is_null($callback))
 		{
-			$_SESSION[Session::EGW_APPSESSION_VAR][$app][$location] = call_user_func_array($callback,$callback_params);
+			$_SESSION[Session::EGW_APPSESSION_VAR][$app][$location] = call_user_func_array($callback, $callback_params);
 		}
 		return $_SESSION[Session::EGW_APPSESSION_VAR][$app][$location];
 	}
@@ -428,12 +428,12 @@ 
 	 * @param string $location location name for data
 	 * @return boolean true if data was set, false if not (like isset())
 	 */
-	static public function unsetSession($app,$location)
+	static public function unsetSession($app, $location)
 	{
 		if (isset($_SESSION[Session::EGW_SESSION_ENCRYPTED]))
 		{
 			if (Session::ERROR_LOG_DEBUG) error_log(__METHOD__.' called after session was encrypted --> ignored!');
-			return false;	// can no longer store something in the session, eg. because commit_session() was called
+			return false; // can no longer store something in the session, eg. because commit_session() was called
 		}
 		// check if entry is expired and clean it up in that case
 		if (isset($_SESSION[Session::EGW_APPSESSION_VAR][self::SESSION_EXPIRATION_PREFIX.$app][$location]) &&
@@ -467,9 +467,9 @@ 
 	 * @param int $expiration =0 expiration time is NOT used for REQUEST!
 	 * @return boolean true if data could be stored, false otherwise
 	 */
-	static public function setRequest($app,$location,$data,$expiration=0)
+	static public function setRequest($app, $location, $data, $expiration = 0)
 	{
-		unset($expiration);	// not used, but required by function signature
+		unset($expiration); // not used, but required by function signature
 		self::$request_cache[$app][$location] = $data;
 
 		return true;
@@ -485,12 +485,12 @@ 
 	 * @param int $expiration =0 expiration time is NOT used for REQUEST!
 	 * @return mixed NULL if data not found in cache (and no callback specified)
 	 */
-	static public function getRequest($app,$location,$callback=null,array $callback_params=array(),$expiration=0)
+	static public function getRequest($app, $location, $callback = null, array $callback_params = array(), $expiration = 0)
 	{
-		unset($expiration);	// not used, but required by function signature
+		unset($expiration); // not used, but required by function signature
 		if (!isset(self::$request_cache[$app][$location]) && !is_null($callback))
 		{
-			self::$request_cache[$app][$location] = call_user_func_array($callback,$callback_params);
+			self::$request_cache[$app][$location] = call_user_func_array($callback, $callback_params);
 		}
 		return self::$request_cache[$app][$location];
 	}
@@ -502,7 +502,7 @@ 
 	 * @param string $location location name for data
 	 * @return boolean true if data was set, false if not (like isset())
 	 */
-	static public function unsetRequest($app,$location)
+	static public function unsetRequest($app, $location)
 	{
 		if (!isset(self::$request_cache[$app][$location]))
 		{
@@ -522,7 +522,7 @@ 
 	 * @param boolean $log_not_found =true false do not log if no provider found, used eg. to supress error via unsetCache during installation
 	 * @return Api\Cache\Provider
 	 */
-	static protected function get_provider($level, $log_not_found=true)
+	static protected function get_provider($level, $log_not_found = true)
 	{
 		static $providers = array();
 
@@ -543,13 +543,13 @@ 
 				}
 				else
 				{
-					$providers[$level] = false;	// no provider specified
+					$providers[$level] = false; // no provider specified
 					$reason = 'no provider specified';
 				}
 			}
 			elseif (!$params)
 			{
-					$providers[$level] = false;	// cache for $level disabled
+					$providers[$level] = false; // cache for $level disabled
 					$reason = "cache for $level disabled";
 			}
 			else
@@ -559,7 +559,7 @@ 
 				$class = array_shift($params);
 				if (!class_exists($class))
 				{
-					$providers[$level] = false;	// provider class not found
+					$providers[$level] = false; // provider class not found
 					$reason = "provider $class not found";
 				}
 				else
@@ -568,9 +568,9 @@ 
 					{
 						$providers[$level] = new $class($params);
 					}
-					catch(Exception $e)
+					catch (Exception $e)
 					{
-						$providers[$level] = false;	// eg. could not open connection to backend
+						$providers[$level] = false; // eg. could not open connection to backend
 						$reason = "error instanciating provider $class: ".$e->getMessage();
 					}
 				}
@@ -587,7 +587,7 @@ 
 	 * @param string $level
 	 * @return string class-name of provider
 	 */
-	public static function getProvider($level=self::INSTANCE)
+	public static function getProvider($level = self::INSTANCE)
 	{
 		$provider = self::get_provider($level);
 
@@ -601,35 +601,35 @@ 
 	 * @param boolean $throw =true throw an exception, if we can't retriev the value
 	 * @return string|boolean string with config or false if not found and !$throw
 	 */
-	static public function get_system_config($name,$throw=true)
+	static public function get_system_config($name, $throw = true)
 	{
-		if(!isset($GLOBALS['egw_info']['server'][$name]))
+		if (!isset($GLOBALS['egw_info']['server'][$name]))
 		{
 			if (isset($GLOBALS['egw_setup']) && isset($GLOBALS['egw_setup']->db) || $GLOBALS['egw']->db)
 			{
 				$db = $GLOBALS['egw']->db ? $GLOBALS['egw']->db : $GLOBALS['egw_setup']->db;
 
 				try {
-					if (($rs = $db->select(Config::TABLE,'config_value',array(
+					if (($rs = $db->select(Config::TABLE, 'config_value', array(
 						'config_app'	=> 'phpgwapi',
 						'config_name'	=> $name,
-					),__LINE__,__FILE__)))
+					), __LINE__, __FILE__)))
 					{
 						$GLOBALS['egw_info']['server'][$name] = $rs->fetchColumn();
 					}
 					else
 					{
-						error_log(__METHOD__."('$name', $throw) config value NOT found!");//.function_backtrace());
+						error_log(__METHOD__."('$name', $throw) config value NOT found!"); //.function_backtrace());
 					}
 				}
-				catch(Db\Exception $e)
+				catch (Db\Exception $e)
 				{
-					if ($throw) error_log(__METHOD__."('$name', $throw) cound NOT query value: ".$e->getMessage());//.function_backtrace());
+					if ($throw) error_log(__METHOD__."('$name', $throw) cound NOT query value: ".$e->getMessage()); //.function_backtrace());
 				}
 			}
 			if (!$GLOBALS['egw_info']['server'][$name] && $throw)
 			{
-				throw new Exception (__METHOD__."($name) \$GLOBALS['egw_info']['server']['$name'] is NOT set!");
+				throw new Exception(__METHOD__."($name) \$GLOBALS['egw_info']['server']['$name'] is NOT set!");
 			}
 		}
 		return $GLOBALS['egw_info']['server'][$name];
@@ -641,7 +641,7 @@ 
 	 * @param string $level =self::INSTANCE
 	 * @param string $app =null app-name or "all" to empty complete cache
 	 */
-	static public function flush($level=self::INSTANCE, $app=null)
+	static public function flush($level = self::INSTANCE, $app = null)
 	{
 		$ret = true;
 		if (!($provider = self::get_provider($level)))
@@ -688,7 +688,7 @@ 
 	 * @param string $install_id =null default use install_id of current instance
 	 * @return string new key also stored in self::$instance_key
 	 */
-	static public function generate_instance_key($install_id=null)
+	static public function generate_instance_key($install_id = null)
 	{
 		if (!isset($install_id))
 		{
@@ -710,18 +710,18 @@ 
 	 * @param string $location =null
 	 * @return array
 	 */
-	static public function keys($level, $app=null, $location=null)
+	static public function keys($level, $app = null, $location = null)
 	{
 		static $tree_key = null;
 
-		switch($level)
+		switch ($level)
 		{
 			case self::TREE:
 				if (!isset($tree_key))
 				{
-					$tree_key = $level.'-'.str_replace(array(':','/','\\'),'-', self::$egw_server_root);
+					$tree_key = $level.'-'.str_replace(array(':', '/', '\\'), '-', self::$egw_server_root);
 					// add charset to key, if not utf-8 (as everything we store depends on charset!)
-					if (($charset = self::get_system_config('system_charset',false)) && $charset != 'utf-8')
+					if (($charset = self::get_system_config('system_charset', false)) && $charset != 'utf-8')
 					{
 						$tree_key .= '-'.$charset;
 					}
@@ -769,10 +769,7 @@ 
 if (is_null(Cache::$default_provider))
 {
 	Cache::$default_provider =
-		PHP_SAPI === 'cli' ? 'EGroupware\Api\Cache\Files' :
-			(function_exists('apcu_fetch') && Cache\Apcu::available() ? 'EGroupware\Api\Cache\Apcu' :
-				(function_exists('apc_fetch') && Cache\Apc::available() ? 'EGroupware\Api\Cache\Apc' :
-					'EGroupware\Api\Cache\Files'));
+		PHP_SAPI === 'cli' ? 'EGroupware\Api\Cache\Files' : (function_exists('apcu_fetch') && Cache\Apcu::available() ? 'EGroupware\Api\Cache\Apcu' : (function_exists('apc_fetch') && Cache\Apc::available() ? 'EGroupware\Api\Cache\Apc' : 'EGroupware\Api\Cache\Files'));
 }
 
 //error_log('Cache::$default_provider='.array2string(Cache::$default_provider));