pradosoft / prado

framework/Exceptions/TErrorHandler.php

Doc Comments +11 added lines

@@ -117,6 +117,7 @@ 
 	 * It terminates the application immediately after the error is displayed.
 	 * @param mixed sender of the event
 	 * @param mixed event parameter (if the event is raised by TApplication, it refers to the exception instance)
+	 * @param null|\Prado\TApplication $sender
 	 */
 	public function handleError($sender,$param)
 	{
@@ -186,6 +187,7 @@ 
 	 * mode will be displayed to the client user.
 	 * @param integer response status code
 	 * @param Exception exception instance
+	 * @param integer $statusCode
 	 */
 	protected function handleExternalError($statusCode,$exception)
 	{
@@ -382,6 +384,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @return string
+	 */
 	private function getExactTraceAsString($exception)
 	{
 		if($exception instanceof TPhpFatalErrorException && 
@@ -409,6 +414,9 @@ 
 		return $exception->getTraceAsString();
 	}
 
+	/**
+	 * @param string $pattern
+	 */
 	private function getPropertyAccessTrace($trace,$pattern)
 	{
 		$result=null;
@@ -441,6 +449,9 @@ 
 		return $source;
 	}
 
+	/**
+	 * @param string $message
+	 */
 	private function addLink($message) {
 		if (!is_null($class = $this->getErrorClassNameSpace($message))) {
 			return str_replace($class['name'], '<a href="' . $class['url'] . '" target="_blank">' . $class['name'] . '</a>', $message);

Indentation +2 added lines, -2 removed lines

@@ -461,8 +461,8 @@
 			}
 			$classname = $function->getNamespaceName();
 			return [
-			    'url' => 'http://pradosoft.github.io/docs/manual/class-' . str_replace('\\', '.', (string) $classname) . '.' . $class . '.html',
-			    'name' => $class,
+				'url' => 'http://pradosoft.github.io/docs/manual/class-' . str_replace('\\', '.', (string) $classname) . '.' . $class . '.html',
+				'name' => $class,
 			];
 		}
 		return null;

Spacing +54 added lines, -54 removed lines

@@ -106,7 +106,7 @@ 
 		if(($templatePath=Prado::getPathOfNamespace($value))!==null && is_dir($templatePath))
 			$this->_templatePath=$templatePath;
 		else
-			throw new TConfigurationException('errorhandler_errortemplatepath_invalid',$value);
+			throw new TConfigurationException('errorhandler_errortemplatepath_invalid', $value);
 	}
 
 	/**
@@ -118,7 +118,7 @@ 
 	 * @param mixed sender of the event
 	 * @param mixed event parameter (if the event is raised by TApplication, it refers to the exception instance)
 	 */
-	public function handleError($sender,$param)
+	public function handleError($sender, $param)
 	{
 		static $handling=false;
 		// We need to restore error and exception handlers,
@@ -137,11 +137,11 @@ 
 			if(!headers_sent())
 				header('Content-Type: text/html; charset=UTF-8');
 			if($param instanceof THttpException)
-				$this->handleExternalError($param->getStatusCode(),$param);
+				$this->handleExternalError($param->getStatusCode(), $param);
 			else if($this->getApplication()->getMode()===TApplicationMode::Debug)
 				$this->displayException($param);
 			else
-				$this->handleExternalError(500,$param);
+				$this->handleExternalError(500, $param);
 		}
 	}
 
@@ -154,28 +154,28 @@ 
 	 */
 	protected static function hideSecurityRelated($value, $exception=null)
 	{
-		$aRpl = array();
-		if($exception !== null && $exception instanceof \Exception)
+		$aRpl=array();
+		if($exception!==null && $exception instanceof \Exception)
 		{
 			if($exception instanceof TPhpFatalErrorException && 
 				function_exists('xdebug_get_function_stack'))
 			{
-				$aTrace = array_slice(array_reverse(xdebug_get_function_stack()), self::FATAL_ERROR_TRACE_DROP_LINES, -1);
+				$aTrace=array_slice(array_reverse(xdebug_get_function_stack()), self::FATAL_ERROR_TRACE_DROP_LINES, -1);
 			} else {
-				$aTrace = $exception->getTrace();
+				$aTrace=$exception->getTrace();
 			}
 
 			foreach($aTrace as $item)
 			{
 				if(isset($item['file']))
-					$aRpl[dirname($item['file']) . DIRECTORY_SEPARATOR] = '<hidden>' . DIRECTORY_SEPARATOR;
+					$aRpl[dirname($item['file']).DIRECTORY_SEPARATOR]='<hidden>'.DIRECTORY_SEPARATOR;
 			}
 		}
-		$aRpl[$_SERVER['DOCUMENT_ROOT']] = '${DocumentRoot}';
-		$aRpl[str_replace('/', DIRECTORY_SEPARATOR, $_SERVER['DOCUMENT_ROOT'])] = '${DocumentRoot}';
-		$aRpl[PRADO_DIR . DIRECTORY_SEPARATOR] = '${PradoFramework}' . DIRECTORY_SEPARATOR;
+		$aRpl[$_SERVER['DOCUMENT_ROOT']]='${DocumentRoot}';
+		$aRpl[str_replace('/', DIRECTORY_SEPARATOR, $_SERVER['DOCUMENT_ROOT'])]='${DocumentRoot}';
+		$aRpl[PRADO_DIR.DIRECTORY_SEPARATOR]='${PradoFramework}'.DIRECTORY_SEPARATOR;
 		if(isset($aRpl[DIRECTORY_SEPARATOR])) unset($aRpl[DIRECTORY_SEPARATOR]);
-		$aRpl = array_reverse($aRpl, true);
+		$aRpl=array_reverse($aRpl, true);
 
 		return str_replace(array_keys($aRpl), $aRpl, $value);
 	}
@@ -187,36 +187,36 @@ 
 	 * @param integer response status code
 	 * @param Exception exception instance
 	 */
-	protected function handleExternalError($statusCode,$exception)
+	protected function handleExternalError($statusCode, $exception)
 	{
 		if(!($exception instanceof THttpException))
 			error_log($exception->__toString());
 
-		$content=$this->getErrorTemplate($statusCode,$exception);
+		$content=$this->getErrorTemplate($statusCode, $exception);
 
-		$serverAdmin=isset($_SERVER['SERVER_ADMIN'])?$_SERVER['SERVER_ADMIN']:'';
+		$serverAdmin=isset($_SERVER['SERVER_ADMIN']) ? $_SERVER['SERVER_ADMIN'] : '';
 
-		$isDebug = $this->getApplication()->getMode()===TApplicationMode::Debug;
+		$isDebug=$this->getApplication()->getMode()===TApplicationMode::Debug;
 
-		$errorMessage = $exception->getMessage();
+		$errorMessage=$exception->getMessage();
 		if($isDebug)
 			$version=$_SERVER['SERVER_SOFTWARE'].' <a href="https://github.com/pradosoft/prado">PRADO</a>/'.Prado::getVersion();
 		else
 		{
 			$version='';
-			$errorMessage = self::hideSecurityRelated($errorMessage, $exception);
+			$errorMessage=self::hideSecurityRelated($errorMessage, $exception);
 		}
 		$tokens=array(
 			'%%StatusCode%%' => "$statusCode",
 			'%%ErrorMessage%%' => htmlspecialchars($errorMessage),
 			'%%ServerAdmin%%' => $serverAdmin,
 			'%%Version%%' => $version,
-			'%%Time%%' => @strftime('%Y-%m-%d %H:%M',time())
+			'%%Time%%' => @strftime('%Y-%m-%d %H:%M', time())
 		);
 
 		$this->getApplication()->getResponse()->setStatusCode($statusCode, $isDebug ? $exception->getMessage() : null);
 
-		echo strtr($content,$tokens);
+		echo strtr($content, $tokens);
 	}
 
 	/**
@@ -261,8 +261,8 @@ 
 		if($exception instanceof TTemplateException)
 		{
 			$fileName=$exception->getTemplateFile();
-			$lines=empty($fileName)?explode("\n",$exception->getTemplateSource()):@file($fileName);
-			$source=$this->getSourceCode($lines,$exception->getLineNumber());
+			$lines=empty($fileName) ?explode("\n", $exception->getTemplateSource()) : @file($fileName);
+			$source=$this->getSourceCode($lines, $exception->getLineNumber());
 			if($fileName==='')
 				$fileName='---embedded template---';
 			$errorLine=$exception->getLineNumber();
@@ -279,7 +279,7 @@ 
 				$fileName=$exception->getFile();
 				$errorLine=$exception->getLine();
 			}
-			$source=$this->getSourceCode(@file($fileName),$errorLine);
+			$source=$this->getSourceCode(@file($fileName), $errorLine);
 		}
 
 		if($this->getApplication()->getMode()===TApplicationMode::Debug)
@@ -294,12 +294,12 @@ 
 			'%%SourceCode%%' => $source,
 			'%%StackTrace%%' => htmlspecialchars($this->getExactTraceAsString($exception)),
 			'%%Version%%' => $version,
-			'%%Time%%' => @strftime('%Y-%m-%d %H:%M',time())
+			'%%Time%%' => @strftime('%Y-%m-%d %H:%M', time())
 		);
 
 		$content=$this->getExceptionTemplate($exception);
 
-		echo strtr($content,$tokens);
+		echo strtr($content, $tokens);
 	}
 
 	/**
@@ -336,7 +336,7 @@ 
 	 * @param Exception the exception to be displayed
 	 * @return string the template content
 	 */
-	protected function getErrorTemplate($statusCode,$exception)
+	protected function getErrorTemplate($statusCode, $exception)
 	{
 		$base=$this->getErrorTemplatePath().DIRECTORY_SEPARATOR.self::ERROR_FILE_NAME;
 		$lang=Prado::getPreferredLanguage();
@@ -359,7 +359,7 @@ 
 		if($exception instanceof TPhpFatalErrorException && 
 			function_exists('xdebug_get_function_stack'))
 		{
-			$trace = array_slice(array_reverse(xdebug_get_function_stack()), self::FATAL_ERROR_TRACE_DROP_LINES, -1);
+			$trace=array_slice(array_reverse(xdebug_get_function_stack()), self::FATAL_ERROR_TRACE_DROP_LINES, -1);
 		} else {
 			$trace=$exception->getTrace();
 		}
@@ -373,10 +373,10 @@ 
 				$result=$trace[1];
 		} elseif($exception instanceof TInvalidOperationException) {
 			// in case of getter or setter error, find out the exact file and row
-			if(($result=$this->getPropertyAccessTrace($trace,'__get'))===null)
-				$result=$this->getPropertyAccessTrace($trace,'__set');
+			if(($result=$this->getPropertyAccessTrace($trace, '__get'))===null)
+				$result=$this->getPropertyAccessTrace($trace, '__set');
 		}
-		if($result!==null && strpos($result['file'],': eval()\'d code')!==false)
+		if($result!==null && strpos($result['file'], ': eval()\'d code')!==false)
 			return null;
 
 		return $result;
@@ -387,19 +387,19 @@ 
 		if($exception instanceof TPhpFatalErrorException && 
 			function_exists('xdebug_get_function_stack'))
 		{
-			$trace = array_slice(array_reverse(xdebug_get_function_stack()), self::FATAL_ERROR_TRACE_DROP_LINES, -1);
-			$txt = '';
-			$row = 0;
+			$trace=array_slice(array_reverse(xdebug_get_function_stack()), self::FATAL_ERROR_TRACE_DROP_LINES, -1);
+			$txt='';
+			$row=0;
 
 			// try to mimic Exception::getTraceAsString()
 			foreach($trace as $line)
 			{
 				if(array_key_exists('function', $line))
-					$func = $line['function'] . '(' . implode(',', $line['params']) . ')';
+					$func=$line['function'].'('.implode(',', $line['params']).')';
 				else
-					$func = 'unknown';
+					$func='unknown';
 
-				$txt .= '#' . $row . ' ' . $line['file'] . '(' . $line['line'] . '): ' . $func . "\n";
+				$txt.='#'.$row.' '.$line['file'].'('.$line['line'].'): '.$func."\n";
 				$row++;
 			}
 
@@ -409,7 +409,7 @@ 
 		return $exception->getTraceAsString();
 	}
 
-	private function getPropertyAccessTrace($trace,$pattern)
+	private function getPropertyAccessTrace($trace, $pattern)
 	{
 		$result=null;
 		foreach($trace as $t)
@@ -422,46 +422,46 @@ 
 		return $result;
 	}
 
-	private function getSourceCode($lines,$errorLine)
+	private function getSourceCode($lines, $errorLine)
 	{
-		$beginLine=$errorLine-self::SOURCE_LINES>=0?$errorLine-self::SOURCE_LINES:0;
-		$endLine=$errorLine+self::SOURCE_LINES<=count($lines)?$errorLine+self::SOURCE_LINES:count($lines);
+		$beginLine=$errorLine - self::SOURCE_LINES >= 0 ? $errorLine - self::SOURCE_LINES : 0;
+		$endLine=$errorLine + self::SOURCE_LINES <= count($lines) ? $errorLine + self::SOURCE_LINES : count($lines);
 
 		$source='';
-		for($i=$beginLine;$i<$endLine;++$i)
+		for($i=$beginLine; $i < $endLine; ++$i)
 		{
-			if($i===$errorLine-1)
+			if($i===$errorLine - 1)
 			{
-				$line=htmlspecialchars(sprintf("%04d: %s",$i+1,str_replace("\t",'    ',$lines[$i])));
+				$line=htmlspecialchars(sprintf("%04d: %s", $i + 1, str_replace("\t", '    ', $lines[$i])));
 				$source.="<div class=\"error\">".$line."</div>";
 			}
 			else
-				$source.=htmlspecialchars(sprintf("%04d: %s",$i+1,str_replace("\t",'    ',$lines[$i])));
+				$source.=htmlspecialchars(sprintf("%04d: %s", $i + 1, str_replace("\t", '    ', $lines[$i])));
 		}
 		return $source;
 	}
 
 	private function addLink($message) {
-		if (!is_null($class = $this->getErrorClassNameSpace($message))) {
-			return str_replace($class['name'], '<a href="' . $class['url'] . '" target="_blank">' . $class['name'] . '</a>', $message);
+		if(!is_null($class=$this->getErrorClassNameSpace($message))) {
+			return str_replace($class['name'], '<a href="'.$class['url'].'" target="_blank">'.$class['name'].'</a>', $message);
 		}
 		return $message;
 	}
 
 	private function getErrorClassNameSpace($message) {
-		$matches = [];
+		$matches=[];
 		preg_match('/\b(T[A-Z]\w+)\b/', $message, $matches);
-		if (is_array($matches) && count($matches) > 0) {
-			$class = $matches[0];
+		if(is_array($matches) && count($matches) > 0) {
+			$class=$matches[0];
 			try {
-				$function = new \ReflectionClass($class);
+				$function=new \ReflectionClass($class);
 			}
-			catch (\Exception $e) {
+			catch(\Exception $e) {
 				return null;
 			}
-			$classname = $function->getNamespaceName();
+			$classname=$function->getNamespaceName();
 			return [
-			    'url' => 'http://pradosoft.github.io/docs/manual/class-' . str_replace('\\', '.', (string) $classname) . '.' . $class . '.html',
+			    'url' => 'http://pradosoft.github.io/docs/manual/class-'.str_replace('\\', '.', (string) $classname).'.'.$class.'.html',
 			    'name' => $class,
 			];
 		}

Braces +5 added lines, -10 removed lines

@@ -234,8 +234,7 @@ 
 			echo "<body><h1>Recursive Error</h1>\n";
 			echo "<pre>".$exception->__toString()."</pre>\n";
 			echo "</body></html>";
-		}
-		else
+		} else
 		{
 			error_log("Error happened while processing an existing error:\n".$exception->__toString());
 			header('HTTP/1.0 500 Internal Error');
@@ -266,15 +265,13 @@ 
 			if($fileName==='')
 				$fileName='---embedded template---';
 			$errorLine=$exception->getLineNumber();
-		}
-		else
+		} else
 		{
 			if(($trace=$this->getExactTrace($exception))!==null)
 			{
 				$fileName=$trace['file'];
 				$errorLine=$trace['line'];
-			}
-			else
+			} else
 			{
 				$fileName=$exception->getFile();
 				$errorLine=$exception->getLine();
@@ -434,8 +431,7 @@ 
 			{
 				$line=htmlspecialchars(sprintf("%04d: %s",$i+1,str_replace("\t",'    ',$lines[$i])));
 				$source.="<div class=\"error\">".$line."</div>";
-			}
-			else
+			} else
 				$source.=htmlspecialchars(sprintf("%04d: %s",$i+1,str_replace("\t",'    ',$lines[$i])));
 		}
 		return $source;
@@ -455,8 +451,7 @@ 
 			$class = $matches[0];
 			try {
 				$function = new \ReflectionClass($class);
-			}
-			catch (\Exception $e) {
+			} catch (\Exception $e) {
 				return null;
 			}
 			$classname = $function->getNamespaceName();