Erdiko / core

src/cache/Memcached.php

Doc Comments +3 added lines, -3 removed lines

@@ -49,7 +49,7 @@ 
     /**
      *  Get Cache Object
      *
-     *  @return Memcache $memcacheObj
+     *  @return \Memcached $memcacheObj
      *  @note   Please do not modify data if you use the put function in this class
      */
     public function getObject()
@@ -105,8 +105,8 @@ 
      *  Check if the key exists in cache
      *
      *  @parm mixed $key
-     *  @return true if the key exist in cache
-     *  @return false if the key does not exist in cache
+     *  @return boolean if the key exist in cache
+     *  @return boolean if the key does not exist in cache
      *
      */
     public function has($key)

Spacing +2 added lines, -2 removed lines

@@ -31,8 +31,8 @@
         $this->memcacheObj = new \Memcached;
 
         $config = \erdiko\core\Helper::getConfig("local/cache");
-        $host=$config["memcached"]["host"];
-        $port=$config["memcached"]["port"];
+        $host = $config["memcached"]["host"];
+        $port = $config["memcached"]["port"];
         $cacheAvailable = $this->memcacheObj->addServer($host, $port);
 
     }

src/Controller.php

Doc Comments +4 added lines, -4 removed lines

@@ -187,7 +187,7 @@ 
     /**
      * Get Response object
      *
-     * @return ResponseObject
+     * @return Response
      */
     public function getResponse()
     {
@@ -248,7 +248,6 @@ 
     /**
      * Get page content title to be themed in a layout or view
      *
-     * @param string $title
      */
     public function getBodyTitle()
     {
@@ -267,7 +266,6 @@ 
 
     /**
      * Set both the title (header) and page title (body) at the same time
-     * @param string $title
      */
     public function getTitle()
     {
@@ -323,6 +321,8 @@ 
     /**
      * Modify the action name coming from the URL into proper action name
      * @param string $name: The raw controller action name
+     * @param string $name
+     * @param string $httpMethod
      * @return string
      */
     public function urlToActionName($name, $httpMethod)
@@ -338,7 +338,7 @@ 
      *
      * @param string $viewName
      * @param array $data
-     * @return string $html, view contents
+     * @return View $html, view contents
      */
     public function getView($viewName, $data = null, $templateRootFolder = null)
     {

Indentation +1 added lines, -1 removed lines

@@ -429,7 +429,7 @@
      */
     public function addCss($name, $file, $order = 10, $active = 1)
     {
-       $this->getResponse()
+        $this->getResponse()
             ->getTheme()
             ->addCss($name, $file, $order,$active);
     }

Spacing +5 added lines, -5 removed lines

@@ -360,9 +360,9 @@ 
      */
     public function addView($view, $data = null)
     {
-        if(!is_object($view))
+        if (!is_object($view))
             $view = new \erdiko\core\View($view, $data);
-        if($data != null)
+        if ($data != null)
             $view->setData($data);
         
         $this->appendContent($view->toHtml());
@@ -415,7 +415,7 @@ 
      */
     public function setMeta($meta)
     {
-        foreach($meta as $name => $content)
+        foreach ($meta as $name => $content)
             $this->getResponse()->getTheme()->addMeta($name, $content);
     }
 
@@ -431,7 +431,7 @@ 
     {
        $this->getResponse()
             ->getTheme()
-            ->addCss($name, $file, $order,$active);
+            ->addCss($name, $file, $order, $active);
     }
 
     /**
@@ -446,7 +446,7 @@ 
     {
         $this->getResponse()
             ->getTheme()
-            ->addJs($name, $file, $order,$active);
+            ->addJs($name, $file, $order, $active);
     }
     
     /**

Braces +9 added lines, -6 removed lines

@@ -360,10 +360,12 @@ 
      */
     public function addView($view, $data = null)
     {
-        if(!is_object($view))
-            $view = new \erdiko\core\View($view, $data);
-        if($data != null)
-            $view->setData($data);
+        if(!is_object($view)) {
+                    $view = new \erdiko\core\View($view, $data);
+        }
+        if($data != null) {
+                    $view->setData($data);
+        }
         
         $this->appendContent($view->toHtml());
     }
@@ -415,8 +417,9 @@ 
      */
     public function setMeta($meta)
     {
-        foreach($meta as $name => $content)
-            $this->getResponse()->getTheme()->addMeta($name, $content);
+        foreach($meta as $name => $content) {
+                    $this->getResponse()->getTheme()->addMeta($name, $content);
+        }
     }
 
     /**

src/datasource/File.php

Doc Comments +4 added lines, -4 removed lines

@@ -120,8 +120,8 @@ 
      *
      * @param string $filename
      * @param string $pathTo
-     * @param string $pathToFrom
-     * @return bool
+     * @param string $pathFrom
+     * @return boolean|null
      */
     public function move($filename, $pathTo, $pathFrom = null)
     {
@@ -140,8 +140,8 @@ 
      * Rename a file
      *
      * @param string $oldName
-     * @param string $pathTo
-     * @param string $pathToFrom
+     * @param string $pathToFile
+     * @param string $pathToFile
      * @return bool
      * @todo consider merging rename() and move() into one method
      */

Indentation +4 added lines, -4 removed lines

@@ -22,10 +22,10 @@
     protected $_filePath = null;
     
     /**
-    * Contructor
-    *
-    * @param string $defaultPath
-    */
+     * Contructor
+     *
+     * @param string $defaultPath
+     */
     public function __construct($defaultPath = null)
     {
         if (isset($defaultPath)) {

Spacing +17 added lines, -17 removed lines

@@ -29,10 +29,10 @@ 
     public function __construct($defaultPath = null)
     {
         if (isset($defaultPath)) {
-            $this->_filePath=$defaultPath;
+            $this->_filePath = $defaultPath;
         } else {
-            $rootFolder=dirname(dirname(dirname(__DIR__)));
-            $this->_filePath=$rootFolder."/var";
+            $rootFolder = dirname(dirname(dirname(__DIR__)));
+            $this->_filePath = $rootFolder."/var";
         }
         if (!is_dir($this->_filePath)) {
             mkdir($this->_filePath, 0775, true);
@@ -86,10 +86,10 @@ 
      */
     public function read($filename, $pathToFile = null)
     {
-        if(!$this->fileExists($filename, $pathToFile))
+        if (!$this->fileExists($filename, $pathToFile))
             throw new \Exception("File, '{$filename}', does not exist.");
 
-        if ($pathToFile==null) {
+        if ($pathToFile == null) {
             return file_get_contents($this->_filePath."/".$filename);
         } else {
             return file_get_contents($pathToFile."/".$filename);
@@ -105,8 +105,8 @@ 
      */
     public function delete($filename, $pathToFile = null)
     {
-        if ($pathToFile==null) {
-            $pathToFile=$this->_filePath;
+        if ($pathToFile == null) {
+            $pathToFile = $this->_filePath;
         }
         if (file_exists($pathToFile."/".$filename)) {
             return unlink($pathToFile."/".$filename);
@@ -125,8 +125,8 @@ 
      */
     public function move($filename, $pathTo, $pathFrom = null)
     {
-        if ($pathFrom==null) {
-            $pathFrom=$this->_filePath;
+        if ($pathFrom == null) {
+            $pathFrom = $this->_filePath;
         }
         if (file_exists($pathFrom."/".$filename)) {
             $this->createDir($pathTo);
@@ -147,8 +147,8 @@ 
      */
     public function rename($oldName, $newName, $pathToFile = null)
     {
-        if ($pathToFile==null) {
-            $pathToFile=$this->_filePath;
+        if ($pathToFile == null) {
+            $pathToFile = $this->_filePath;
         }
         if (file_exists($pathToFile."/".$oldName)) {
             $this->createDir($pathToFile);
@@ -169,11 +169,11 @@ 
      */
     public function copy($filename, $newFilePath, $newFileName = null, $pathToFile = null)
     {
-        if ($pathToFile==null) {
-            $pathToFile=$this->_filePath;
+        if ($pathToFile == null) {
+            $pathToFile = $this->_filePath;
         }
-        if ($newFileName==null) {
-            $newFileName=$filename;
+        if ($newFileName == null) {
+            $newFileName = $filename;
         }
         if (file_exists($pathToFile."/".$filename)) {
             return copy($pathToFile."/".$filename, $newFilePath."/".$newFileName);
@@ -191,8 +191,8 @@ 
      */
     public function fileExists($filename, $pathToFile = null)
     {
-        if ($pathToFile==null) {
-            $pathToFile=$this->_filePath;
+        if ($pathToFile == null) {
+            $pathToFile = $this->_filePath;
         }
         return file_exists($pathToFile."/".$filename);
     }

Braces +3 added lines, -2 removed lines

@@ -86,8 +86,9 @@
      */
     public function read($filename, $pathToFile = null)
     {
-        if(!$this->fileExists($filename, $pathToFile))
-            throw new \Exception("File, '{$filename}', does not exist.");
+        if(!$this->fileExists($filename, $pathToFile)) {
+                    throw new \Exception("File, '{$filename}', does not exist.");
+        }
 
         if ($pathToFile==null) {
             return file_get_contents($this->_filePath."/".$filename);

src/ErrorHandler.php

Doc Comments +3 added lines

@@ -22,6 +22,9 @@
 		register_shutdown_function("\\erdiko\\core\\ErrorHandler::fatalErrorShutdownHandler");
 	}
 
+	/**
+	 * @param integer $errno
+	 */
 	public static function errorHandler($errno, $errstr, $errfile, $errline)
 	{
 		$debug = \erdiko\core\ErrorHandler::isDebug();

Indentation +56 added lines, -56 removed lines

@@ -14,73 +14,73 @@
 
 class ErrorHandler 
 {
-	public static function init()
-	{
-		ini_set('html_errors',0); // @todo review this line
-		// error_reporting((E_ALL | E_STRICT)); // @note we shouldn't override by default, but we could inject
-		set_error_handler("\\erdiko\\core\\ErrorHandler::errorHandler");
-		register_shutdown_function("\\erdiko\\core\\ErrorHandler::fatalErrorShutdownHandler");
-	}
+    public static function init()
+    {
+        ini_set('html_errors',0); // @todo review this line
+        // error_reporting((E_ALL | E_STRICT)); // @note we shouldn't override by default, but we could inject
+        set_error_handler("\\erdiko\\core\\ErrorHandler::errorHandler");
+        register_shutdown_function("\\erdiko\\core\\ErrorHandler::fatalErrorShutdownHandler");
+    }
 
-	public static function errorHandler($errno, $errstr, $errfile, $errline)
-	{
-		$debug = \erdiko\core\ErrorHandler::isDebug();
-		if ( ! ( error_reporting() & $errno ) || empty( $errstr ) ) {
-			return null;
-		}
+    public static function errorHandler($errno, $errstr, $errfile, $errline)
+    {
+        $debug = \erdiko\core\ErrorHandler::isDebug();
+        if ( ! ( error_reporting() & $errno ) || empty( $errstr ) ) {
+            return null;
+        }
 
         $errorHook = "500";
 
-		switch ( $errno ) {
-			case E_USER_ERROR:
-				$vars['msg_type']        = "USER ERROR";
-				$vars['msg_description'] = " Fatal error in line $errline of $errfile file";
-				$vars['msg_description'] .= ", PHP " . PHP_VERSION . " (" . PHP_OS . ")";
-				break;
+        switch ( $errno ) {
+            case E_USER_ERROR:
+                $vars['msg_type']        = "USER ERROR";
+                $vars['msg_description'] = " Fatal error in line $errline of $errfile file";
+                $vars['msg_description'] .= ", PHP " . PHP_VERSION . " (" . PHP_OS . ")";
+                break;
 
-			case E_USER_WARNING:
-				$vars['msg_type'] = "USER WARNING";
-				break;
+            case E_USER_WARNING:
+                $vars['msg_type'] = "USER WARNING";
+                break;
 
-			case E_USER_NOTICE:
-				$vars['msg_type'] = "USER NOTICE";
-				break;
+            case E_USER_NOTICE:
+                $vars['msg_type'] = "USER NOTICE";
+                break;
 
-			case E_ERROR:
-				$vars['msg_type'] = "ERROR";
-				$vars['msg_description'] = print_r(debug_backtrace(),1);
-				break;
+            case E_ERROR:
+                $vars['msg_type'] = "ERROR";
+                $vars['msg_description'] = print_r(debug_backtrace(),1);
+                break;
 
-			default:
-				$vars['msg_type'] = "Type of error: [$errno] $errstr";
-				$vars['msg_description'] = print_r(debug_backtrace(),1);
-				break;
-		}
+            default:
+                $vars['msg_type'] = "Type of error: [$errno] $errstr";
+                $vars['msg_description'] = print_r(debug_backtrace(),1);
+                break;
+        }
 
-		$vars['code']               = $errno;
-		$vars['error']              = trim($errstr);
-		$vars['path_info']          = $errfile . " on line " . $errline;
-        	$vars['debug']              = $debug;
+        $vars['code']               = $errno;
+        $vars['error']              = trim($errstr);
+        $vars['path_info']          = $errfile . " on line " . $errline;
+            $vars['debug']              = $debug;
 
-        	ToroHook::fire($errorHook, $vars );
+            ToroHook::fire($errorHook, $vars );
 
-		return false;
-	}
+        return false;
+    }
 
-	public static function fatalErrorShutdownHandler()
-	{
-		$last_error = error_get_last();
-		static::errorHandler(E_ERROR, 
-			$last_error['message'], $last_error['file'], $last_error['line']);
-	}
+    public static function fatalErrorShutdownHandler()
+    {
+        $last_error = error_get_last();
+        static::errorHandler(E_ERROR, 
+            $last_error['message'], $last_error['file'], $last_error['line']);
+    }
 
-	/**
-	 * isDebug
-	 *
-	 * @return bool
-	 */
-	public static function isDebug()
-	{
-		return (getenv("ERDIKO_DEBUG")=='1');
-	}
+    /**
+     * isDebug
+     *
+     * @return bool
+     */
+    public static function isDebug()
+    {
+        return (getenv("ERDIKO_DEBUG")=='1');
+    }
 }

Spacing +10 added lines, -10 removed lines

@@ -16,7 +16,7 @@ 
 {
 	public static function init()
 	{
-		ini_set('html_errors',0); // @todo review this line
+		ini_set('html_errors', 0); // @todo review this line
 		// error_reporting((E_ALL | E_STRICT)); // @note we shouldn't override by default, but we could inject
 		set_error_handler("\\erdiko\\core\\ErrorHandler::errorHandler");
 		register_shutdown_function("\\erdiko\\core\\ErrorHandler::fatalErrorShutdownHandler");
@@ -25,17 +25,17 @@ 
 	public static function errorHandler($errno, $errstr, $errfile, $errline)
 	{
 		$debug = \erdiko\core\ErrorHandler::isDebug();
-		if ( ! ( error_reporting() & $errno ) || empty( $errstr ) ) {
+		if (!(error_reporting() & $errno) || empty($errstr)) {
 			return null;
 		}
 
         $errorHook = "500";
 
-		switch ( $errno ) {
+		switch ($errno) {
 			case E_USER_ERROR:
 				$vars['msg_type']        = "USER ERROR";
 				$vars['msg_description'] = " Fatal error in line $errline of $errfile file";
-				$vars['msg_description'] .= ", PHP " . PHP_VERSION . " (" . PHP_OS . ")";
+				$vars['msg_description'] .= ", PHP ".PHP_VERSION." (".PHP_OS.")";
 				break;
 
 			case E_USER_WARNING:
@@ -48,21 +48,21 @@ 
 
 			case E_ERROR:
 				$vars['msg_type'] = "ERROR";
-				$vars['msg_description'] = print_r(debug_backtrace(),1);
+				$vars['msg_description'] = print_r(debug_backtrace(), 1);
 				break;
 
 			default:
 				$vars['msg_type'] = "Type of error: [$errno] $errstr";
-				$vars['msg_description'] = print_r(debug_backtrace(),1);
+				$vars['msg_description'] = print_r(debug_backtrace(), 1);
 				break;
 		}
 
 		$vars['code']               = $errno;
 		$vars['error']              = trim($errstr);
-		$vars['path_info']          = $errfile . " on line " . $errline;
-        	$vars['debug']              = $debug;
+		$vars['path_info']          = $errfile." on line ".$errline;
+        	$vars['debug'] = $debug;
 
-        	ToroHook::fire($errorHook, $vars );
+        	ToroHook::fire($errorHook, $vars);
 
 		return false;
 	}
@@ -81,6 +81,6 @@ 
 	 */
 	public static function isDebug()
 	{
-		return (getenv("ERDIKO_DEBUG")=='1');
+		return (getenv("ERDIKO_DEBUG") == '1');
 	}
 }

src/Layout.php

Doc Comments +1 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
      *
      * @param string $template , Theme Object (Contaier)
      * @param mixed $data
-     * @param string $theme
+     * @param string $themeName
      */
     public function __construct($template = null, $data = array(), $themeName = null)
     {
@@ -97,7 +97,6 @@ 
     /**
      * Get Theme Root Folder
      *
-     * @param string $folder
      */
     public function getThemeRootFolder()
     {

Spacing +1 added lines, -1 removed lines

@@ -171,7 +171,7 @@
      */
     public function getRegion($name)
     {
-        if(array_key_exists($name, $this->_regions)) {
+        if (array_key_exists($name, $this->_regions)) {
             $html = (is_subclass_of($this->_regions[$name], 'erdiko\core\Container')) ?
                 $this->_regions[$name]->toHtml() : $this->_regions[$name];
         } else {

src/Response.php

Doc Comments +4 added lines, -4 removed lines

@@ -40,7 +40,7 @@ 
     /**
      * Set key value data
      *
-     * @param mixed $key
+     * @param string $key
      * @param mixed $value
      */
     public function setKeyValue($key, $value)
@@ -51,7 +51,7 @@ 
     /**
      * Get data value by key
      *
-     * @param mixed $key
+     * @param string $key
      * @return mixed
      */
     public function getKeyValue($key)
@@ -73,7 +73,7 @@ 
     /**
      * Set theme
      *
-     * @param Theme object $theme - Theme Object (Container)
+     * @param Theme Theme $theme - Theme Object (Container)
      */
     public function setTheme($theme)
     {
@@ -124,7 +124,7 @@ 
     /**
      * Set Theme Template
      *
-     * @param string $tamplate
+     * @param string $template
      */
     public function setThemeTemplate($template)
     {

Spacing +5 added lines, -5 removed lines

@@ -56,7 +56,7 @@ 
      */
     public function getKeyValue($key)
     {
-        return empty($this->_data[$key]) ? null: $this->_data[$key];
+        return empty($this->_data[$key]) ? null : $this->_data[$key];
     }
 
     /**
@@ -65,7 +65,7 @@ 
      */
     public function addTypedKeyValue($type, $key, $value)
     {
-        if(empty($this->_data[$type]))
+        if (empty($this->_data[$type]))
             $this->_data[$type] = array();
         $this->_data[$type][$key] = $value;
     }
@@ -87,7 +87,7 @@ 
      */
     public function getTheme()
     {
-        if($this->_theme === null)
+        if ($this->_theme === null)
             $this->_theme = new \erdiko\core\Theme($this->getThemeName(), null, $this->getThemeTemplate());
 
         return $this->_theme;
@@ -111,9 +111,9 @@ 
      */
     public function getThemeName()
     {
-        if(!empty($this->_themeName))
+        if (!empty($this->_themeName))
             $name = $this->_themeName;
-        elseif(!empty($this->_theme))
+        elseif (!empty($this->_theme))
             $name = $this->_theme->getName();
         else
             $name = Helper::getConfig()['theme']['name'];

Braces +13 added lines, -10 removed lines

@@ -65,8 +65,9 @@ 
      */
     public function addTypedKeyValue($type, $key, $value)
     {
-        if(empty($this->_data[$type]))
-            $this->_data[$type] = array();
+        if(empty($this->_data[$type])) {
+                    $this->_data[$type] = array();
+        }
         $this->_data[$type][$key] = $value;
     }
 
@@ -87,8 +88,9 @@ 
      */
     public function getTheme()
     {
-        if($this->_theme === null)
-            $this->_theme = new \erdiko\core\Theme($this->getThemeName(), null, $this->getThemeTemplate());
+        if($this->_theme === null) {
+                    $this->_theme = new \erdiko\core\Theme($this->getThemeName(), null, $this->getThemeTemplate());
+        }
 
         return $this->_theme;
     }
@@ -111,12 +113,13 @@ 
      */
     public function getThemeName()
     {
-        if(!empty($this->_themeName))
-            $name = $this->_themeName;
-        elseif(!empty($this->_theme))
-            $name = $this->_theme->getName();
-        else
-            $name = Helper::getConfig()['theme']['name'];
+        if(!empty($this->_themeName)) {
+                    $name = $this->_themeName;
+        } elseif(!empty($this->_theme)) {
+                    $name = $this->_theme->getName();
+        } else {
+                    $name = Helper::getConfig()['theme']['name'];
+        }
         
         return $name;
     }

src/Template.php

Doc Comments +2 added lines, -3 removed lines

@@ -52,7 +52,6 @@ 
     /**
      * Get template
      *
-     * @param string $template
      */
     public function getTemplate()
     {
@@ -62,7 +61,6 @@ 
     /**
      * Get default template name
      *
-     * @param string $template
      */
     public function getDefaultTemplate()
     {
@@ -82,7 +80,7 @@ 
     /**
      * Set template root folder
      *
-     * @param string $TemplateRootFolder
+     * @param string $templateRootFolder
      */
     public function setTemplateRootFolder($templateRootFolder)
     {
@@ -119,6 +117,7 @@ 
 
     /**
      * Set Template folder
+     * @param string $templateFolder
      */
     public function setTemplateFolder($templateFolder)
     {

Spacing +2 added lines, -2 removed lines

@@ -163,7 +163,7 @@ 
     {
         // Capitalize first letter of the key to preserve camel case convention naming
         $method = 'set'.ucfirst($key);
-        if(is_callable(array($this, $method))) {
+        if (is_callable(array($this, $method))) {
             $this->$method($value); // Execute the native setter function
         } else {
             $this->_data[$key] = $value;
@@ -174,7 +174,7 @@ 
     {
         $value = null;
 
-        if(array_key_exists($key, $this->_data))
+        if (array_key_exists($key, $this->_data))
             $value = $this->_data[$key];
 
         return $value;

Braces +3 added lines, -2 removed lines

@@ -174,8 +174,9 @@
     {
         $value = null;
 
-        if(array_key_exists($key, $this->_data))
-            $value = $this->_data[$key];
+        if(array_key_exists($key, $this->_data)) {
+                    $value = $this->_data[$key];
+        }
 
         return $value;
     }

src/View.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
      * Constructor
      * @param string $template
      * @param mixed $data
-     * @param string $templateFolder
+     * @param string $templateRootFolder
      */
     public function __construct($template = null, $data = null, $templateRootFolder = ERDIKO_APP)
     {

src/ApiController.php

Indentation +7 added lines, -7 removed lines

@@ -21,19 +21,19 @@
 class ApiController extends Controller
 {
 
-  /**
-   * Contructor
-   */
+    /**
+     * Contructor
+     */
     public function __construct()
     {
         $this->_webroot = ERDIKO_ROOT;
         $this->_response = new \erdiko\core\ApiResponse;
     }
 
-  /**
-   * setStatusCode
-   *
-   */
+    /**
+     * setStatusCode
+     *
+     */
     public function setStatusCode($code = null)
     {
         if (!empty($code)) {