tnhfw / tnh-fw

core/classes/Response.php

Spacing +77 added lines, -77 removed lines

@@ -24,7 +24,7 @@ 
 	 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 	*/
 
-	class Response{
+	class Response {
 
 		/**
 		 * The list of request header to send with response
@@ -65,15 +65,15 @@ 
 		/**
 		 * Construct new response instance
 		 */
-		public function __construct(){
+		public function __construct() {
 			$currentUrl = '';
-			if (! empty($_SERVER['REQUEST_URI'])){
+			if (!empty($_SERVER['REQUEST_URI'])) {
 				$currentUrl = $_SERVER['REQUEST_URI'];
 			}
-			if (! empty($_SERVER['QUERY_STRING'])){
+			if (!empty($_SERVER['QUERY_STRING'])) {
 				$currentUrl .= '?' . $_SERVER['QUERY_STRING'];
 			}
-			$this->_currentUrl =  $currentUrl;
+			$this->_currentUrl = $currentUrl;
 					
 			$this->_currentUrlCacheKey = md5($this->_currentUrl);
 			
@@ -89,10 +89,10 @@ 
 		 * The signleton of the logger
 		 * @return Object the Log instance
 		 */
-		public static function getLogger(){
-			if(self::$logger == null){
+		public static function getLogger() {
+			if (self::$logger == null) {
 				$logger = array();
-				$logger[0] =& class_loader('Log', 'classes');
+				$logger[0] = & class_loader('Log', 'classes');
 				$logger[0]->setLogger('Library::Response');
 				self::$logger = $logger[0];
 			}
@@ -104,7 +104,7 @@ 
 		 * @param object $logger the log object
 		 * @return object the log instance
 		 */
-		public static function setLogger($logger){
+		public static function setLogger($logger) {
 			self::$logger = $logger;
 			return self::$logger;
 		}
@@ -115,12 +115,12 @@ 
 		 * @param  integer $httpCode the HTTP status code
 		 * @param  array   $headers   the additional headers to add to the existing headers list
 		 */
-		public static function sendHeaders($httpCode = 200, array $headers = array()){
+		public static function sendHeaders($httpCode = 200, array $headers = array()) {
 			set_http_status_header($httpCode);
 			self::setHeaders($headers);
-			if(! headers_sent()){
-				foreach(self::getHeaders() as $key => $value){
-					header($key .': '.$value);
+			if (!headers_sent()) {
+				foreach (self::getHeaders() as $key => $value) {
+					header($key . ': ' . $value);
 				}
 			}
 		}
@@ -129,7 +129,7 @@ 
 		 * Get the list of the headers
 		 * @return array the headers list
 		 */
-		public static function getHeaders(){
+		public static function getHeaders() {
 			return self::$headers;
 		}
 
@@ -138,8 +138,8 @@ 
 		 * @param  string $name the header name
 		 * @return string|null       the header value
 		 */
-		public static function getHeader($name){
-			if(array_key_exists($name, self::$headers)){
+		public static function getHeader($name) {
+			if (array_key_exists($name, self::$headers)) {
 				return self::$headers[$name];
 			}
 			return null;
@@ -151,7 +151,7 @@ 
 		 * @param string $name  the header name
 		 * @param string $value the header value to be set
 		 */
-		public static function setHeader($name, $value){
+		public static function setHeader($name, $value) {
 			self::$headers[$name] = $value;
 		}
 
@@ -160,7 +160,7 @@ 
 		 * @param array $headers the list of the headers to set. 
 		 * Note: this will merge with the existing headers
 		 */
-		public static function setHeaders(array $headers){
+		public static function setHeaders(array $headers) {
 			self::$headers = array_merge(self::getHeaders(), $headers);
 		}
 		
@@ -168,16 +168,16 @@ 
 		 * Redirect user to the specified page
 		 * @param  string $path the URL or URI to be redirect to
 		 */
-		public static function redirect($path = ''){
+		public static function redirect($path = '') {
 			$logger = self::getLogger();
 			$url = Url::site_url($path);
-			$logger->info('Redirect to URL [' .$url. ']');
-			if(! headers_sent()){
-				header('Location: '.$url);
+			$logger->info('Redirect to URL [' . $url . ']');
+			if (!headers_sent()) {
+				header('Location: ' . $url);
 				exit;
 			}
 			echo '<script>
-					location.href = "'.$url.'";
+					location.href = "'.$url . '";
 				</script>';
 		}
 
@@ -189,7 +189,7 @@ 
 		 * @return void|string          if $return is true will return the view content otherwise
 		 * will display the view content.
 		 */
-		public function render($view, $data = null, $return = false){
+		public function render($view, $data = null, $return = false) {
 			$logger = self::getLogger();
 			//convert data to an array
 			$data = (array) $data;
@@ -201,22 +201,22 @@ 
 			//check in module first
 			$logger->debug('Checking the view [' . $view . '] from module list ...');
 			$moduleInfo = $this->getModuleInfoForView($view);
-			$module    = $moduleInfo['module'];
-			$view  = $moduleInfo['view'];
+			$module = $moduleInfo['module'];
+			$view = $moduleInfo['view'];
 			
 			$moduleViewPath = Module::findViewFullPath($view, $module);
-			if($moduleViewPath){
+			if ($moduleViewPath) {
 				$path = $moduleViewPath;
-				$logger->info('Found view [' . $view . '] in module [' .$module. '], the file path is [' .$moduleViewPath. '] we will used it');
+				$logger->info('Found view [' . $view . '] in module [' . $module . '], the file path is [' . $moduleViewPath . '] we will used it');
 			}
-			else{
-				$logger->info('Cannot find view [' . $view . '] in module [' .$module. '] using the default location');
+			else {
+				$logger->info('Cannot find view [' . $view . '] in module [' . $module . '] using the default location');
 			}
 			
 			$logger->info('The view file path to be loaded is [' . $path . ']');
 			
 			/////////
-			if($return){
+			if ($return) {
 				return $this->loadView($path, $data, true);
 			}
 			$this->loadView($path, $data, false);
@@ -226,28 +226,28 @@ 
 		/**
 		* Send the final page output to user
 		*/
-		public function renderFinalPage(){
+		public function renderFinalPage() {
 			$logger = self::getLogger();
 			$obj = & get_instance();
 			$cachePageStatus = get_config('cache_enable', false) && !empty($obj->view_cache_enable);
 			$dispatcher = $obj->eventdispatcher;
 			$content = $this->_pageRender;
-			if(! $content){
+			if (!$content) {
 				$logger->warning('The final view content is empty.');
 				return;
 			}
 			//dispatch
 			$event = $dispatcher->dispatch(new EventInfo('FINAL_VIEW_READY', $content, true));
 			$content = null;
-			if(! empty($event->payload)){
+			if (!empty($event->payload)) {
 				$content = $event->payload;
 			}
-			if(empty($content)){
+			if (empty($content)) {
 				$logger->warning('The view content is empty after dispatch to event listeners.');
 			}
 			
 			//check whether need save the page into cache.
-			if($cachePageStatus){
+			if ($cachePageStatus) {
 				$this->savePageContentIntoCache($content);
 			}
 			
@@ -259,7 +259,7 @@ 
 			
 			//compress the output if is available
 			$type = null;
-			if (self::$_canCompressOutput){
+			if (self::$_canCompressOutput) {
 				$type = 'ob_gzhandler';
 			}
 			ob_start($type);
@@ -275,7 +275,7 @@ 
 		*
 		* @return boolean whether the page content if available or not
 		*/
-		public function renderFinalPageFromCache(&$cache){
+		public function renderFinalPageFromCache(&$cache) {
 			$logger = self::getLogger();
 			//the current page cache key for identification
 			$pageCacheKey = $this->_currentUrlCacheKey;
@@ -283,9 +283,9 @@ 
 			$logger->debug('Checking if the page content for the URL [' . $this->_currentUrl . '] is cached ...');
 			//get the cache information to prepare header to send to browser
 			$cacheInfo = $cache->getInfo($pageCacheKey);
-			if($cacheInfo){
+			if ($cacheInfo) {
 				$status = $this->sendCacheNotYetExpireInfo($cacheInfo);
-				if($status === false){
+				if ($status === false) {
 					return $this->sendPageContentToBrowser($cache);
 				}
 			}
@@ -297,7 +297,7 @@ 
 		* Get the final page to be rendered
 		* @return string
 		*/
-		public function getFinalPageRendered(){
+		public function getFinalPageRendered() {
 			return $this->_pageRender;
 		}
 
@@ -305,14 +305,14 @@ 
 		 * Send the HTTP 404 error if can not found the 
 		 * routing information for the current request
 		 */
-		public static function send404(){
+		public static function send404() {
 			/********* for logs **************/
 			//can't use $obj = & get_instance()  here because the global super object will be available until
 			//the main controller is loaded even for Loader::library('xxxx');
 			$logger = self::getLogger();
-			$request =& class_loader('Request', 'classes');
-			$userAgent =& class_loader('Browser');
-			$browser = $userAgent->getPlatform().', '.$userAgent->getBrowser().' '.$userAgent->getVersion();
+			$request = & class_loader('Request', 'classes');
+			$userAgent = & class_loader('Browser');
+			$browser = $userAgent->getPlatform() . ', ' . $userAgent->getBrowser() . ' ' . $userAgent->getVersion();
 			
 			//here can't use Loader::functions just include the helper manually
 			require_once CORE_FUNCTIONS_PATH . 'function_user_agent.php';
@@ -322,10 +322,10 @@ 
 			$logger->error($str);
 			/***********************************/
 			$path = CORE_VIEWS_PATH . '404.php';
-			if(file_exists($path)){
+			if (file_exists($path)) {
 				//compress the output if is available
 				$type = null;
-				if (self::$_canCompressOutput){
+				if (self::$_canCompressOutput) {
 					$type = 'ob_gzhandler';
 				}
 				ob_start($type);
@@ -334,8 +334,8 @@ 
 				self::sendHeaders(404);
 				echo $output;
 			}
-			else{
-				show_error('The 404 view [' .$path. '] does not exist');
+			else {
+				show_error('The 404 view [' . $path . '] does not exist');
 			}
 		}
 
@@ -343,12 +343,12 @@ 
 		 * Display the error to user
 		 * @param  array  $data the error information
 		 */
-		public static function sendError(array $data = array()){
+		public static function sendError(array $data = array()) {
 			$path = CORE_VIEWS_PATH . 'errors.php';
-			if(file_exists($path)){
+			if (file_exists($path)) {
 				//compress the output if is available
 				$type = null;
-				if (self::$_canCompressOutput){
+				if (self::$_canCompressOutput) {
 					$type = 'ob_gzhandler';
 				}
 				ob_start($type);
@@ -358,7 +358,7 @@ 
 				self::sendHeaders(503);
 				echo $output;
 			}
-			else{
+			else {
 				//can't use show_error() at this time because some dependencies not yet loaded and to prevent loop
 				set_http_status_header(503);
 				echo 'The error view [' . $path . '] does not exist';
@@ -370,17 +370,17 @@ 
 		 * @param  array $cacheInfo the cache information
 		 * @return boolean            true if the information is sent otherwise false
 		 */
-		protected function sendCacheNotYetExpireInfo($cacheInfo){
-			if(! empty($cacheInfo)){
+		protected function sendCacheNotYetExpireInfo($cacheInfo) {
+			if (!empty($cacheInfo)) {
 				$logger = self::getLogger();
 				$lastModified = $cacheInfo['mtime'];
 				$expire = $cacheInfo['expire'];
 				$maxAge = $expire - $_SERVER['REQUEST_TIME'];
 				self::setHeader('Pragma', 'public');
 				self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
-				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
-				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');
-				if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])){
+				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire) . ' GMT');
+				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT');
+				if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && $lastModified <= strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
 					$logger->info('The cache page content is not yet expire for the URL [' . $this->_currentUrl . '] send 304 header to browser');
 					self::sendHeaders(304);
 					return true;
@@ -394,7 +394,7 @@ 
 		 * @param object $cache the cache instance
 		 * @return boolean     the status of the operation
 		 */
-		protected function sendPageContentToBrowser(&$cache){
+		protected function sendPageContentToBrowser(&$cache) {
 			$logger = self::getLogger();
 			$logger->info('The cache page content is expired or the browser doesn\'t send the HTTP_IF_MODIFIED_SINCE header for the URL [' . $this->_currentUrl . '] send cache headers to tell the browser');
 			self::sendHeaders(200);
@@ -402,7 +402,7 @@ 
 			$pageCacheKey = $this->_currentUrlCacheKey;
 			//get the cache content
 			$content = $cache->get($pageCacheKey);
-			if($content){
+			if ($content) {
 				$logger->info('The page content for the URL [' . $this->_currentUrl . '] already cached just display it');
 				//load benchmark class
 				$benchmark = & class_loader('Benchmark');
@@ -416,7 +416,7 @@ 
 				///display the final output
 				//compress the output if is available
 				$type = null;
-				if (self::$_canCompressOutput){
+				if (self::$_canCompressOutput) {
 					$type = 'ob_gzhandler';
 				}
 				ob_start($type);
@@ -434,7 +434,7 @@ 
 		 * @param  string $content the page content to be saved
 		 * @return void
 		 */
-		protected function savePageContentIntoCache($content){
+		protected function savePageContentIntoCache($content) {
 			$obj = & get_instance();
 			$logger = self::getLogger();
 
@@ -442,7 +442,7 @@ 
 			$url = $this->_currentUrl;
 			//Cache view Time to live in second
 			$viewCacheTtl = get_config('cache_ttl');
-			if (!empty($obj->view_cache_ttl)){
+			if (!empty($obj->view_cache_ttl)) {
 				$viewCacheTtl = $obj->view_cache_ttl;
 			}
 			//the cache handler instance
@@ -455,14 +455,14 @@ 
 			
 			//get the cache information to prepare header to send to browser
 			$cacheInfo = $cacheInstance->getInfo($cacheKey);
-			if($cacheInfo){
+			if ($cacheInfo) {
 				$lastModified = $cacheInfo['mtime'];
 				$expire = $cacheInfo['expire'];
 				$maxAge = $expire - time();
 				self::setHeader('Pragma', 'public');
 				self::setHeader('Cache-Control', 'max-age=' . $maxAge . ', public');
-				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire).' GMT');
-				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified).' GMT');	
+				self::setHeader('Expires', gmdate('D, d M Y H:i:s', $expire) . ' GMT');
+				self::setHeader('Last-modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT');	
 			}
 		}
 		
@@ -478,21 +478,21 @@ 
 		 * 	'viewFile' => 'view_file'
 		 * )
 		 */
-		protected  function getModuleInfoForView($view){
+		protected  function getModuleInfoForView($view) {
 			$module = null;
 			$viewFile = null;
 			$obj = & get_instance();
 			//check if the request class contains module name
-			if(strpos($view, '/') !== false){
+			if (strpos($view, '/') !== false) {
 				$viewPath = explode('/', $view);
-				if(isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())){
+				if (isset($viewPath[0]) && in_array($viewPath[0], Module::getModuleList())) {
 					$module = $viewPath[0];
 					array_shift($viewPath);
 					$view = implode('/', $viewPath);
 					$viewFile = $view . '.php';
 				}
 			}
-			if(! $module && !empty($obj->moduleName)){
+			if (!$module && !empty($obj->moduleName)) {
 				$module = $obj->moduleName;
 			}
 			return array(
@@ -507,13 +507,13 @@ 
 		 * @see  Response::render
 		 * @return void|string
 		 */
-		protected  function loadView($path, array $data = array(), $return = false){
+		protected  function loadView($path, array $data = array(), $return = false) {
 			$found = false;
-			if(file_exists($path)){
+			if (file_exists($path)) {
 				//super instance
 				$obj = & get_instance();
-				foreach(get_object_vars($obj) as $key => $value){
-					if(! isset($this->{$key})){
+				foreach (get_object_vars($obj) as $key => $value) {
+					if (!isset($this->{$key})) {
 						$this->{$key} = & $obj->{$key};
 					}
 				}
@@ -522,14 +522,14 @@ 
 				//need use require() instead of require_once because can load this view many time
 				require $path;
 				$content = ob_get_clean();
-				if($return){
+				if ($return) {
 					return $content;
 				}
 				$this->_pageRender .= $content;
 				$found = true;
 			}
-			if(! $found){
-				show_error('Unable to find view [' .$view . ']');
+			if (!$found) {
+				show_error('Unable to find view [' . $view . ']');
 			}
 		}