Mass conversion of all files to the newly agreed coding standard: PSR 1/2

Converting Piwik core source files, PHP, JS, TPL, CSS

More info: http://piwik.org/participate/coding-standards/

1 files changed, 268 insertions, 294 deletions

diff --git a/core/Updater.php b/core/Updater.php
index 47dec55198..1b91f70349 100644
--- a/core/Updater.php
+++ b/core/Updater.php
@@ -1,10 +1,10 @@
 <?php
 /**
  * Piwik - Open source web analytics
- * 
+ *
  * @link http://piwik.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
- * 
+ *
  * @category Piwik
  * @package Piwik
  */
@@ -22,310 +22,282 @@ require_once PIWIK_INCLUDE_PATH . '/core/Option.php';
  */
 class Piwik_Updater
 {
-	const INDEX_CURRENT_VERSION = 0;
-	const INDEX_NEW_VERSION = 1;
-	
-	public $pathUpdateFileCore;
-	public $pathUpdateFilePlugins;
-	private $componentsToCheck = array();
-	private $hasMajorDbUpdate = false;
-	
-	public function __construct()
-	{
-		$this->pathUpdateFileCore = PIWIK_INCLUDE_PATH . '/core/Updates/';
-		$this->pathUpdateFilePlugins = PIWIK_INCLUDE_PATH . '/plugins/%s/Updates/';
-	}
+    const INDEX_CURRENT_VERSION = 0;
+    const INDEX_NEW_VERSION = 1;
+
+    public $pathUpdateFileCore;
+    public $pathUpdateFilePlugins;
+    private $componentsToCheck = array();
+    private $hasMajorDbUpdate = false;
+
+    public function __construct()
+    {
+        $this->pathUpdateFileCore = PIWIK_INCLUDE_PATH . '/core/Updates/';
+        $this->pathUpdateFilePlugins = PIWIK_INCLUDE_PATH . '/plugins/%s/Updates/';
+    }
+
+    /**
+     * Add component to check
+     *
+     * @param string $name
+     * @param string $version
+     */
+    public function addComponentToCheck($name, $version)
+    {
+        $this->componentsToCheck[$name] = $version;
+    }
+
+    /**
+     * Record version of successfully completed component update
+     *
+     * @param string $name
+     * @param string $version
+     */
+    public function recordComponentSuccessfullyUpdated($name, $version)
+    {
+        try {
+            Piwik_SetOption($this->getNameInOptionTable($name), $version, $autoload = 1);
+        } catch (Exception $e) {
+            // case when the option table is not yet created (before 0.2.10)
+        }
+    }
+
+    /**
+     * Returns the flag name to use in the option table to record current schema version
+     * @param string $name
+     * @return string
+     */
+    private function getNameInOptionTable($name)
+    {
+        return 'version_' . $name;
+    }
+
+    /**
+     * Returns a list of components (core | plugin) that need to run through the upgrade process.
+     *
+     * @return array( componentName => array( file1 => version1, [...]), [...])
+     */
+    public function getComponentsWithUpdateFile()
+    {
+        $this->componentsWithNewVersion = $this->getComponentsWithNewVersion();
+        $this->componentsWithUpdateFile = $this->loadComponentsWithUpdateFile();
+        return $this->componentsWithUpdateFile;
+    }
+
+    /**
+     * Component has a new version?
+     *
+     * @param string $componentName
+     * @return bool TRUE if compoment is to be updated; FALSE if not
+     */
+    public function hasNewVersion($componentName)
+    {
+        return isset($this->componentsWithNewVersion) &&
+            isset($this->componentsWithNewVersion[$componentName]);
+    }
 
-	/**
-	 * Add component to check
-	 *
-	 * @param string $name
-	 * @param string $version
-	 */
-	public function addComponentToCheck($name, $version)
-	{
-		$this->componentsToCheck[$name] = $version;
-	}
-	
-	/**
-	 * Record version of successfully completed component update
-	 *
-	 * @param string $name
-	 * @param string $version
-	 */
-	public function recordComponentSuccessfullyUpdated($name, $version)
-	{
-		try {
-			Piwik_SetOption($this->getNameInOptionTable($name), $version, $autoload = 1);
-		} catch(Exception $e) {
-			// case when the option table is not yet created (before 0.2.10)
-		}
-	}
-	
-	/**
-	 * Returns the flag name to use in the option table to record current schema version
-	 * @param string $name
-	 * @return string
-	 */
-	private function getNameInOptionTable($name)
-	{
-		return 'version_'.$name;
-	}
-	
-	/**
-	 * Returns a list of components (core | plugin) that need to run through the upgrade process.
-	 *
-	 * @return array( componentName => array( file1 => version1, [...]), [...])
-	 */
-	public function getComponentsWithUpdateFile()
-	{
-		$this->componentsWithNewVersion = $this->getComponentsWithNewVersion();
-		$this->componentsWithUpdateFile = $this->loadComponentsWithUpdateFile();
-		return $this->componentsWithUpdateFile;
-	}
+    /**
+     * Does one of the new versions involve a major database update?
+     * Note: getSqlQueriesToExecute() must be called before this method!
+     *
+     * @return bool
+     */
+    public function hasMajorDbUpdate()
+    {
+        return $this->hasMajorDbUpdate;
+    }
 
-	/**
-	 * Component has a new version?
-	 *
-	 * @param string $componentName
-	 * @return bool TRUE if compoment is to be updated; FALSE if not
-	 */
-	public function hasNewVersion($componentName)
-	{
-		return isset($this->componentsWithNewVersion) &&
-			isset($this->componentsWithNewVersion[$componentName]);
-	}
+    /**
+     * Returns the list of SQL queries that would be executed during the update
+     *
+     * @return array of SQL queries
+     */
+    public function getSqlQueriesToExecute()
+    {
+        $queries = array();
+        foreach ($this->componentsWithUpdateFile as $componentName => $componentUpdateInfo) {
+            foreach ($componentUpdateInfo as $file => $fileVersion) {
+                require_once $file; // prefixed by PIWIK_INCLUDE_PATH
 
-	/**
-	 * Does one of the new versions involve a major database update?
-	 * Note: getSqlQueriesToExecute() must be called before this method!
-	 * 
-	 * @return bool
-	 */
-	public function hasMajorDbUpdate()
-	{
-		return $this->hasMajorDbUpdate;
-	}
+                $className = $this->getUpdateClassName($componentName, $fileVersion);
+                if (class_exists($className, false)) {
+                    $queriesForComponent = call_user_func(array($className, 'getSql'));
+                    foreach ($queriesForComponent as $query => $error) {
+                        $queries[] = $query . ';';
+                    }
 
-	/**
-	 * Returns the list of SQL queries that would be executed during the update
-	 * 
-	 * @return array of SQL queries 
-	 */
-	public function getSqlQueriesToExecute()
-	{
-		$queries = array();
-		foreach($this->componentsWithUpdateFile as $componentName => $componentUpdateInfo) 
-		{
-			foreach($componentUpdateInfo as $file => $fileVersion)
-			{
-				require_once $file; // prefixed by PIWIK_INCLUDE_PATH
+                    $this->hasMajorDbUpdate = $this->hasMajorDbUpdate || call_user_func(array($className, 'isMajorUpdate'));
+                }
+            }
+            // unfortunately had to extract this query from the Piwik_Option class
+            $queries[] = 'UPDATE `' . Piwik_Common::prefixTable('option') . '`
+    				SET option_value = \'' . $fileVersion . '\'
+    				WHERE option_name = \'' . $this->getNameInOptionTable($componentName) . '\';';
+        }
+        return $queries;
+    }
 
-				$className = $this->getUpdateClassName($componentName, $fileVersion);
-				if(class_exists($className, false))
-				{
-					$queriesForComponent = call_user_func( array($className, 'getSql'));
-					foreach($queriesForComponent as $query => $error) {
-						$queries[] = $query.';';
-					}
-					
-					$this->hasMajorDbUpdate = $this->hasMajorDbUpdate || call_user_func( array($className, 'isMajorUpdate'));
-				}
-			}
-			// unfortunately had to extract this query from the Piwik_Option class
-    		$queries[] = 'UPDATE `'.Piwik_Common::prefixTable('option').'`
-    				SET option_value = \'' .$fileVersion.'\' 
-    				WHERE option_name = \''. $this->getNameInOptionTable($componentName).'\';';
-		}
-		return $queries;
-	}
-	
-	private function getUpdateClassName($componentName, $fileVersion)
-	{
-		$suffix = strtolower(str_replace(array('-','.'), '_', $fileVersion));
-		if($componentName == 'core')
-		{
-			return 'Piwik_Updates_' . $suffix;
-		}
-		return 'Piwik_'. $componentName .'_Updates_' . $suffix;
-	}
+    private function getUpdateClassName($componentName, $fileVersion)
+    {
+        $suffix = strtolower(str_replace(array('-', '.'), '_', $fileVersion));
+        if ($componentName == 'core') {
+            return 'Piwik_Updates_' . $suffix;
+        }
+        return 'Piwik_' . $componentName . '_Updates_' . $suffix;
+    }
 
-	/**
-	 * Update the named component
-	 *
-	 * @param string $componentName 'core', or plugin name
-	 * @throws Exception|Piwik_Updater_UpdateErrorException
-	 * @return array of warning strings if applicable
-	 */
-	public function update($componentName)
-	{
-		$warningMessages = array();
-		foreach($this->componentsWithUpdateFile[$componentName] as $file => $fileVersion)
-		{
-			try {
-				require_once $file; // prefixed by PIWIK_INCLUDE_PATH
+    /**
+     * Update the named component
+     *
+     * @param string $componentName 'core', or plugin name
+     * @throws Exception|Piwik_Updater_UpdateErrorException
+     * @return array of warning strings if applicable
+     */
+    public function update($componentName)
+    {
+        $warningMessages = array();
+        foreach ($this->componentsWithUpdateFile[$componentName] as $file => $fileVersion) {
+            try {
+                require_once $file; // prefixed by PIWIK_INCLUDE_PATH
 
-				$className = $this->getUpdateClassName($componentName, $fileVersion);
-				if(class_exists($className, false))
-				{
-					call_user_func( array($className, 'update') );
-				}
+                $className = $this->getUpdateClassName($componentName, $fileVersion);
+                if (class_exists($className, false)) {
+                    call_user_func(array($className, 'update'));
+                }
 
-				$this->recordComponentSuccessfullyUpdated($componentName, $fileVersion);
-			} catch( Piwik_Updater_UpdateErrorException $e) {
-				throw $e;
-			} catch( Exception $e) {
-				$warningMessages[] = $e->getMessage();
-			}
-		}
-		
-		// to debug, create core/Updates/X.php, update the core/Version.php, throw an Exception in the try, and comment the following line
-		$this->recordComponentSuccessfullyUpdated($componentName, $this->componentsWithNewVersion[$componentName][self::INDEX_NEW_VERSION]);
-		return $warningMessages;
-	}
+                $this->recordComponentSuccessfullyUpdated($componentName, $fileVersion);
+            } catch (Piwik_Updater_UpdateErrorException $e) {
+                throw $e;
+            } catch (Exception $e) {
+                $warningMessages[] = $e->getMessage();
+            }
+        }
 
-	/**
-	 * Construct list of update files for the outdated components
-	 *
-	 * @return array( componentName => array( file1 => version1, [...]), [...])
-	 */
-	private function loadComponentsWithUpdateFile()
-	{
-		$componentsWithUpdateFile = array();
-		foreach($this->componentsWithNewVersion as $name => $versions)
-		{
-			$currentVersion = $versions[self::INDEX_CURRENT_VERSION];
-			$newVersion = $versions[self::INDEX_NEW_VERSION];
-			
-			if($name == 'core')
-			{
-				$pathToUpdates = $this->pathUpdateFileCore . '*.php';
-			}
-			else
-			{
-				$pathToUpdates = sprintf($this->pathUpdateFilePlugins, $name) . '*.php';
-			}
-			
-			$files = _glob( $pathToUpdates );
-			if($files == false)
-			{
-				$files = array();
-			}
+        // to debug, create core/Updates/X.php, update the core/Version.php, throw an Exception in the try, and comment the following line
+        $this->recordComponentSuccessfullyUpdated($componentName, $this->componentsWithNewVersion[$componentName][self::INDEX_NEW_VERSION]);
+        return $warningMessages;
+    }
 
-			foreach( $files as $file)
-			{
-				$fileVersion = basename($file, '.php');
-				if( // if the update is from a newer version
-					version_compare($currentVersion, $fileVersion) == -1
-					// but we don't execute updates from non existing future releases 
-					&& version_compare($fileVersion, $newVersion) <= 0)
-				{
-					$componentsWithUpdateFile[$name][$file] = $fileVersion;
-				}
-			}
-			
-			if(isset($componentsWithUpdateFile[$name]))
-			{
-				// order the update files by version asc
-				uasort($componentsWithUpdateFile[$name], "version_compare");
-			}
-			else
-			{
-				// there are no update file => nothing to do, update to the new version is successful
-				$this->recordComponentSuccessfullyUpdated($name, $newVersion);
-			}
-		}
-		return $componentsWithUpdateFile;
-	}
+    /**
+     * Construct list of update files for the outdated components
+     *
+     * @return array( componentName => array( file1 => version1, [...]), [...])
+     */
+    private function loadComponentsWithUpdateFile()
+    {
+        $componentsWithUpdateFile = array();
+        foreach ($this->componentsWithNewVersion as $name => $versions) {
+            $currentVersion = $versions[self::INDEX_CURRENT_VERSION];
+            $newVersion = $versions[self::INDEX_NEW_VERSION];
 
-	/**
-	 * Construct list of outdated components
-	 *
-	 * @throws Exception
-	 * @return array array( componentName => array( oldVersion, newVersion), [...])
-	 */
-	public function getComponentsWithNewVersion()
-	{
-		$componentsToUpdate = array();
-		
-		// we make sure core updates are processed before any plugin updates
-		if(isset($this->componentsToCheck['core']))
-		{
-			$coreVersions = $this->componentsToCheck['core'];
-			unset($this->componentsToCheck['core']);
-			$this->componentsToCheck = array_merge( array('core' => $coreVersions), $this->componentsToCheck);
-		}
-		
-		foreach($this->componentsToCheck as $name => $version)
-		{
-			try {
-				$currentVersion = Piwik_GetOption('version_'.$name);
-			} catch( Exception $e) {
-				// mysql error 1146: table doesn't exist
-				if(Zend_Registry::get('db')->isErrNo($e, '1146'))
-				{
-					// case when the option table is not yet created (before 0.2.10)
-					$currentVersion = false;
-				}
-				else
-				{
-					// failed for some other reason
-					throw $e;
-				}
-			}
-			if($currentVersion === false)
-			{
-				if($name === 'core')
-				{
-					// This should not happen
-					$currentVersion = Piwik_Version::VERSION;
-				}
-				else
-				{
-					$currentVersion = '0.0.1';
-				}
-				$this->recordComponentSuccessfullyUpdated($name, $currentVersion);
-			}
+            if ($name == 'core') {
+                $pathToUpdates = $this->pathUpdateFileCore . '*.php';
+            } else {
+                $pathToUpdates = sprintf($this->pathUpdateFilePlugins, $name) . '*.php';
+            }
 
-			$versionCompare = version_compare($currentVersion, $version);
-			if($versionCompare == -1)
-			{
-				$componentsToUpdate[$name] = array(
-								self::INDEX_CURRENT_VERSION => $currentVersion, 
-								self::INDEX_NEW_VERSION => $version
-							);
-			}
-			else if($versionCompare == 1) 
-			{
-				// the version in the DB is newest.. we choose to ignore (for the time being)
-			}
-		}
-		return $componentsToUpdate;
-	}
+            $files = _glob($pathToUpdates);
+            if ($files == false) {
+                $files = array();
+            }
 
-	/**
-	 * Performs database update(s)
-	 *
-	 * @param string $file Update script filename
-	 * @param array $sqlarray An array of SQL queries to be executed
-	 * @throws Piwik_Updater_UpdateErrorException
-	 */
-	static function updateDatabase($file, $sqlarray)
-	{
-		foreach($sqlarray as $update => $ignoreError)
-		{
-			try {
-				Piwik_Exec( $update );
-			} catch(Exception $e) {
-				if(($ignoreError === false) 
-					|| !Zend_Registry::get('db')->isErrNo($e, $ignoreError))
-				{
-					$message =  $file .":\nError trying to execute the query '". $update ."'.\nThe error was: ". $e->getMessage();
-					throw new Piwik_Updater_UpdateErrorException($message);
-				}
-			}
-		}
-	}
+            foreach ($files as $file) {
+                $fileVersion = basename($file, '.php');
+                if ( // if the update is from a newer version
+                    version_compare($currentVersion, $fileVersion) == -1
+                    // but we don't execute updates from non existing future releases
+                    && version_compare($fileVersion, $newVersion) <= 0
+                ) {
+                    $componentsWithUpdateFile[$name][$file] = $fileVersion;
+                }
+            }
+
+            if (isset($componentsWithUpdateFile[$name])) {
+                // order the update files by version asc
+                uasort($componentsWithUpdateFile[$name], "version_compare");
+            } else {
+                // there are no update file => nothing to do, update to the new version is successful
+                $this->recordComponentSuccessfullyUpdated($name, $newVersion);
+            }
+        }
+        return $componentsWithUpdateFile;
+    }
+
+    /**
+     * Construct list of outdated components
+     *
+     * @throws Exception
+     * @return array array( componentName => array( oldVersion, newVersion), [...])
+     */
+    public function getComponentsWithNewVersion()
+    {
+        $componentsToUpdate = array();
+
+        // we make sure core updates are processed before any plugin updates
+        if (isset($this->componentsToCheck['core'])) {
+            $coreVersions = $this->componentsToCheck['core'];
+            unset($this->componentsToCheck['core']);
+            $this->componentsToCheck = array_merge(array('core' => $coreVersions), $this->componentsToCheck);
+        }
+
+        foreach ($this->componentsToCheck as $name => $version) {
+            try {
+                $currentVersion = Piwik_GetOption('version_' . $name);
+            } catch (Exception $e) {
+                // mysql error 1146: table doesn't exist
+                if (Zend_Registry::get('db')->isErrNo($e, '1146')) {
+                    // case when the option table is not yet created (before 0.2.10)
+                    $currentVersion = false;
+                } else {
+                    // failed for some other reason
+                    throw $e;
+                }
+            }
+            if ($currentVersion === false) {
+                if ($name === 'core') {
+                    // This should not happen
+                    $currentVersion = Piwik_Version::VERSION;
+                } else {
+                    $currentVersion = '0.0.1';
+                }
+                $this->recordComponentSuccessfullyUpdated($name, $currentVersion);
+            }
+
+            $versionCompare = version_compare($currentVersion, $version);
+            if ($versionCompare == -1) {
+                $componentsToUpdate[$name] = array(
+                    self::INDEX_CURRENT_VERSION => $currentVersion,
+                    self::INDEX_NEW_VERSION     => $version
+                );
+            } else if ($versionCompare == 1) {
+                // the version in the DB is newest.. we choose to ignore (for the time being)
+            }
+        }
+        return $componentsToUpdate;
+    }
+
+    /**
+     * Performs database update(s)
+     *
+     * @param string $file Update script filename
+     * @param array $sqlarray An array of SQL queries to be executed
+     * @throws Piwik_Updater_UpdateErrorException
+     */
+    static function updateDatabase($file, $sqlarray)
+    {
+        foreach ($sqlarray as $update => $ignoreError) {
+            try {
+                Piwik_Exec($update);
+            } catch (Exception $e) {
+                if (($ignoreError === false)
+                    || !Zend_Registry::get('db')->isErrNo($e, $ignoreError)
+                ) {
+                    $message = $file . ":\nError trying to execute the query '" . $update . "'.\nThe error was: " . $e->getMessage();
+                    throw new Piwik_Updater_UpdateErrorException($message);
+                }
+            }
+        }
+    }
 }
 
 /**
@@ -334,4 +306,6 @@ class Piwik_Updater
  * @package Piwik
  * @subpackage Piwik_Updater
  */
-class Piwik_Updater_UpdateErrorException extends Exception {}
+class Piwik_Updater_UpdateErrorException extends Exception
+{
+}