pradosoft / prado

framework/Web/Services/TJsonService.php

Doc Comments +1 added lines

@@ -140,6 +140,7 @@
 	/**
 	 * Renders content provided by TJsonResponse::getJsonContent() as
 	 * javascript in JSON format.
+	 * @param TJsonResponse $service
 	 */
 	protected function createJsonResponse($service,$properties,$config)
 	{

Spacing +32 added lines, -32 removed lines

@@ -54,7 +54,7 @@ 
 	/**
 	 * @var array registered services
 	 */
-	private $_services=array();
+	private $_services = array();
 
 	/**
 	 * Initializes this module.
@@ -72,20 +72,20 @@ 
 	 */
 	protected function loadJsonServices($config)
 	{
-		if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
+		if ($this->getApplication()->getConfigurationType() == TApplication::CONFIG_TYPE_PHP)
 		{
-			if(is_array($config))
+			if (is_array($config))
 			{
-				foreach($config['json'] as $id => $json)
+				foreach ($config['json'] as $id => $json)
 					$this->_services[$id] = $json;
 			}
 		}
 		else
 		{
-			foreach($config->getElementsByTagName('json') as $json)
+			foreach ($config->getElementsByTagName('json') as $json)
 			{
-				if(($id=$json->getAttribute('id'))!==null)
-					$this->_services[$id]=$json;
+				if (($id = $json->getAttribute('id')) !== null)
+					$this->_services[$id] = $json;
 				else
 					throw new TConfigurationException('jsonservice_id_required');
 			}
@@ -98,58 +98,58 @@ 
 	 */
 	public function run()
 	{
-		$id=$this->getRequest()->getServiceParameter();
-		if(isset($this->_services[$id]))
+		$id = $this->getRequest()->getServiceParameter();
+		if (isset($this->_services[$id]))
 		{
-			$serviceConfig=$this->_services[$id];
-			if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
+			$serviceConfig = $this->_services[$id];
+			if ($this->getApplication()->getConfigurationType() == TApplication::CONFIG_TYPE_PHP)
 			{
-				if(isset($serviceConfig['class']))
+				if (isset($serviceConfig['class']))
 				{
-					$service=Prado::createComponent($serviceConfig['class']);
-					if($service instanceof TJsonResponse)
+					$service = Prado::createComponent($serviceConfig['class']);
+					if ($service instanceof TJsonResponse)
 					{
-						$properties = isset($serviceConfig['properties'])?$serviceConfig['properties']:array();
-						$this->createJsonResponse($service,$properties,$serviceConfig);
+						$properties = isset($serviceConfig['properties']) ? $serviceConfig['properties'] : array();
+						$this->createJsonResponse($service, $properties, $serviceConfig);
 					}
 					else
-						throw new TConfigurationException('jsonservice_response_type_invalid',$id);
+						throw new TConfigurationException('jsonservice_response_type_invalid', $id);
 				}
 				else
-					throw new TConfigurationException('jsonservice_class_required',$id);
+					throw new TConfigurationException('jsonservice_class_required', $id);
 			}
 			else
 			{
-				$properties=$serviceConfig->getAttributes();
-				if(($class=$properties->remove('class'))!==null)
+				$properties = $serviceConfig->getAttributes();
+				if (($class = $properties->remove('class')) !== null)
 				{
-					$service=Prado::createComponent($class);
-					if($service instanceof TJsonResponse)
-						$this->createJsonResponse($service,$properties,$serviceConfig);
+					$service = Prado::createComponent($class);
+					if ($service instanceof TJsonResponse)
+						$this->createJsonResponse($service, $properties, $serviceConfig);
 					else
-						throw new TConfigurationException('jsonservice_response_type_invalid',$id);
+						throw new TConfigurationException('jsonservice_response_type_invalid', $id);
 				}
 				else
-					throw new TConfigurationException('jsonservice_class_required',$id);
+					throw new TConfigurationException('jsonservice_class_required', $id);
 			}
 		}
 		else
-			throw new THttpException(404,'jsonservice_provider_unknown',$id);
+			throw new THttpException(404, 'jsonservice_provider_unknown', $id);
 	}
 
 	/**
 	 * Renders content provided by TJsonResponse::getJsonContent() as
 	 * javascript in JSON format.
 	 */
-	protected function createJsonResponse($service,$properties,$config)
+	protected function createJsonResponse($service, $properties, $config)
 	{
 		// init service properties
-		foreach($properties as $name=>$value)
-			$service->setSubproperty($name,$value);
+		foreach ($properties as $name=>$value)
+			$service->setSubproperty($name, $value);
 		$service->init($config);
 
 		//send content if not null
-		if(($content=$service->getJsonContent())!==null)
+		if (($content = $service->getJsonContent()) !== null)
 		{
 			$response = $this->getResponse();
 			$response->setContentType('application/json');
@@ -175,7 +175,7 @@ 
  */
 abstract class TJsonResponse extends TApplicationComponent
 {
-	private $_id='';
+	private $_id = '';
 
 	/**
 	 * Initializes the feed.
@@ -198,7 +198,7 @@ 
 	 */
 	public function setID($value)
 	{
-		$this->_id=$value;
+		$this->_id = $value;
 	}
 
 	/**

Braces +12 added lines, -16 removed lines

@@ -76,11 +76,11 @@ 
 		{
 			if(is_array($config))
 			{
-				foreach($config['json'] as $id => $json)
-					$this->_services[$id] = $json;
+				foreach($config['json'] as $id => $json) {
+									$this->_services[$id] = $json;
+				}
 			}
-		}
-		else
+		} else
 		{
 			foreach($config->getElementsByTagName('json') as $json)
 			{
@@ -111,14 +111,11 @@ 
 					{
 						$properties = isset($serviceConfig['properties'])?$serviceConfig['properties']:array();
 						$this->createJsonResponse($service,$properties,$serviceConfig);
-					}
-					else
+					} else
 						throw new TConfigurationException('jsonservice_response_type_invalid',$id);
-				}
-				else
+				} else
 					throw new TConfigurationException('jsonservice_class_required',$id);
-			}
-			else
+			} else
 			{
 				$properties=$serviceConfig->getAttributes();
 				if(($class=$properties->remove('class'))!==null)
@@ -128,12 +125,10 @@ 
 						$this->createJsonResponse($service,$properties,$serviceConfig);
 					else
 						throw new TConfigurationException('jsonservice_response_type_invalid',$id);
-				}
-				else
+				} else
 					throw new TConfigurationException('jsonservice_class_required',$id);
 			}
-		}
-		else
+		} else
 			throw new THttpException(404,'jsonservice_provider_unknown',$id);
 	}
 
@@ -144,8 +139,9 @@ 
 	protected function createJsonResponse($service,$properties,$config)
 	{
 		// init service properties
-		foreach($properties as $name=>$value)
-			$service->setSubproperty($name,$value);
+		foreach($properties as $name=>$value) {
+					$service->setSubproperty($name,$value);
+		}
 		$service->init($config);
 
 		//send content if not null

framework/Web/Services/TPageService.php

Doc Comments +7 added lines

@@ -369,6 +369,7 @@ 
 
 	/**
 	 * @param string default page path to be served if no explicit page is request
+	 * @param string $value
 	 * @throws TInvalidOperationException if the page service is initialized
 	 */
 	public function setDefaultPage($value)
@@ -528,6 +529,7 @@ 
 	 * @param array list of GET parameters, null if no GET parameters required
 	 * @param boolean whether to encode the ampersand in URL, defaults to true.
 	 * @param boolean whether to encode the GET parameters (their names and values), defaults to true.
+	 * @param string $pagePath
 	 * @return string URL for the page and GET parameters
 	 */
 	public function constructUrl($pagePath,$getParams=null,$encodeAmpersand=true,$encodeGetItems=true)
@@ -670,6 +672,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $configPath
+	 */
 	public function loadFromPhp($config,$configPath,$configPagePath)
 	{
 		$this->loadApplicationConfigurationFromPhp($config,$configPath);
@@ -683,6 +688,8 @@ 
 	 * @param TXmlElement config xml element
 	 * @param string the directory containing this configuration
 	 * @param string the page path that the config XML is associated with. The page path doesn't include the page name.
+	 * @param TXmlDocument $dom
+	 * @param string $configPath
 	 */
 	public function loadFromXml($dom,$configPath,$configPagePath)
 	{

Braces +11 added lines, -14 removed lines

@@ -166,8 +166,9 @@ 
 	protected function initPageContext($pageConfig)
 	{
 		$application=$this->getApplication();
-		foreach($pageConfig->getApplicationConfigurations() as $appConfig)
-			$application->applyConfiguration($appConfig);
+		foreach($pageConfig->getApplicationConfigurations() as $appConfig) {
+					$application->applyConfiguration($appConfig);
+		}
 
 		$this->applyConfiguration($pageConfig);
 	}
@@ -232,8 +233,7 @@ 
 					$pageConfig->loadPageConfigurationFromXml($config,$application->getBasePath(),'');
 			}
 			$pageConfig->loadFromFiles($this->getBasePath());
-		}
-		else
+		} else
 		{
 			$configCached=true;
 			$currentTimestamp=array();
@@ -251,8 +251,7 @@ 
 							$currentTimestamp[0]=$appConfigFile===null?0:@filemtime($appConfigFile);
 							if($currentTimestamp[0]>$timestamp || ($timestamp>0 && !$currentTimestamp[0]))
 								$configCached=false;
-						}
-						else
+						} else
 						{
 							$currentTimestamp[$fileName]=@filemtime($fileName);
 							if($currentTimestamp[$fileName]>$timestamp || ($timestamp>0 && !$currentTimestamp[$fileName]))
@@ -260,8 +259,7 @@ 
 						}
 					}
 				}
-			}
-			else
+			} else
 			{
 				$configCached=false;
 				$paths=explode('.',$pagePath);
@@ -489,8 +487,7 @@ 
 			$className=basename($path);
 			if(!class_exists($className,false))
 				include_once($path.Prado::CLASS_FILE_EXT);
-		}
-		else
+		} else
 		{
 			$className=$this->getBasePageClass();
 			Prado::using($className);
@@ -517,8 +514,9 @@ 
 	 */
 	protected function runPage($page,$properties)
 	{
-		foreach($properties as $name=>$value)
-			$page->setSubProperty($name,$value);
+		foreach($properties as $name=>$value) {
+					$page->setSubProperty($name,$value);
+		}
 		$page->run($this->getResponse()->createHtmlWriter());
 	}
 
@@ -659,8 +657,7 @@ 
 		{
 			$fcontent = include $fname;
 			$this->loadFromPhp($fcontent,dirname($fname),$configPagePath);
-		}
-		else
+		} else
 		{
 			$dom=new TXmlDocument;
 			if($dom->loadFromFile($fname))

Spacing +251 added lines, -251 removed lines

@@ -77,68 +77,68 @@ 
 	/**
 	 * Configuration file name
 	 */
-	const CONFIG_FILE_XML='config.xml';
+	const CONFIG_FILE_XML = 'config.xml';
 	/**
 	 * Configuration file name
 	 */
-	const CONFIG_FILE_PHP='config.php';
+	const CONFIG_FILE_PHP = 'config.php';
 	/**
 	 * Default base path
 	 */
-	const DEFAULT_BASEPATH='Pages';
+	const DEFAULT_BASEPATH = 'Pages';
 	/**
 	 * Fallback base path - used to be the default up to Prado < 3.2
 	 */
-	const FALLBACK_BASEPATH='pages';
+	const FALLBACK_BASEPATH = 'pages';
 	/**
 	 * Prefix of ID used for storing parsed configuration in cache
 	 */
-	const CONFIG_CACHE_PREFIX='prado:pageservice:';
+	const CONFIG_CACHE_PREFIX = 'prado:pageservice:';
 	/**
 	 * Page template file extension
 	 */
-	const PAGE_FILE_EXT='.page';
+	const PAGE_FILE_EXT = '.page';
 	/**
 	 * @var string root path of pages
 	 */
-	private $_basePath=null;
+	private $_basePath = null;
 	/**
 	 * @var string base path class in namespace format
 	 */
-	private $_basePageClass='TPage';
+	private $_basePageClass = 'TPage';
 	/**
 	 * @var string clientscript manager class in namespace format
 	 * @since 3.1.7
 	 */
-	private $_clientScriptManagerClass='System.Web.UI.TClientScriptManager';
+	private $_clientScriptManagerClass = 'System.Web.UI.TClientScriptManager';
 	/**
 	 * @var string default page
 	 */
-	private $_defaultPage='Home';
+	private $_defaultPage = 'Home';
 	/**
 	 * @var string requested page (path)
 	 */
-	private $_pagePath=null;
+	private $_pagePath = null;
 	/**
 	 * @var TPage the requested page
 	 */
-	private $_page=null;
+	private $_page = null;
 	/**
 	 * @var array list of initial page property values
 	 */
-	private $_properties=array();
+	private $_properties = array();
 	/**
 	 * @var boolean whether service is initialized
 	 */
-	private $_initialized=false;
+	private $_initialized = false;
 	/**
 	 * @var TThemeManager theme manager
 	 */
-	private $_themeManager=null;
+	private $_themeManager = null;
 	/**
 	 * @var TTemplateManager template manager
 	 */
-	private $_templateManager=null;
+	private $_templateManager = null;
 
 	/**
 	 * Initializes the service.
@@ -147,13 +147,13 @@ 
 	 */
 	public function init($config)
 	{
-		Prado::trace("Initializing TPageService",'System.Web.Services.TPageService');
+		Prado::trace("Initializing TPageService", 'System.Web.Services.TPageService');
 
-		$pageConfig=$this->loadPageConfig($config);
+		$pageConfig = $this->loadPageConfig($config);
 
 		$this->initPageContext($pageConfig);
 
-		$this->_initialized=true;
+		$this->_initialized = true;
 	}
 
 	/**
@@ -165,8 +165,8 @@ 
 	 */
 	protected function initPageContext($pageConfig)
 	{
-		$application=$this->getApplication();
-		foreach($pageConfig->getApplicationConfigurations() as $appConfig)
+		$application = $this->getApplication();
+		foreach ($pageConfig->getApplicationConfigurations() as $appConfig)
 			$application->applyConfiguration($appConfig);
 
 		$this->applyConfiguration($pageConfig);
@@ -179,21 +179,21 @@ 
 	protected function applyConfiguration($config)
 	{
 		// initial page properties (to be set when page runs)
-		$this->_properties=array_merge($this->_properties, $config->getProperties());
+		$this->_properties = array_merge($this->_properties, $config->getProperties());
 		$this->getApplication()->getAuthorizationRules()->mergeWith($config->getRules());
-		$pagePath=$this->getRequestedPagePath();
+		$pagePath = $this->getRequestedPagePath();
 		// external configurations
-		foreach($config->getExternalConfigurations() as $filePath=>$params)
+		foreach ($config->getExternalConfigurations() as $filePath=>$params)
 		{
-			list($configPagePath,$condition)=$params;
-			if($condition!==true)
-				$condition=$this->evaluateExpression($condition);
-			if($condition)
+			list($configPagePath, $condition) = $params;
+			if ($condition !== true)
+				$condition = $this->evaluateExpression($condition);
+			if ($condition)
 			{
-				if(($path=Prado::getPathOfNamespace($filePath,Prado::getApplication()->getConfigurationFileExt()))===null || !is_file($path))
-					throw new TConfigurationException('pageservice_includefile_invalid',$filePath);
-				$c=new TPageConfiguration($pagePath);
-				$c->loadFromFile($path,$configPagePath);
+				if (($path = Prado::getPathOfNamespace($filePath, Prado::getApplication()->getConfigurationFileExt())) === null || !is_file($path))
+					throw new TConfigurationException('pageservice_includefile_invalid', $filePath);
+				$c = new TPageConfiguration($pagePath);
+				$c->loadFromFile($path, $configPagePath);
 				$this->applyConfiguration($c);
 			}
 		}
@@ -206,9 +206,9 @@ 
 	 */
 	protected function determineRequestedPagePath()
 	{
-		$pagePath=$this->getRequest()->getServiceParameter();
-		if(empty($pagePath))
-			$pagePath=$this->getDefaultPage();
+		$pagePath = $this->getRequest()->getServiceParameter();
+		if (empty($pagePath))
+			$pagePath = $this->getDefaultPage();
 		return $pagePath;
 	}
 
@@ -219,77 +219,77 @@ 
 	 */
 	protected function loadPageConfig($config)
 	{
-		$application=$this->getApplication();
-		$pagePath=$this->getRequestedPagePath();
-		if(($cache=$application->getCache())===null)
+		$application = $this->getApplication();
+		$pagePath = $this->getRequestedPagePath();
+		if (($cache = $application->getCache()) === null)
 		{
-			$pageConfig=new TPageConfiguration($pagePath);
-			if($config!==null)
+			$pageConfig = new TPageConfiguration($pagePath);
+			if ($config !== null)
 			{
-				if($application->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
-					$pageConfig->loadPageConfigurationFromPhp($config,$application->getBasePath(),'');
+				if ($application->getConfigurationType() == TApplication::CONFIG_TYPE_PHP)
+					$pageConfig->loadPageConfigurationFromPhp($config, $application->getBasePath(), '');
 				else
-					$pageConfig->loadPageConfigurationFromXml($config,$application->getBasePath(),'');
+					$pageConfig->loadPageConfigurationFromXml($config, $application->getBasePath(), '');
 			}
 			$pageConfig->loadFromFiles($this->getBasePath());
 		}
 		else
 		{
-			$configCached=true;
-			$currentTimestamp=array();
-			$arr=$cache->get(self::CONFIG_CACHE_PREFIX.$this->getID().$pagePath);
-			if(is_array($arr))
+			$configCached = true;
+			$currentTimestamp = array();
+			$arr = $cache->get(self::CONFIG_CACHE_PREFIX . $this->getID() . $pagePath);
+			if (is_array($arr))
 			{
-				list($pageConfig,$timestamps)=$arr;
-				if($application->getMode()!==TApplicationMode::Performance)
+				list($pageConfig, $timestamps) = $arr;
+				if ($application->getMode() !== TApplicationMode::Performance)
 				{
-					foreach($timestamps as $fileName=>$timestamp)
+					foreach ($timestamps as $fileName=>$timestamp)
 					{
-						if($fileName===0) // application config file
+						if ($fileName === 0) // application config file
 						{
-							$appConfigFile=$application->getConfigurationFile();
-							$currentTimestamp[0]=$appConfigFile===null?0:@filemtime($appConfigFile);
-							if($currentTimestamp[0]>$timestamp || ($timestamp>0 && !$currentTimestamp[0]))
-								$configCached=false;
+							$appConfigFile = $application->getConfigurationFile();
+							$currentTimestamp[0] = $appConfigFile === null ? 0 : @filemtime($appConfigFile);
+							if ($currentTimestamp[0] > $timestamp || ($timestamp > 0 && !$currentTimestamp[0]))
+								$configCached = false;
 						}
 						else
 						{
-							$currentTimestamp[$fileName]=@filemtime($fileName);
-							if($currentTimestamp[$fileName]>$timestamp || ($timestamp>0 && !$currentTimestamp[$fileName]))
-								$configCached=false;
+							$currentTimestamp[$fileName] = @filemtime($fileName);
+							if ($currentTimestamp[$fileName] > $timestamp || ($timestamp > 0 && !$currentTimestamp[$fileName]))
+								$configCached = false;
 						}
 					}
 				}
 			}
 			else
 			{
-				$configCached=false;
-				$paths=explode('.',$pagePath);
-				$configPath=$this->getBasePath();
-				$fileName = $this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP
+				$configCached = false;
+				$paths = explode('.', $pagePath);
+				$configPath = $this->getBasePath();
+				$fileName = $this->getApplication()->getConfigurationType() == TApplication::CONFIG_TYPE_PHP
 					? self::CONFIG_FILE_PHP
 					: self::CONFIG_FILE_XML;
-				foreach($paths as $path)
+				foreach ($paths as $path)
 				{
-					$configFile=$configPath.DIRECTORY_SEPARATOR.$fileName;
-					$currentTimestamp[$configFile]=@filemtime($configFile);
-					$configPath.=DIRECTORY_SEPARATOR.$path;
+					$configFile = $configPath . DIRECTORY_SEPARATOR . $fileName;
+					$currentTimestamp[$configFile] = @filemtime($configFile);
+					$configPath .= DIRECTORY_SEPARATOR . $path;
 				}
-				$appConfigFile=$application->getConfigurationFile();
-				$currentTimestamp[0]=$appConfigFile===null?0:@filemtime($appConfigFile);
+				$appConfigFile = $application->getConfigurationFile();
+				$currentTimestamp[0] = $appConfigFile === null ? 0 : @filemtime($appConfigFile);
 			}
-			if(!$configCached)
+			if (!$configCached)
 			{
-				$pageConfig=new TPageConfiguration($pagePath);
-				if($config!==null)
+				$pageConfig = new TPageConfiguration($pagePath);
+				if ($config !== null)
 				{
-					if($application->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
-						$pageConfig->loadPageConfigurationFromPhp($config,$application->getBasePath(),'');
+					if ($application->getConfigurationType() == TApplication::CONFIG_TYPE_PHP)
+						$pageConfig->loadPageConfigurationFromPhp($config, $application->getBasePath(), '');
 					else
-						$pageConfig->loadPageConfigurationFromXml($config,$application->getBasePath(),'');
+						$pageConfig->loadPageConfigurationFromXml($config, $application->getBasePath(), '');
 				}
 				$pageConfig->loadFromFiles($this->getBasePath());
-				$cache->set(self::CONFIG_CACHE_PREFIX.$this->getID().$pagePath,array($pageConfig,$currentTimestamp));
+				$cache->set(self::CONFIG_CACHE_PREFIX . $this->getID() . $pagePath, array($pageConfig, $currentTimestamp));
 			}
 		}
 		return $pageConfig;
@@ -300,9 +300,9 @@ 
 	 */
 	public function getTemplateManager()
 	{
-		if(!$this->_templateManager)
+		if (!$this->_templateManager)
 		{
-			$this->_templateManager=new TTemplateManager;
+			$this->_templateManager = new TTemplateManager;
 			$this->_templateManager->init(null);
 		}
 		return $this->_templateManager;
@@ -313,7 +313,7 @@ 
 	 */
 	public function setTemplateManager(TTemplateManager $value)
 	{
-		$this->_templateManager=$value;
+		$this->_templateManager = $value;
 	}
 
 	/**
@@ -321,9 +321,9 @@ 
 	 */
 	public function getThemeManager()
 	{
-		if(!$this->_themeManager)
+		if (!$this->_themeManager)
 		{
-			$this->_themeManager=new TThemeManager;
+			$this->_themeManager = new TThemeManager;
 			$this->_themeManager->init(null);
 		}
 		return $this->_themeManager;
@@ -334,7 +334,7 @@ 
 	 */
 	public function setThemeManager(TThemeManager $value)
 	{
-		$this->_themeManager=$value;
+		$this->_themeManager = $value;
 	}
 
 	/**
@@ -342,11 +342,11 @@ 
 	 */
 	public function getRequestedPagePath()
 	{
-		if($this->_pagePath===null)
+		if ($this->_pagePath === null)
 		{
-			$this->_pagePath=strtr($this->determineRequestedPagePath(),'/\\','..');
-			if(empty($this->_pagePath))
-				throw new THttpException(404,'pageservice_page_required');
+			$this->_pagePath = strtr($this->determineRequestedPagePath(), '/\\', '..');
+			if (empty($this->_pagePath))
+				throw new THttpException(404, 'pageservice_page_required');
 		}
 		return $this->_pagePath;
 	}
@@ -373,10 +373,10 @@ 
 	 */
 	public function setDefaultPage($value)
 	{
-		if($this->_initialized)
+		if ($this->_initialized)
 			throw new TInvalidOperationException('pageservice_defaultpage_unchangeable');
 		else
-			$this->_defaultPage=$value;
+			$this->_defaultPage = $value;
 	}
 
 	/**
@@ -392,14 +392,14 @@ 
 	 */
 	public function getBasePath()
 	{
-		if($this->_basePath===null)
+		if ($this->_basePath === null)
 		{
-			$basePath=$this->getApplication()->getBasePath().DIRECTORY_SEPARATOR.self::DEFAULT_BASEPATH;
-			if(($this->_basePath=realpath($basePath))===false || !is_dir($this->_basePath))
+			$basePath = $this->getApplication()->getBasePath() . DIRECTORY_SEPARATOR . self::DEFAULT_BASEPATH;
+			if (($this->_basePath = realpath($basePath)) === false || !is_dir($this->_basePath))
 			{
-				$basePath=$this->getApplication()->getBasePath().DIRECTORY_SEPARATOR.self::FALLBACK_BASEPATH;
-				if(($this->_basePath=realpath($basePath))===false || !is_dir($this->_basePath))
-					throw new TConfigurationException('pageservice_basepath_invalid',$basePath);
+				$basePath = $this->getApplication()->getBasePath() . DIRECTORY_SEPARATOR . self::FALLBACK_BASEPATH;
+				if (($this->_basePath = realpath($basePath)) === false || !is_dir($this->_basePath))
+					throw new TConfigurationException('pageservice_basepath_invalid', $basePath);
 			}
 		}
 		return $this->_basePath;
@@ -411,11 +411,11 @@ 
 	 */
 	public function setBasePath($value)
 	{
-		if($this->_initialized)
+		if ($this->_initialized)
 			throw new TInvalidOperationException('pageservice_basepath_unchangeable');
-		else if(($path=Prado::getPathOfNamespace($value))===null || !is_dir($path))
-			throw new TConfigurationException('pageservice_basepath_invalid',$value);
-		$this->_basePath=realpath($path);
+		else if (($path = Prado::getPathOfNamespace($value)) === null || !is_dir($path))
+			throw new TConfigurationException('pageservice_basepath_invalid', $value);
+		$this->_basePath = realpath($path);
 	}
 
 	/**
@@ -426,7 +426,7 @@ 
 	 */
 	public function setBasePageClass($value)
 	{
-		$this->_basePageClass=$value;
+		$this->_basePageClass = $value;
 	}
 
 	/**
@@ -444,7 +444,7 @@ 
 	 */
 	public function setClientScriptManagerClass($value)
 	{
-		$this->_clientScriptManagerClass=$value;
+		$this->_clientScriptManagerClass = $value;
 	}
 
 	/**
@@ -463,9 +463,9 @@ 
 	 */
 	public function run()
 	{
-		Prado::trace("Running page service",'System.Web.Services.TPageService');
-		$this->_page=$this->createPage($this->getRequestedPagePath());
-		$this->runPage($this->_page,$this->_properties);
+		Prado::trace("Running page service", 'System.Web.Services.TPageService');
+		$this->_page = $this->createPage($this->getRequestedPagePath());
+		$this->runPage($this->_page, $this->_properties);
 	}
 
 	/**
@@ -477,35 +477,35 @@ 
 	 */
 	protected function createPage($pagePath)
 	{
-		$path=$this->getBasePath().DIRECTORY_SEPARATOR.strtr($pagePath,'.',DIRECTORY_SEPARATOR);
-		$hasTemplateFile=is_file($path.self::PAGE_FILE_EXT);
-		$hasClassFile=is_file($path.Prado::CLASS_FILE_EXT);
+		$path = $this->getBasePath() . DIRECTORY_SEPARATOR . strtr($pagePath, '.', DIRECTORY_SEPARATOR);
+		$hasTemplateFile = is_file($path . self::PAGE_FILE_EXT);
+		$hasClassFile = is_file($path . Prado::CLASS_FILE_EXT);
 
-		if(!$hasTemplateFile && !$hasClassFile)
-			throw new THttpException(404,'pageservice_page_unknown',$pagePath);
+		if (!$hasTemplateFile && !$hasClassFile)
+			throw new THttpException(404, 'pageservice_page_unknown', $pagePath);
 
-		if($hasClassFile)
+		if ($hasClassFile)
 		{
-			$className=basename($path);
-			if(!class_exists($className,false))
-				include_once($path.Prado::CLASS_FILE_EXT);
+			$className = basename($path);
+			if (!class_exists($className, false))
+				include_once($path . Prado::CLASS_FILE_EXT);
 		}
 		else
 		{
-			$className=$this->getBasePageClass();
+			$className = $this->getBasePageClass();
 			Prado::using($className);
-			if(($pos=strrpos($className,'.'))!==false)
-				$className=substr($className,$pos+1);
+			if (($pos = strrpos($className, '.')) !== false)
+				$className = substr($className, $pos + 1);
 		}
 
- 		if(!class_exists($className,false) || ($className!=='TPage' && !is_subclass_of($className,'TPage')))
-			throw new THttpException(404,'pageservice_page_unknown',$pagePath);
+ 		if (!class_exists($className, false) || ($className !== 'TPage' && !is_subclass_of($className, 'TPage')))
+			throw new THttpException(404, 'pageservice_page_unknown', $pagePath);
 
-		$page=Prado::createComponent($className);
+		$page = Prado::createComponent($className);
 		$page->setPagePath($pagePath);
 
-		if($hasTemplateFile)
-			$page->setTemplate($this->getTemplateManager()->getTemplateByFileName($path.self::PAGE_FILE_EXT));
+		if ($hasTemplateFile)
+			$page->setTemplate($this->getTemplateManager()->getTemplateByFileName($path . self::PAGE_FILE_EXT));
 
 		return $page;
 	}
@@ -515,10 +515,10 @@ 
 	 * @param TPage the page instance to be run
 	 * @param array list of initial page properties
 	 */
-	protected function runPage($page,$properties)
+	protected function runPage($page, $properties)
 	{
-		foreach($properties as $name=>$value)
-			$page->setSubProperty($name,$value);
+		foreach ($properties as $name=>$value)
+			$page->setSubProperty($name, $value);
 		$page->run($this->getResponse()->createHtmlWriter());
 	}
 
@@ -530,9 +530,9 @@ 
 	 * @param boolean whether to encode the GET parameters (their names and values), defaults to true.
 	 * @return string URL for the page and GET parameters
 	 */
-	public function constructUrl($pagePath,$getParams=null,$encodeAmpersand=true,$encodeGetItems=true)
+	public function constructUrl($pagePath, $getParams = null, $encodeAmpersand = true, $encodeGetItems = true)
 	{
-		return $this->getRequest()->constructUrl($this->getID(),$pagePath,$getParams,$encodeAmpersand,$encodeGetItems);
+		return $this->getRequest()->constructUrl($this->getID(), $pagePath, $getParams, $encodeAmpersand, $encodeGetItems);
 	}
 }
 
@@ -553,23 +553,23 @@ 
 	/**
 	 * @var array list of application configurations
 	 */
-	private $_appConfigs=array();
+	private $_appConfigs = array();
 	/**
 	 * @var array list of page initial property values
 	 */
-	private $_properties=array();
+	private $_properties = array();
 	/**
 	 * @var TAuthorizationRuleCollection list of authorization rules
 	 */
-	private $_rules=array();
+	private $_rules = array();
 	/**
 	 * @var array list of included configurations
 	 */
-	private $_includes=array();
+	private $_includes = array();
 	/**
 	 * @var string the currently request page in the format of Path.To.PageName
 	 */
-	private $_pagePath='';
+	private $_pagePath = '';
 
 	/**
 	 * Constructor.
@@ -577,7 +577,7 @@ 
 	 */
 	public function __construct($pagePath)
 	{
-		$this->_pagePath=$pagePath;
+		$this->_pagePath = $pagePath;
 	}
 
 	/**
@@ -624,24 +624,24 @@ 
 	 */
 	public function loadFromFiles($basePath)
 	{
-		$paths=explode('.',$this->_pagePath);
-		$page=array_pop($paths);
-		$path=$basePath;
-		$configPagePath='';
-		$fileName = Prado::getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP
+		$paths = explode('.', $this->_pagePath);
+		$page = array_pop($paths);
+		$path = $basePath;
+		$configPagePath = '';
+		$fileName = Prado::getApplication()->getConfigurationType() == TApplication::CONFIG_TYPE_PHP
 			? TPageService::CONFIG_FILE_PHP
 			: TPageService::CONFIG_FILE_XML;
-		foreach($paths as $p)
+		foreach ($paths as $p)
 		{
-			$this->loadFromFile($path.DIRECTORY_SEPARATOR.$fileName,$configPagePath);
-			$path.=DIRECTORY_SEPARATOR.$p;
-			if($configPagePath==='')
-				$configPagePath=$p;
+			$this->loadFromFile($path . DIRECTORY_SEPARATOR . $fileName, $configPagePath);
+			$path .= DIRECTORY_SEPARATOR . $p;
+			if ($configPagePath === '')
+				$configPagePath = $p;
 			else
-				$configPagePath.='.'.$p;
+				$configPagePath .= '.' . $p;
 		}
-		$this->loadFromFile($path.DIRECTORY_SEPARATOR.$fileName,$configPagePath);
-		$this->_rules=new TAuthorizationRuleCollection($this->_rules);
+		$this->loadFromFile($path . DIRECTORY_SEPARATOR . $fileName, $configPagePath);
+		$this->_rules = new TAuthorizationRuleCollection($this->_rules);
 	}
 
 	/**
@@ -649,31 +649,31 @@ 
 	 * @param string config file name
 	 * @param string the page path that the config file is associated with. The page path doesn't include the page name.
 	 */
-	public function loadFromFile($fname,$configPagePath)
+	public function loadFromFile($fname, $configPagePath)
 	{
-		Prado::trace("Loading page configuration file $fname",'System.Web.Services.TPageService');
-		if(empty($fname) || !is_file($fname))
+		Prado::trace("Loading page configuration file $fname", 'System.Web.Services.TPageService');
+		if (empty($fname) || !is_file($fname))
 			return;
 
-		if(Prado::getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
+		if (Prado::getApplication()->getConfigurationType() == TApplication::CONFIG_TYPE_PHP)
 		{
 			$fcontent = include $fname;
-			$this->loadFromPhp($fcontent,dirname($fname),$configPagePath);
+			$this->loadFromPhp($fcontent, dirname($fname), $configPagePath);
 		}
 		else
 		{
-			$dom=new TXmlDocument;
-			if($dom->loadFromFile($fname))
-				$this->loadFromXml($dom,dirname($fname),$configPagePath);
+			$dom = new TXmlDocument;
+			if ($dom->loadFromFile($fname))
+				$this->loadFromXml($dom, dirname($fname), $configPagePath);
 			else
-				throw new TConfigurationException('pageserviceconf_file_invalid',$fname);
+				throw new TConfigurationException('pageserviceconf_file_invalid', $fname);
 		}
 	}
 
-	public function loadFromPhp($config,$configPath,$configPagePath)
+	public function loadFromPhp($config, $configPath, $configPagePath)
 	{
-		$this->loadApplicationConfigurationFromPhp($config,$configPath);
-		$this->loadPageConfigurationFromPhp($config,$configPath,$configPagePath);
+		$this->loadApplicationConfigurationFromPhp($config, $configPath);
+		$this->loadPageConfigurationFromPhp($config, $configPath, $configPagePath);
 	}
 
 	/**
@@ -684,17 +684,17 @@ 
 	 * @param string the directory containing this configuration
 	 * @param string the page path that the config XML is associated with. The page path doesn't include the page name.
 	 */
-	public function loadFromXml($dom,$configPath,$configPagePath)
+	public function loadFromXml($dom, $configPath, $configPagePath)
 	{
-		$this->loadApplicationConfigurationFromXml($dom,$configPath);
-		$this->loadPageConfigurationFromXml($dom,$configPath,$configPagePath);
+		$this->loadApplicationConfigurationFromXml($dom, $configPath);
+		$this->loadPageConfigurationFromXml($dom, $configPath, $configPagePath);
 	}
 
-	public function loadApplicationConfigurationFromPhp($config,$configPath)
+	public function loadApplicationConfigurationFromPhp($config, $configPath)
 	{
-		$appConfig=new TApplicationConfiguration;
-		$appConfig->loadFromPhp($config,$configPath);
-		$this->_appConfigs[]=$appConfig;
+		$appConfig = new TApplicationConfiguration;
+		$appConfig->loadFromPhp($config, $configPath);
+		$this->_appConfigs[] = $appConfig;
 	}
 
 	/**
@@ -702,102 +702,102 @@ 
 	 * @param TXmlElement config xml element
 	 * @param string base path corresponding to this xml element
 	 */
-	public function loadApplicationConfigurationFromXml($dom,$configPath)
+	public function loadApplicationConfigurationFromXml($dom, $configPath)
 	{
-		$appConfig=new TApplicationConfiguration;
-		$appConfig->loadFromXml($dom,$configPath);
-		$this->_appConfigs[]=$appConfig;
+		$appConfig = new TApplicationConfiguration;
+		$appConfig->loadFromXml($dom, $configPath);
+		$this->_appConfigs[] = $appConfig;
 	}
 
 	public function loadPageConfigurationFromPhp($config, $configPath, $configPagePath)
 	{
 		// authorization
-		if(isset($config['authorization']) && is_array($config['authorization']))
+		if (isset($config['authorization']) && is_array($config['authorization']))
 		{
 			$rules = array();
-			foreach($config['authorization'] as $authorization)
+			foreach ($config['authorization'] as $authorization)
 			{
-				$patterns=isset($authorization['pages'])?$authorization['pages']:'';
-				$ruleApplies=false;
-				if(empty($patterns) || trim($patterns)==='*') // null or empty string
-					$ruleApplies=true;
+				$patterns = isset($authorization['pages']) ? $authorization['pages'] : '';
+				$ruleApplies = false;
+				if (empty($patterns) || trim($patterns) === '*') // null or empty string
+					$ruleApplies = true;
 				else
 				{
-					foreach(explode(',',$patterns) as $pattern)
+					foreach (explode(',', $patterns) as $pattern)
 					{
-						if(($pattern=trim($pattern))!=='')
+						if (($pattern = trim($pattern)) !== '')
 						{
 							// we know $configPagePath and $this->_pagePath
-							if($configPagePath!=='')  // prepend the pattern with ConfigPagePath
-								$pattern=$configPagePath.'.'.$pattern;
-							if(strcasecmp($pattern,$this->_pagePath)===0)
+							if ($configPagePath !== '')  // prepend the pattern with ConfigPagePath
+								$pattern = $configPagePath . '.' . $pattern;
+							if (strcasecmp($pattern, $this->_pagePath) === 0)
 							{
-								$ruleApplies=true;
+								$ruleApplies = true;
 								break;
 							}
-							if($pattern[strlen($pattern)-1]==='*') // try wildcard matching
+							if ($pattern[strlen($pattern) - 1] === '*') // try wildcard matching
 							{
-								if(strncasecmp($this->_pagePath,$pattern,strlen($pattern)-1)===0)
+								if (strncasecmp($this->_pagePath, $pattern, strlen($pattern) - 1) === 0)
 								{
-									$ruleApplies=true;
+									$ruleApplies = true;
 									break;
 								}
 							}
 						}
 					}
 				}
-				if($ruleApplies)
+				if ($ruleApplies)
 				{
-					$action = isset($authorization['action'])?$authorization['action']:'';
-					$users = isset($authorization['users'])?$authorization['users']:'';
-					$roles = isset($authorization['roles'])?$authorization['roles']:'';
-					$verb = isset($authorization['verb'])?$authorization['verb']:'';
-					$ips = isset($authorization['ips'])?$authorization['ips']:'';
-					$rules[]=new TAuthorizationRule($action,$users,$roles,$verb,$ips);
+					$action = isset($authorization['action']) ? $authorization['action'] : '';
+					$users = isset($authorization['users']) ? $authorization['users'] : '';
+					$roles = isset($authorization['roles']) ? $authorization['roles'] : '';
+					$verb = isset($authorization['verb']) ? $authorization['verb'] : '';
+					$ips = isset($authorization['ips']) ? $authorization['ips'] : '';
+					$rules[] = new TAuthorizationRule($action, $users, $roles, $verb, $ips);
 				}
 			}
-			$this->_rules=array_merge($rules,$this->_rules);
+			$this->_rules = array_merge($rules, $this->_rules);
 		}
 		// pages
-		if(isset($config['pages']) && is_array($config['pages']))
+		if (isset($config['pages']) && is_array($config['pages']))
 		{
-			if(isset($config['pages']['properties']))
+			if (isset($config['pages']['properties']))
 			{
 				$this->_properties = array_merge($this->_properties, $config['pages']['properties']);
 				unset($config['pages']['properties']);
 			}
-			foreach($config['pages'] as $id => $page)
+			foreach ($config['pages'] as $id => $page)
 			{
 				$properties = array();
-				if(isset($page['properties']))
+				if (isset($page['properties']))
 				{
-					$properties=$page['properties'];
+					$properties = $page['properties'];
 					unset($page['properties']);
 				}
-				$matching=false;
-				$id=($configPagePath==='')?$id:$configPagePath.'.'.$id;
-				if(strcasecmp($id,$this->_pagePath)===0)
-					$matching=true;
-				else if($id[strlen($id)-1]==='*') // try wildcard matching
-					$matching=strncasecmp($this->_pagePath,$id,strlen($id)-1)===0;
-				if($matching)
-					$this->_properties=array_merge($this->_properties,$properties);
+				$matching = false;
+				$id = ($configPagePath === '') ? $id : $configPagePath . '.' . $id;
+				if (strcasecmp($id, $this->_pagePath) === 0)
+					$matching = true;
+				else if ($id[strlen($id) - 1] === '*') // try wildcard matching
+					$matching = strncasecmp($this->_pagePath, $id, strlen($id) - 1) === 0;
+				if ($matching)
+					$this->_properties = array_merge($this->_properties, $properties);
 			}
 		}
 
 		// external configurations
-		if(isset($config['includes']) && is_array($config['includes']))
+		if (isset($config['includes']) && is_array($config['includes']))
 		{
-			foreach($config['includes'] as $include)
+			foreach ($config['includes'] as $include)
 			{
-				$when = isset($include['when'])?true:false;
-				if(!isset($include['file']))
+				$when = isset($include['when']) ?true:false;
+				if (!isset($include['file']))
 					throw new TConfigurationException('pageserviceconf_includefile_required');
 				$filePath = $include['file'];
-				if(isset($this->_includes[$filePath]))
-					$this->_includes[$filePath]=array($configPagePath,'('.$this->_includes[$filePath][1].') || ('.$when.')');
+				if (isset($this->_includes[$filePath]))
+					$this->_includes[$filePath] = array($configPagePath, '(' . $this->_includes[$filePath][1] . ') || (' . $when . ')');
 				else
-					$this->_includes[$filePath]=array($configPagePath,$when);
+					$this->_includes[$filePath] = array($configPagePath, $when);
 			}
 		}
 	}
@@ -808,82 +808,82 @@ 
 	 * @param string base path corresponding to this xml element
 	 * @param string the page path that the config XML is associated with. The page path doesn't include the page name.
 	 */
-	public function loadPageConfigurationFromXml($dom,$configPath,$configPagePath)
+	public function loadPageConfigurationFromXml($dom, $configPath, $configPagePath)
 	{
 		// authorization
-		if(($authorizationNode=$dom->getElementByTagName('authorization'))!==null)
+		if (($authorizationNode = $dom->getElementByTagName('authorization')) !== null)
 		{
-			$rules=array();
-			foreach($authorizationNode->getElements() as $node)
+			$rules = array();
+			foreach ($authorizationNode->getElements() as $node)
 			{
-				$patterns=$node->getAttribute('pages');
-				$ruleApplies=false;
-				if(empty($patterns) || trim($patterns)==='*') // null or empty string
-					$ruleApplies=true;
+				$patterns = $node->getAttribute('pages');
+				$ruleApplies = false;
+				if (empty($patterns) || trim($patterns) === '*') // null or empty string
+					$ruleApplies = true;
 				else
 				{
-					foreach(explode(',',$patterns) as $pattern)
+					foreach (explode(',', $patterns) as $pattern)
 					{
-						if(($pattern=trim($pattern))!=='')
+						if (($pattern = trim($pattern)) !== '')
 						{
 							// we know $configPagePath and $this->_pagePath
-							if($configPagePath!=='')  // prepend the pattern with ConfigPagePath
-								$pattern=$configPagePath.'.'.$pattern;
-							if(strcasecmp($pattern,$this->_pagePath)===0)
+							if ($configPagePath !== '')  // prepend the pattern with ConfigPagePath
+								$pattern = $configPagePath . '.' . $pattern;
+							if (strcasecmp($pattern, $this->_pagePath) === 0)
 							{
-								$ruleApplies=true;
+								$ruleApplies = true;
 								break;
 							}
-							if($pattern[strlen($pattern)-1]==='*') // try wildcard matching
+							if ($pattern[strlen($pattern) - 1] === '*') // try wildcard matching
 							{
-								if(strncasecmp($this->_pagePath,$pattern,strlen($pattern)-1)===0)
+								if (strncasecmp($this->_pagePath, $pattern, strlen($pattern) - 1) === 0)
 								{
-									$ruleApplies=true;
+									$ruleApplies = true;
 									break;
 								}
 							}
 						}
 					}
 				}
-				if($ruleApplies)
-					$rules[]=new TAuthorizationRule($node->getTagName(),$node->getAttribute('users'),$node->getAttribute('roles'),$node->getAttribute('verb'),$node->getAttribute('ips'));
+				if ($ruleApplies)
+					$rules[] = new TAuthorizationRule($node->getTagName(), $node->getAttribute('users'), $node->getAttribute('roles'), $node->getAttribute('verb'), $node->getAttribute('ips'));
 			}
-			$this->_rules=array_merge($rules,$this->_rules);
+			$this->_rules = array_merge($rules, $this->_rules);
 		}
 
 		// pages
-		if(($pagesNode=$dom->getElementByTagName('pages'))!==null)
+		if (($pagesNode = $dom->getElementByTagName('pages')) !== null)
 		{
-			$this->_properties=array_merge($this->_properties,$pagesNode->getAttributes()->toArray());
+			$this->_properties = array_merge($this->_properties, $pagesNode->getAttributes()->toArray());
 			// at the page folder
-			foreach($pagesNode->getElementsByTagName('page') as $node)
+			foreach ($pagesNode->getElementsByTagName('page') as $node)
 			{
-				$properties=$node->getAttributes();
-				$id=$properties->remove('id');
-				if(empty($id))
-					throw new TConfigurationException('pageserviceconf_page_invalid',$configPath);
-				$matching=false;
-				$id=($configPagePath==='')?$id:$configPagePath.'.'.$id;
-				if(strcasecmp($id,$this->_pagePath)===0)
-					$matching=true;
-				else if($id[strlen($id)-1]==='*') // try wildcard matching
-					$matching=strncasecmp($this->_pagePath,$id,strlen($id)-1)===0;
-				if($matching)
-					$this->_properties=array_merge($this->_properties,$properties->toArray());
+				$properties = $node->getAttributes();
+				$id = $properties->remove('id');
+				if (empty($id))
+					throw new TConfigurationException('pageserviceconf_page_invalid', $configPath);
+				$matching = false;
+				$id = ($configPagePath === '') ? $id : $configPagePath . '.' . $id;
+				if (strcasecmp($id, $this->_pagePath) === 0)
+					$matching = true;
+				else if ($id[strlen($id) - 1] === '*') // try wildcard matching
+					$matching = strncasecmp($this->_pagePath, $id, strlen($id) - 1) === 0;
+				if ($matching)
+					$this->_properties = array_merge($this->_properties, $properties->toArray());
 			}
 		}
 
 		// external configurations
-		foreach($dom->getElementsByTagName('include') as $node)
+		foreach ($dom->getElementsByTagName('include') as $node)
 		{
-			if(($when=$node->getAttribute('when'))===null)
-				$when=true;
-			if(($filePath=$node->getAttribute('file'))===null)
+			if (($when = $node->getAttribute('when')) === null)
+				$when = true;
+			if (($filePath = $node->getAttribute('file')) === null)
 				throw new TConfigurationException('pageserviceconf_includefile_required');
-			if(isset($this->_includes[$filePath]))
-				$this->_includes[$filePath]=array($configPagePath,'('.$this->_includes[$filePath][1].') || ('.$when.')');
+			if (isset($this->_includes[$filePath]))
+				$this->_includes[$filePath] = array($configPagePath, '(' . $this->_includes[$filePath][1] . ') || (' . $when . ')');
 			else
-				$this->_includes[$filePath]=array($configPagePath,$when);
+				$this->_includes[$filePath] = array($configPagePath, $when);
 		}
 	}
 }

framework/Web/Services/TRpcService.php

Doc Comments +5 added lines, -2 removed lines

@@ -258,6 +258,9 @@ 
  */
 class TRpcException extends TException
 {
+	/**
+	 * @param string $message
+	 */
 	public function __construct($message, $errorCode = -1)
 	{
 		$this->setErrorCode($errorCode);
@@ -334,7 +337,7 @@ 
 	}
 
 	/**
-	 * @return rpc server instance
+	 * @return TRpcServer server instance
 	 */
 	public function getRpcServer()
 	{
@@ -366,6 +369,7 @@ 
 	/**
 	 * @param string request payload
 	 * Processed the request ans returns the response, if any
+	 * @param string $requestPayload
 	 * @return processed response
 	 * @abstract
 	 */
@@ -641,7 +645,6 @@ 
 	/**
 	 * Registers a new RPC method and handler details
 	 * @param string $methodName
-	 * @param array $handlerDetails containing the callback handler
 	 */
 	public function addMethod($methodName, $methodDetails)
 	{

Spacing +42 added lines, -42 removed lines

@@ -90,28 +90,28 @@ 
 	{
 		$_properties = $this->apiProviders[$providerId];
 
-		if(($_providerClass = $_properties->remove('class')) === null)
+		if (($_providerClass = $_properties->remove('class')) === null)
 			throw new TConfigurationException('rpcservice_apiprovider_required');
 
 		Prado::using($_providerClass);
 
 		$_providerClassName = ($_pos = strrpos($_providerClass, '.')) !== false ? substr($_providerClass, $_pos + 1) : $_providerClass;
-		if(!is_subclass_of($_providerClassName, self::BASE_API_PROVIDER))
+		if (!is_subclass_of($_providerClassName, self::BASE_API_PROVIDER))
 			throw new TConfigurationException('rpcservice_apiprovider_invalid');
 
-		if(($_rpcServerClass = $_properties->remove('server')) === null)
+		if (($_rpcServerClass = $_properties->remove('server')) === null)
 			$_rpcServerClass = self::BASE_RPC_SERVER;
 
 		Prado::using($_rpcServerClass);
 
 		$_rpcServerClassName = ($_pos = strrpos($_rpcServerClass, '.')) !== false ? substr($_rpcServerClass, $_pos + 1) : $_rpcServerClass;
-		if($_rpcServerClassName!==self::BASE_RPC_SERVER && !is_subclass_of($_rpcServerClassName, self::BASE_RPC_SERVER))
+		if ($_rpcServerClassName !== self::BASE_RPC_SERVER && !is_subclass_of($_rpcServerClassName, self::BASE_RPC_SERVER))
 			throw new TConfigurationException('rpcservice_rpcserver_invalid');
 
 		$_apiProvider = new $_providerClassName(new $_rpcServerClassName($protocolHandler));
 		$_apiProvider->setId($providerId);
 
-		foreach($_properties as $_key => $_value)
+		foreach ($_properties as $_key => $_value)
 			$_apiProvider->setSubProperty($_key, $_value);
 
 		return $_apiProvider;
@@ -132,14 +132,14 @@ 
 	 */
 	public function loadConfig(TXmlElement $xml)
 	{
-		foreach($xml->getElementsByTagName('rpcapi') as $_apiProviderXml)
+		foreach ($xml->getElementsByTagName('rpcapi') as $_apiProviderXml)
 		{
 			$_properties = $_apiProviderXml->getAttributes();
 
-			if(($_id = $_properties->remove('id')) === null || $_id == "")
+			if (($_id = $_properties->remove('id')) === null || $_id == "")
 				throw new TConfigurationException('rpcservice_apiproviderid_required');
 
-			if(isset($this->apiProviders[$_id]))
+			if (isset($this->apiProviders[$_id]))
 				throw new TConfigurationException('rpcservice_apiproviderid_duplicated');
 
 			$this->apiProviders[$_id] = $_properties;
@@ -153,22 +153,22 @@ 
 	{
 		$_request = $this->getRequest();
 
-		if(($_providerId = $_request->getServiceParameter()) == "")
+		if (($_providerId = $_request->getServiceParameter()) == "")
 			throw new THttpException(400, 'RPC API-Provider id required');
 		
-		if(($_method = $_request->getRequestType()) != 'POST')
-			throw new THttpException(405, 'Invalid request method "'.$_method.'"!'); // TODO Exception muss "Allow POST" Header setzen
+		if (($_method = $_request->getRequestType()) != 'POST')
+			throw new THttpException(405, 'Invalid request method "' . $_method . '"!'); // TODO Exception muss "Allow POST" Header setzen
 
-		if(($_mimeType = $_request->getContentType()) === null)
+		if (($_mimeType = $_request->getContentType()) === null)
 			throw new THttpException(406, 'Content-Type is missing!'); // TODO Exception muss gültige Content-Type werte zurück geben
 
-		if(!in_array($_mimeType, array_keys($this->protocolHandlers)))
+		if (!in_array($_mimeType, array_keys($this->protocolHandlers)))
 			throw new THttpException(406, 'Unsupported Content-Type!'); // TODO see previous
 
 		$_protocolHandlerClass = $this->protocolHandlers[$_mimeType];
 		$_protocolHandler = new $_protocolHandlerClass;
 
-		if(($_result = $this->createApiProvider($_protocolHandler, $_providerId)->processRequest()) !== null)
+		if (($_result = $this->createApiProvider($_protocolHandler, $_providerId)->processRequest()) !== null)
 		{
 			$_response = $this->getResponse();
 			$_protocolHandler->createResponseHeaders($_response);
@@ -238,7 +238,7 @@ 
 		{
 			return $this->handler->callMethod($this->getPayload());
 		}
-		catch(TRpcException $e)
+		catch (TRpcException $e)
 		{
 			return $this->handler->createErrorResponse($e);
 		}
@@ -320,7 +320,7 @@ 
 	{
 		$this->rpcServer = $rpcServer;
 
-		foreach($this->registerMethods() as $_methodName => $_methodDetails)
+		foreach ($this->registerMethods() as $_methodName => $_methodDetails)
 			$this->rpcServer->addRpcMethod($_methodName, $_methodDetails);
 	}
 
@@ -418,13 +418,13 @@ 
 	 */
 	public function callApiMethod($methodName, $parameters)
 	{
-		if(!isset($this->rpcMethods[$methodName]))
-			throw new TRpcException('Method "'.$methodName.'" not found');
+		if (!isset($this->rpcMethods[$methodName]))
+			throw new TRpcException('Method "' . $methodName . '" not found');
 
-		if($parameters === null)
+		if ($parameters === null)
 			$parameters = array();
 
-		if(!is_array($parameters))
+		if (!is_array($parameters))
 			$parameters = array($parameters);
 		return call_user_func_array($this->rpcMethods[$methodName]['method'], $parameters);
 	}
@@ -445,8 +445,8 @@ 
  */
 class TJsonRpcProtocol extends TRpcProtocol
 {
-	protected $_id=null;
-	protected $_specificationVersion=1.0;
+	protected $_id = null;
+	protected $_specificationVersion = 1.0;
 
 	/**
 	 * Handles the RPC request
@@ -459,31 +459,31 @@ 
 		{
 			$_request = $this->decode($requestPayload);
 
-			if(isset($_request['jsonrpc']))
+			if (isset($_request['jsonrpc']))
 			{
-				$this->_specificationVersion=$_request['jsonrpc'];
-				if($this->_specificationVersion > 2.0)
+				$this->_specificationVersion = $_request['jsonrpc'];
+				if ($this->_specificationVersion > 2.0)
 					throw new TRpcException('Unsupported specification version', '-32600');
 			}
 
-			if(isset($_request['id']))
-				$this->_id=$_request['id'];
+			if (isset($_request['id']))
+				$this->_id = $_request['id'];
 
-			if(!isset($_request['method']))
+			if (!isset($_request['method']))
 					throw new TRpcException('Missing request method', '-32600');
 
-			if(!isset($_request['params']))
+			if (!isset($_request['params']))
 				$parameters = array();
 			else
 				$parameters = $_request['params'];
 
-			if(!is_array($parameters))
+			if (!is_array($parameters))
 				$parameters = array($parameters);
 
 			// a request without an id is a notification that doesn't need a response
-			if($this->_id !== null)
+			if ($this->_id !== null)
 			{
-				if($this->_specificationVersion==2.0)
+				if ($this->_specificationVersion == 2.0)
 				{
 					return $this->encode(array(
 						'jsonrpc' => '2.0',
@@ -499,15 +499,15 @@ 
 				}
 			}
 		}
-		catch(TRpcException $e)
+		catch (TRpcException $e)
 		{
 			return $this->createErrorResponse($e);
 		}
-		catch(THttpException $e)
+		catch (THttpException $e)
 		{
 			throw $e;
 		}
-		catch(Exception $e)
+		catch (Exception $e)
 		{
 			return $this->createErrorResponse(new TRpcException('An internal error occured', '-32603'));
 		}
@@ -520,7 +520,7 @@ 
 	 */
 	public function createErrorResponse(TRpcException $exception)
 	{
-		if($this->_specificationVersion==2.0)
+		if ($this->_specificationVersion == 2.0)
 		{
 			return $this->encode(array(
 				'id' => $this->_id,
@@ -580,7 +580,7 @@ 
 	private static function checkJsonError()
 	{
 		$errnum = json_last_error();
-		if($errnum != JSON_ERROR_NONE)
+		if ($errnum != JSON_ERROR_NONE)
 			throw new Exception("JSON error: $msg", $err);
 	}
 
@@ -593,8 +593,8 @@ 
 	 */
 	public function callApiMethod($methodName, $parameters)
 	{
-		if(!isset($this->rpcMethods[$methodName]))
-			throw new TRpcException('Method "'.$methodName.'" not found', '-32601');
+		if (!isset($this->rpcMethods[$methodName]))
+			throw new TRpcException('Method "' . $methodName . '" not found', '-32601');
 
 		return call_user_func_array($this->rpcMethods[$methodName]['method'], $parameters);
 	}
@@ -663,15 +663,15 @@ 
 		{
 			return xmlrpc_server_call_method($this->_xmlrpcServer, $requestPayload, null);
 		}
-		catch(TRpcException $e)
+		catch (TRpcException $e)
 		{
 			return $this->createErrorResponse($e);
 		}
-		catch(THttpException $e)
+		catch (THttpException $e)
 		{
 			throw $e;
 		}
-		catch(Exception $e)
+		catch (Exception $e)
 		{
 			return $this->createErrorResponse(new TRpcException('An internal error occured'));
 		}

Braces +13 added lines, -18 removed lines

@@ -111,8 +111,9 @@ 
 		$_apiProvider = new $_providerClassName(new $_rpcServerClassName($protocolHandler));
 		$_apiProvider->setId($providerId);
 
-		foreach($_properties as $_key => $_value)
-			$_apiProvider->setSubProperty($_key, $_value);
+		foreach($_properties as $_key => $_value) {
+					$_apiProvider->setSubProperty($_key, $_value);
+		}
 
 		return $_apiProvider;
 	}
@@ -237,8 +238,7 @@ 
 		try
 		{
 			return $this->handler->callMethod($this->getPayload());
-		}
-		catch(TRpcException $e)
+		} catch(TRpcException $e)
 		{
 			return $this->handler->createErrorResponse($e);
 		}
@@ -320,8 +320,9 @@ 
 	{
 		$this->rpcServer = $rpcServer;
 
-		foreach($this->registerMethods() as $_methodName => $_methodDetails)
-			$this->rpcServer->addRpcMethod($_methodName, $_methodDetails);
+		foreach($this->registerMethods() as $_methodName => $_methodDetails) {
+					$this->rpcServer->addRpcMethod($_methodName, $_methodDetails);
+		}
 	}
 
 	/**
@@ -498,16 +499,13 @@ 
 					));
 				}
 			}
-		}
-		catch(TRpcException $e)
+		} catch(TRpcException $e)
 		{
 			return $this->createErrorResponse($e);
-		}
-		catch(THttpException $e)
+		} catch(THttpException $e)
 		{
 			throw $e;
-		}
-		catch(Exception $e)
+		} catch(Exception $e)
 		{
 			return $this->createErrorResponse(new TRpcException('An internal error occured', '-32603'));
 		}
@@ -662,16 +660,13 @@ 
 		try
 		{
 			return xmlrpc_server_call_method($this->_xmlrpcServer, $requestPayload, null);
-		}
-		catch(TRpcException $e)
+		} catch(TRpcException $e)
 		{
 			return $this->createErrorResponse($e);
-		}
-		catch(THttpException $e)
+		} catch(THttpException $e)
 		{
 			throw $e;
-		}
-		catch(Exception $e)
+		} catch(Exception $e)
 		{
 			return $this->createErrorResponse(new TRpcException('An internal error occured'));
 		}

framework/Web/THttpResponseAdapter.php

Doc Comments +1 added lines

@@ -31,6 +31,7 @@
 	/**
 	 * Constructor. Attach a response to be adapted.
 	 * @param THttpResponse the response object the adapter is to attach to.
+	 * @param THttpResponse $response
 	 */
 	public function __construct($response)
 	{

Spacing +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
 	 */
 	public function __construct($response)
 	{
-		$this->_response=$response;
+		$this->_response = $response;
 	}
 
 	/**
@@ -71,7 +71,7 @@ 
 	 */
 	public function createNewHtmlWriter($type, $writer)
 	{
-		return $this->_response->createNewHtmlWriter($type,$writer);
+		return $this->_response->createNewHtmlWriter($type, $writer);
 	}
 }
 

framework/Web/THttpSession.php

Doc Comments +3 added lines

@@ -265,6 +265,7 @@ 
 	 * If true, make sure the methods {@link _open}, {@link _close}, {@link _read},
 	 * {@link _write}, {@link _destroy}, and {@link _gc} are overridden in child
 	 * class, because they will be used as the callback handlers.
+	 * @param boolean $value
 	 */
 	public function setUseCustomStorage($value)
 	{
@@ -527,6 +528,7 @@ 
 	 * Returns the session variable value with the session variable name.
 	 * This method is exactly the same as {@link offsetGet}.
 	 * @param mixed the session variable name
+	 * @param string $key
 	 * @return mixed the session variable value, null if no such variable exists
 	 */
 	public function itemAt($key)
@@ -539,6 +541,7 @@ 
 	 * Note, if the specified name already exists, the old value will be removed first.
 	 * @param mixed session variable name
 	 * @param mixed session variable value
+	 * @param string $key
 	 */
 	public function add($key,$value)
 	{

Indentation +2 added lines, -2 removed lines

@@ -306,10 +306,10 @@
 		{
 			$value=TPropertyValue::ensureEnum($value,'THttpSessionCookieMode');
 			if($value===THttpSessionCookieMode::None) 
-      {
+	  {
 				ini_set('session.use_cookies','0');
 			  ini_set('session.use_only_cookies','0');
-      }
+	  }
 			else if($value===THttpSessionCookieMode::Allow)
 			{
 				ini_set('session.use_cookies','1');

Spacing +76 added lines, -76 removed lines

@@ -67,24 +67,24 @@ 
  * @package System.Web
  * @since 3.0
  */
-class THttpSession extends TApplicationComponent implements IteratorAggregate,ArrayAccess,Countable,IModule
+class THttpSession extends TApplicationComponent implements IteratorAggregate, ArrayAccess, Countable, IModule
 {
 	/**
 	 * @var boolean whether this module has been initialized
 	 */
-	private $_initialized=false;
+	private $_initialized = false;
 	/**
 	 * @var boolean whether the session has started
 	 */
-	private $_started=false;
+	private $_started = false;
 	/**
 	 * @var boolean whether the session should be started when the module is initialized
 	 */
-	private $_autoStart=false;
+	private $_autoStart = false;
 	/**
 	 * @var THttpCookie cookie to be used to store session ID and other data
 	 */
-	private $_cookie=null;
+	private $_cookie = null;
 	/**
 	 * @var string module id
 	 */
@@ -92,7 +92,7 @@ 
 	/**
 	 * @var boolean
 	 */
-	private $_customStorage=false;
+	private $_customStorage = false;
 
 	/**
 	 * @return string id of this module
@@ -107,7 +107,7 @@ 
 	 */
 	public function setID($value)
 	{
-		$this->_id=$value;
+		$this->_id = $value;
 	}
 
 	/**
@@ -118,9 +118,9 @@ 
 	 */
 	public function init($config)
 	{
-		if($this->_autoStart)
+		if ($this->_autoStart)
 			$this->open();
-		$this->_initialized=true;
+		$this->_initialized = true;
 		$this->getApplication()->setSession($this);
 		register_shutdown_function(array($this, "close"));
 	}
@@ -130,15 +130,15 @@ 
 	 */
 	public function open()
 	{
-		if(!$this->_started)
+		if (!$this->_started)
 		{
-			if($this->_customStorage)
-				session_set_save_handler(array($this,'_open'),array($this,'_close'),array($this,'_read'),array($this,'_write'),array($this,'_destroy'),array($this,'_gc'));
-			if($this->_cookie!==null)
-				session_set_cookie_params($this->_cookie->getExpire(),$this->_cookie->getPath(),$this->_cookie->getDomain(),$this->_cookie->getSecure(),$this->_cookie->getHttpOnly());
-			if(ini_get('session.auto_start')!=='1')
+			if ($this->_customStorage)
+				session_set_save_handler(array($this, '_open'), array($this, '_close'), array($this, '_read'), array($this, '_write'), array($this, '_destroy'), array($this, '_gc'));
+			if ($this->_cookie !== null)
+				session_set_cookie_params($this->_cookie->getExpire(), $this->_cookie->getPath(), $this->_cookie->getDomain(), $this->_cookie->getSecure(), $this->_cookie->getHttpOnly());
+			if (ini_get('session.auto_start') !== '1')
 				session_start();
-			$this->_started=true;
+			$this->_started = true;
 		}
 	}
 
@@ -147,10 +147,10 @@ 
 	 */
 	public function close()
 	{
-		if($this->_started)
+		if ($this->_started)
 		{
 			session_write_close();
-			$this->_started=false;
+			$this->_started = false;
 		}
 	}
 
@@ -159,10 +159,10 @@ 
 	 */
 	public function destroy()
 	{
-		if($this->_started)
+		if ($this->_started)
 		{
 			session_destroy();
-			$this->_started=false;
+			$this->_started = false;
 		}
 	}
 
@@ -173,7 +173,7 @@ 
 	 * @return string old session id
 	 * @link http://php.net/manual/en/function.session-regenerate-id.php
 	 */
-	public function regenerate($deleteOld=false)
+	public function regenerate($deleteOld = false)
 	{
 		$old = $this->getSessionID();
 		session_regenerate_id($deleteOld);
@@ -202,7 +202,7 @@ 
 	 */
 	public function setSessionID($value)
 	{
-		if($this->_started)
+		if ($this->_started)
 			throw new TInvalidOperationException('httpsession_sessionid_unchangeable');
 		else
 			session_id($value);
@@ -222,12 +222,12 @@ 
 	 */
 	public function setSessionName($value)
 	{
-		if($this->_started)
+		if ($this->_started)
 			throw new TInvalidOperationException('httpsession_sessionname_unchangeable');
-		else if(ctype_alnum($value))
+		else if (ctype_alnum($value))
 			session_name($value);
 		else
-			throw new TInvalidDataValueException('httpsession_sessionname_invalid',$value);
+			throw new TInvalidDataValueException('httpsession_sessionname_invalid', $value);
 	}
 
 	/**
@@ -244,12 +244,12 @@ 
 	 */
 	public function setSavePath($value)
 	{
-		if($this->_started)
+		if ($this->_started)
 			throw new TInvalidOperationException('httpsession_savepath_unchangeable');
-		else if(is_dir($value))
+		else if (is_dir($value))
 			session_save_path($value);
 		else
-			throw new TInvalidDataValueException('httpsession_savepath_invalid',$value);
+			throw new TInvalidDataValueException('httpsession_savepath_invalid', $value);
 	}
 
 	/**
@@ -268,7 +268,7 @@ 
 	 */
 	public function setUseCustomStorage($value)
 	{
-		$this->_customStorage=TPropertyValue::ensureBoolean($value);
+		$this->_customStorage = TPropertyValue::ensureBoolean($value);
 	}
 
 	/**
@@ -276,8 +276,8 @@ 
 	 */
 	public function getCookie()
 	{
-		if($this->_cookie===null)
-			$this->_cookie=new THttpCookie($this->getSessionName(),$this->getSessionID());
+		if ($this->_cookie === null)
+			$this->_cookie = new THttpCookie($this->getSessionName(), $this->getSessionID());
 		return $this->_cookie;
 	}
 
@@ -286,9 +286,9 @@ 
 	 */
 	public function getCookieMode()
 	{
-		if(ini_get('session.use_cookies')==='0')
+		if (ini_get('session.use_cookies') === '0')
 			return THttpSessionCookieMode::None;
-		else if(ini_get('session.use_only_cookies')==='0')
+		else if (ini_get('session.use_only_cookies') === '0')
 			return THttpSessionCookieMode::Allow;
 		else
 			return THttpSessionCookieMode::Only;
@@ -300,25 +300,25 @@ 
 	 */
 	public function setCookieMode($value)
 	{
-		if($this->_started)
+		if ($this->_started)
 			throw new TInvalidOperationException('httpsession_cookiemode_unchangeable');
 		else
 		{
-			$value=TPropertyValue::ensureEnum($value,'THttpSessionCookieMode');
-			if($value===THttpSessionCookieMode::None) 
+			$value = TPropertyValue::ensureEnum($value, 'THttpSessionCookieMode');
+			if ($value === THttpSessionCookieMode::None) 
       {
-				ini_set('session.use_cookies','0');
-			  ini_set('session.use_only_cookies','0');
+				ini_set('session.use_cookies', '0');
+			  ini_set('session.use_only_cookies', '0');
       }
-			else if($value===THttpSessionCookieMode::Allow)
+			else if ($value === THttpSessionCookieMode::Allow)
 			{
-				ini_set('session.use_cookies','1');
-				ini_set('session.use_only_cookies','0');
+				ini_set('session.use_cookies', '1');
+				ini_set('session.use_only_cookies', '0');
 			}
 			else
 			{
-				ini_set('session.use_cookies','1');
-				ini_set('session.use_only_cookies','1');
+				ini_set('session.use_cookies', '1');
+				ini_set('session.use_only_cookies', '1');
 				ini_set('session.use_trans_sid', 0);
 			}
 		}
@@ -338,10 +338,10 @@ 
 	 */
 	public function setAutoStart($value)
 	{
-		if($this->_initialized)
+		if ($this->_initialized)
 			throw new TInvalidOperationException('httpsession_autostart_unchangeable');
 		else
-			$this->_autoStart=TPropertyValue::ensureBoolean($value);
+			$this->_autoStart = TPropertyValue::ensureBoolean($value);
 	}
 
 	/**
@@ -359,18 +359,18 @@ 
 	 */
 	public function setGCProbability($value)
 	{
-		if($this->_started)
+		if ($this->_started)
 			throw new TInvalidOperationException('httpsession_gcprobability_unchangeable');
 		else
 		{
-			$value=TPropertyValue::ensureInteger($value);
-			if($value>=0 && $value<=100)
+			$value = TPropertyValue::ensureInteger($value);
+			if ($value >= 0 && $value <= 100)
 			{
-				ini_set('session.gc_probability',$value);
-				ini_set('session.gc_divisor','100');
+				ini_set('session.gc_probability', $value);
+				ini_set('session.gc_divisor', '100');
 			}
 			else
-				throw new TInvalidDataValueException('httpsession_gcprobability_invalid',$value);
+				throw new TInvalidDataValueException('httpsession_gcprobability_invalid', $value);
 		}
 	}
 
@@ -379,7 +379,7 @@ 
 	 */
 	public function getUseTransparentSessionID()
 	{
-		return ini_get('session.use_trans_sid')==='1';
+		return ini_get('session.use_trans_sid') === '1';
 	}
 
 	/**
@@ -387,14 +387,14 @@ 
 	 */
 	public function setUseTransparentSessionID($value)
 	{
-		if($this->_started)
+		if ($this->_started)
 			throw new TInvalidOperationException('httpsession_transid_unchangeable');
 		else
 		{
-			$value=TPropertyValue::ensureBoolean($value);
-			if ($value && $this->getCookieMode()==THttpSessionCookieMode::Only)
+			$value = TPropertyValue::ensureBoolean($value);
+			if ($value && $this->getCookieMode() == THttpSessionCookieMode::Only)
 					throw new TInvalidOperationException('httpsession_transid_cookieonly');
-			ini_set('session.use_trans_sid',$value?'1':'0');
+			ini_set('session.use_trans_sid', $value ? '1' : '0');
 		}
 	}
 
@@ -412,10 +412,10 @@ 
 	 */
 	public function setTimeout($value)
 	{
-		if($this->_started)
+		if ($this->_started)
 			throw new TInvalidOperationException('httpsession_maxlifetime_unchangeable');
 		else
-			ini_set('session.gc_maxlifetime',$value);
+			ini_set('session.gc_maxlifetime', $value);
 	}
 
 	/**
@@ -425,7 +425,7 @@ 
 	 * @param string session name
 	 * @return boolean whether session is opened successfully
 	 */
-	public function _open($savePath,$sessionName)
+	public function _open($savePath, $sessionName)
 	{
 		return true;
 	}
@@ -458,7 +458,7 @@ 
 	 * @param string session data
 	 * @return boolean whether session write is successful
 	 */
-	public function _write($id,$data)
+	public function _write($id, $data)
 	{
 		return true;
 	}
@@ -540,9 +540,9 @@ 
 	 * @param mixed session variable name
 	 * @param mixed session variable value
 	 */
-	public function add($key,$value)
+	public function add($key, $value)
 	{
-		$_SESSION[$key]=$value;
+		$_SESSION[$key] = $value;
 	}
 
 	/**
@@ -552,9 +552,9 @@ 
 	 */
 	public function remove($key)
 	{
-		if(isset($_SESSION[$key]))
+		if (isset($_SESSION[$key]))
 		{
-			$value=$_SESSION[$key];
+			$value = $_SESSION[$key];
 			unset($_SESSION[$key]);
 			return $value;
 		}
@@ -567,7 +567,7 @@ 
 	 */
 	public function clear()
 	{
-		foreach(array_keys($_SESSION) as $key)
+		foreach (array_keys($_SESSION) as $key)
 			unset($_SESSION[$key]);
 	}
 
@@ -613,9 +613,9 @@ 
 	 * @param integer the offset to set element
 	 * @param mixed the element value
 	 */
-	public function offsetSet($offset,$item)
+	public function offsetSet($offset, $item)
 	{
-		$_SESSION[$offset]=$item;
+		$_SESSION[$offset] = $item;
 	}
 
 	/**
@@ -657,7 +657,7 @@ 
 	 */
 	public function __construct()
 	{
-		$this->_keys=array_keys($_SESSION);
+		$this->_keys = array_keys($_SESSION);
 	}
 
 	/**
@@ -666,7 +666,7 @@ 
 	 */
 	public function rewind()
 	{
-		$this->_key=reset($this->_keys);
+		$this->_key = reset($this->_keys);
 	}
 
 	/**
@@ -686,7 +686,7 @@ 
 	 */
 	public function current()
 	{
-		return isset($_SESSION[$this->_key])?$_SESSION[$this->_key]:null;
+		return isset($_SESSION[$this->_key]) ? $_SESSION[$this->_key] : null;
 	}
 
 	/**
@@ -697,9 +697,9 @@ 
 	{
 		do
 		{
-			$this->_key=next($this->_keys);
+			$this->_key = next($this->_keys);
 		}
-		while(!isset($_SESSION[$this->_key]) && $this->_key!==false);
+		while (!isset($_SESSION[$this->_key]) && $this->_key !== false);
 	}
 
 	/**
@@ -709,7 +709,7 @@ 
 	 */
 	public function valid()
 	{
-		return $this->_key!==false;
+		return $this->_key !== false;
 	}
 }
 
@@ -730,8 +730,8 @@ 
  */
 class THttpSessionCookieMode extends TEnumerable
 {
-	const None='None';
-	const Allow='Allow';
-	const Only='Only';
+	const None = 'None';
+	const Allow = 'Allow';
+	const Only = 'Only';
 }
 

Braces +7 added lines, -10 removed lines

@@ -309,13 +309,11 @@ 
       {
 				ini_set('session.use_cookies','0');
 			  ini_set('session.use_only_cookies','0');
-      }
-			else if($value===THttpSessionCookieMode::Allow)
+      } else if($value===THttpSessionCookieMode::Allow)
 			{
 				ini_set('session.use_cookies','1');
 				ini_set('session.use_only_cookies','0');
-			}
-			else
+			} else
 			{
 				ini_set('session.use_cookies','1');
 				ini_set('session.use_only_cookies','1');
@@ -368,8 +366,7 @@ 
 			{
 				ini_set('session.gc_probability',$value);
 				ini_set('session.gc_divisor','100');
-			}
-			else
+			} else
 				throw new TInvalidDataValueException('httpsession_gcprobability_invalid',$value);
 		}
 	}
@@ -557,8 +554,7 @@ 
 			$value=$_SESSION[$key];
 			unset($_SESSION[$key]);
 			return $value;
-		}
-		else
+		} else
 			return null;
 	}
 
@@ -567,8 +563,9 @@ 
 	 */
 	public function clear()
 	{
-		foreach(array_keys($_SESSION) as $key)
-			unset($_SESSION[$key]);
+		foreach(array_keys($_SESSION) as $key) {
+					unset($_SESSION[$key]);
+		}
 	}
 
 	/**

framework/Web/UI/ActiveControls/TActiveControlAdapter.php

Doc Comments +1 added lines

@@ -175,6 +175,7 @@
 
 	/**
 	 * @param string state tracker class.
+	 * @param string $value
 	 */
 	public function setStateTracker($value)
 	{

Spacing +39 added lines, -39 removed lines

@@ -48,14 +48,14 @@ 
 	/**
 	 * @var string view state tracker class.
 	 */
-	private $_stateTrackerClass='TCallbackPageStateTracker';
+	private $_stateTrackerClass = 'TCallbackPageStateTracker';
 
 	/**
 	 * Constructor.
 	 * @param IActiveControl active control to adapt.
 	 * @param string Base active control class name.
 	 */
-	public function __construct(IActiveControl $control, $baseCallbackClass=null)
+	public function __construct(IActiveControl $control, $baseCallbackClass = null)
 	{
 		parent::__construct($control);
 		$this->setBaseControlClass($baseCallbackClass);
@@ -66,9 +66,9 @@ 
 	 */
 	protected function setBaseControlClass($type)
 	{
-		if($type===null)
+		if ($type === null)
 		{
-			if($this->getControl() instanceof ICallbackEventHandler)
+			if ($this->getControl() instanceof ICallbackEventHandler)
 				$this->_activeControlType = 'TBaseActiveCallbackControl';
 			else
 				$this->_activeControlType = 'TBaseActiveControl';
@@ -91,11 +91,11 @@ 
 	public function render($writer)
 	{
 		$this->getPage()->getClientScript()->registerPradoScript('ajax');
-		if($this->_control->getVisible(false))
+		if ($this->_control->getVisible(false))
 		{
 			parent::render($writer);
 		} else {
-			$writer->write("<span id=\"".$this->_control->getClientID()."\" style=\"display:none\"></span>");
+			$writer->write("<span id=\"" . $this->_control->getClientID() . "\" style=\"display:none\"></span>");
 		}
 	}
 
@@ -104,7 +104,7 @@ 
 	 */
 	public function setBaseActiveControl($control)
 	{
-		$this->_baseActiveControl=$control;
+		$this->_baseActiveControl = $control;
 	}
 
 	/**
@@ -112,7 +112,7 @@ 
 	 */
 	public function getBaseActiveControl()
 	{
-		if($this->_baseActiveControl===null)
+		if ($this->_baseActiveControl === null)
 		{
 			$type = $this->_activeControlType;
 			$this->_baseActiveControl = new $type($this->getControl());
@@ -125,10 +125,10 @@ 
 	 */
 	protected function getIsTrackingPageState()
 	{
-		if($this->getPage()->getIsCallback())
+		if ($this->getPage()->getIsCallback())
 		{
 			$target = $this->getPage()->getCallbackEventTarget();
-			if($target instanceof ICallbackEventHandler)
+			if ($target instanceof ICallbackEventHandler)
 			{
 				$client = $target->getActiveControl()->getClientSide();
 				return $client->getEnablePageStateUpdate();
@@ -142,7 +142,7 @@ 
 	 */
 	public function onLoad($param)
 	{
-		if($this->getIsTrackingPageState())
+		if ($this->getIsTrackingPageState())
 		{
 		  $stateTrackerClass = $this->_stateTrackerClass;
 			$this->_stateTracker = new $stateTrackerClass($this->getControl());
@@ -157,7 +157,7 @@ 
 	 */
 	public function saveState()
 	{
-		if(($this->_stateTracker!==null)
+		if (($this->_stateTracker !== null)
 			&& $this->getControl()->getActiveControl()->canUpdateClientSide(true))
 		{
 			$this->_stateTracker->respondToChanges();
@@ -257,7 +257,7 @@ 
 	 */
 	public function trackChanges()
 	{
-		foreach($this->_states as $name => $value)
+		foreach ($this->_states as $name => $value)
 		{
 			$obj = $this->_control->getViewState($name);
 			$this->_existingState[$name] = is_object($obj) ? clone($obj) : $obj;
@@ -270,15 +270,15 @@ 
 	protected function getChanges()
 	{
 		$changes = array();
-		foreach($this->_states as $name => $details)
+		foreach ($this->_states as $name => $details)
 		{
 			$new = $this->_control->getViewState($name);
 			$old = $this->_existingState[$name];
-			if($new !== $old)
+			if ($new !== $old)
 			{
 				$diff = new $details[0]($new, $old, $this->_nullObject);
-				if(($change = $diff->getDifference()) !== $this->_nullObject)
-					$changes[] = array($details[1],array($change));
+				if (($change = $diff->getDifference()) !== $this->_nullObject)
+					$changes[] = array($details[1], array($change));
 			}
 		}
 		return $changes;
@@ -289,7 +289,7 @@ 
 	 */
 	public function respondToChanges()
 	{
-		foreach($this->getChanges() as $change)
+		foreach ($this->getChanges() as $change)
 			call_user_func_array($change[0], $change[1]);
 	}
 
@@ -335,10 +335,10 @@ 
 	 */
 	protected function updateVisible($visible)
 	{
-		if($visible === false)
-			$this->client()->replaceContent($this->_control,"<span id=\"".$this->_control->getClientID()."\" style=\"display:none\" ></span>");
+		if ($visible === false)
+			$this->client()->replaceContent($this->_control, "<span id=\"" . $this->_control->getClientID() . "\" style=\"display:none\" ></span>");
 		else
-			$this->client()->replaceContent($this->_control,$this->_control);
+			$this->client()->replaceContent($this->_control, $this->_control);
 	}
 
 	/**
@@ -347,7 +347,7 @@ 
 	 */
 	protected function updateEnabled($enable)
 	{
-		$this->client()->setAttribute($this->_control, 'disabled', $enable===false);
+		$this->client()->setAttribute($this->_control, 'disabled', $enable === false);
 	}
 
 	/**
@@ -356,9 +356,9 @@ 
 	 */
 	protected function updateStyle($style)
 	{
-		if($style['CssClass']!==null)
+		if ($style['CssClass'] !== null)
 			$this->client()->setAttribute($this->_control, 'class', $style['CssClass']);
-		if(count($style['Style']) > 0)
+		if (count($style['Style']) > 0)
 			$this->client()->setStyle($this->_control, $style['Style']);
 	}
 
@@ -368,7 +368,7 @@ 
 	 */
 	protected function updateAttributes($attributes)
 	{
-		foreach($attributes as $name => $value)
+		foreach ($attributes as $name => $value)
 			$this->client()->setAttribute($this->_control, $name, $value);
 	}
 }
@@ -430,7 +430,7 @@ 
 	 */
 	public function getDifference()
 	{
-		if(gettype($this->_new) === gettype($this->_old)
+		if (gettype($this->_new) === gettype($this->_old)
 			&& $this->_new === $this->_old)
 			return $this->_null;
 		else
@@ -455,11 +455,11 @@ 
 	 */
 	protected function getCombinedStyle($obj)
 	{
-		if(!($obj instanceof TStyle))
+		if (!($obj instanceof TStyle))
 			return array();
 		$style = $obj->getStyleFields();
-		$style = array_merge($style,$this->getStyleFromString($obj->getCustomStyle()));
-		if($obj->hasFont())
+		$style = array_merge($style, $this->getStyleFromString($obj->getCustomStyle()));
+		if ($obj->hasFont())
 			$style = array_merge($style, $this->getStyleFromString($obj->getFont()->toString()));
 		return $style;
 	}
@@ -471,12 +471,12 @@ 
 	protected function getStyleFromString($string)
 	{
 		$style = array();
-		if(!is_string($string)) return $style;
+		if (!is_string($string)) return $style;
 
-		foreach(explode(';',$string) as $sub)
+		foreach (explode(';', $string) as $sub)
 		{
-			$arr=explode(':',$sub);
-			if(isset($arr[1]) && trim($arr[0])!=='')
+			$arr = explode(':', $sub);
+			if (isset($arr[1]) && trim($arr[0]) !== '')
 				$style[trim($arr[0])] = trim($arr[1]);
 		}
 		return $style;
@@ -487,9 +487,9 @@ 
 	 */
 	protected function getCssClassDiff()
 	{
-		if($this->_old===null)
+		if ($this->_old === null)
 		{
-			return ($this->_new!==null) && $this->_new->hasCssClass()
+			return ($this->_new !== null) && $this->_new->hasCssClass()
 						? $this->_new->getCssClass() : null;
 		}
 		else
@@ -515,13 +515,13 @@ 
 	 */
 	public function getDifference()
 	{
-		if($this->_new===null)
+		if ($this->_new === null)
 			return $this->_null;
 		else
 		{
 			$css = $this->getCssClassDiff();
 			$style = $this->getStyleDiff();
-			if(($css!==null) || ($style!==null))
+			if (($css !== null) || ($style !== null))
 				return array('CssClass' => $css, 'Style' => $style);
 			else
 				$this->_null;
@@ -545,9 +545,9 @@ 
 	 */
 	public function getDifference()
 	{
-		if($this->_old===null)
+		if ($this->_old === null)
 		{
-			return ($this->_new!==null) ? $this->_new->toArray() : $this->_null;
+			return ($this->_new !== null) ? $this->_new->toArray() : $this->_null;
 		}
 		else
 		{

Indentation +2 added lines, -2 removed lines

@@ -78,8 +78,8 @@
 	}
 
  	/**
-	 * Publish the ajax script
-	 */
+ 	 * Publish the ajax script
+ 	 */
 	public function onPreRender($param)
 	{
 		parent::onPreRender($param);

Braces +9 added lines, -10 removed lines

@@ -72,8 +72,7 @@ 
 				$this->_activeControlType = 'TBaseActiveCallbackControl';
 			else
 				$this->_activeControlType = 'TBaseActiveControl';
-		}
-		else
+		} else
 			$this->_activeControlType = $type;
 	}
 
@@ -289,8 +288,9 @@ 
 	 */
 	public function respondToChanges()
 	{
-		foreach($this->getChanges() as $change)
-			call_user_func_array($change[0], $change[1]);
+		foreach($this->getChanges() as $change) {
+					call_user_func_array($change[0], $change[1]);
+		}
 	}
 
 	/**
@@ -368,8 +368,9 @@ 
 	 */
 	protected function updateAttributes($attributes)
 	{
-		foreach($attributes as $name => $value)
-			$this->client()->setAttribute($this->_control, $name, $value);
+		foreach($attributes as $name => $value) {
+					$this->client()->setAttribute($this->_control, $name, $value);
+		}
 	}
 }
 
@@ -491,8 +492,7 @@ 
 		{
 			return ($this->_new!==null) && $this->_new->hasCssClass()
 						? $this->_new->getCssClass() : null;
-		}
-		else
+		} else
 		{
 			return $this->_old->getCssClass() !== $this->_new->getCssClass() ?
 				$this->_new->getCssClass() : null;
@@ -548,8 +548,7 @@ 
 		if($this->_old===null)
 		{
 			return ($this->_new!==null) ? $this->_new->toArray() : $this->_null;
-		}
-		else
+		} else
 		{
 			$new = $this->_new->toArray();
 			$old = $this->_old->toArray();

framework/Web/UI/ActiveControls/TActiveCustomValidator.php

Doc Comments +1 added lines, -1 removed lines

@@ -252,7 +252,7 @@
 	}
 
 	/**
-	 * @return boolean true to observe changes.
+	 * @return boolean|string true to observe changes.
 	 */
 	public function getObserveChanges()
 	{

Spacing +5 added lines, -5 removed lines

@@ -108,7 +108,7 @@ 
 		// it could have been changed by the clientside validation.
 
 		parent::setIsValid($value);
-		if($this->getActiveControl()->canUpdateClientSide())
+		if ($this->getActiveControl()->canUpdateClientSide())
 		{
 			$client = $this->getPage()->getCallbackClient();
 			$func = 'Prado.Validation.updateActiveCustomValidator';
@@ -134,7 +134,7 @@ 
 	 */
 	protected function getClientScriptOptions()
 	{
-		$options=TBaseValidator::getClientScriptOptions();
+		$options = TBaseValidator::getClientScriptOptions();
 		$options['EventTarget'] = $this->getUniqueID();
 		return $options;
 	}
@@ -145,12 +145,12 @@ 
 	 */
 	public function setErrorMessage($value)
 	{
-		if(parent::getErrorMessage() === $value)
+		if (parent::getErrorMessage() === $value)
 			return;
 
 
 		parent::setErrorMessage($value);
-		if($this->getActiveControl()->canUpdateClientSide())
+		if ($this->getActiveControl()->canUpdateClientSide())
 		{
 			$client = $this->getPage()->getCallbackClient();
 			$func = 'Prado.Validation.setErrorMessage';
@@ -264,6 +264,6 @@ 
 	public function getObserveChanges()
 	{
 		$changes = $this->getOption('ObserveChanges');
-		return ($changes===null) ? true : $changes;
+		return ($changes === null) ? true : $changes;
 	}
 }

framework/Web/UI/ActiveControls/TActiveDropDownList.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
 	/**
 	 * No client class for this control.
 	 * This method overrides the parent implementation.
-	 * @return null no javascript class name.
+	 * @return string no javascript class name.
 	 */
 	protected function getClientClassName()
 	{

Spacing +2 added lines, -2 removed lines

@@ -82,7 +82,7 @@ 
 	 */
 	protected function createListItemCollection()
 	{
-		$collection  = new TActiveListItemCollection;
+		$collection = new TActiveListItemCollection;
 		$collection->setControl($this);
 		return $collection;
 	}
@@ -102,7 +102,7 @@ 
 	protected function addAttributesToRender($writer)
 	{
 		parent::addAttributesToRender($writer);
-		$writer->addAttribute('id',$this->getClientID());
+		$writer->addAttribute('id', $this->getClientID());
 		if ($this->getAutoPostBack())
 			$this->getActiveControl()->registerCallbackClientScript(
 				$this->getClientClassName(), $this->getPostBackOptions());

framework/Web/UI/ActiveControls/TActiveImageButton.php

Doc Comments +1 added lines

@@ -79,6 +79,7 @@
 
 	/**
 	 * @param string the URL of the image file
+	 * @param string $value
 	 */
 	public function setImageUrl($value)
 	{

Spacing +9 added lines, -9 removed lines

@@ -58,11 +58,11 @@ 
 	 */
 	public function setAlternateText($value)
 	{
-		if(parent::getAlternateText() === $value)
+		if (parent::getAlternateText() === $value)
 			return;
 
 		parent::setAlternateText($value);
-		if($this->getActiveControl()->canUpdateClientSide())
+		if ($this->getActiveControl()->canUpdateClientSide())
 			$this->getPage()->getCallbackClient()->setAttribute($this, 'alt', $value);
 	}
 
@@ -75,11 +75,11 @@ 
 	 */
 	public function setImageAlign($value)
 	{
-		if(parent::getImageAlign() === $value)
+		if (parent::getImageAlign() === $value)
 			return;
 
 		parent::setImageAlign($value);
-		if($this->getActiveControl()->canUpdateClientSide())
+		if ($this->getActiveControl()->canUpdateClientSide())
 			$this->getPage()->getCallbackClient()->setAttribute($this, 'align', $value);
 	}
 
@@ -88,11 +88,11 @@ 
 	 */
 	public function setImageUrl($value)
 	{
-		if(parent::getImageUrl() === $value)
+		if (parent::getImageUrl() === $value)
 			return;
 
 		parent::setImageUrl($value);
-		if($this->getActiveControl()->canUpdateClientSide())
+		if ($this->getActiveControl()->canUpdateClientSide())
 			$this->getPage()->getCallbackClient()->setAttribute($this, 'src', $value);
 	}
 
@@ -101,11 +101,11 @@ 
 	 */
 	public function setDescriptionUrl($value)
 	{
-		if(parent::getDescriptionUrl() === $value)
+		if (parent::getDescriptionUrl() === $value)
 			return;
 
 		parent::setDescriptionUrl($value);
-		if($this->getActiveControl()->canUpdateClientSide())
+		if ($this->getActiveControl()->canUpdateClientSide())
 			$this->getPage()->getCallbackClient()->setAttribute($this, 'longdesc', $value);
 	}
 
@@ -151,7 +151,7 @@ 
 	protected function addAttributesToRender($writer)
 	{
 		parent::addAttributesToRender($writer);
-		$writer->addAttribute('id',$this->getClientID());
+		$writer->addAttribute('id', $this->getClientID());
 		$this->getActiveControl()->registerCallbackClientScript(
 			$this->getClientClassName(), $this->getPostBackOptions());
 	}