caffeina-core / core

classes/Errors.php

Doc Comments +3 added lines

@@ -57,6 +57,9 @@
       return true;
     }
 
+    /**
+     * @param ErrorException $e
+     */
     public static function traceException($e){
       switch(self::$mode){
           case self::HTML :

classes/SQL.php

Doc Comments +5 added lines

@@ -101,6 +101,11 @@
             $queries           = [],
             $last_exec_success = true;
 
+  /**
+   * @param string $dsn
+   * @param string $username
+   * @param string $password
+   */
   public function __construct($dsn, $username=null, $password=null, $options=[]){
     $this->connection = [
       'dsn'        => $dsn,

classes/Session.php

Doc Comments +3 added lines, -4 removed lines

@@ -32,7 +32,6 @@ 
 	 *
 	 * @access public
 	 * @static
-	 * @param string $key The session name
 	 * @return string The session value
 	 */
 	static public function name($name=null){
@@ -62,7 +61,7 @@ 
 	 *
 	 * @access public
 	 * @static
-	 * @param mixed $key The variable name
+	 * @param string $key The variable name
 	 * @param mixed $value The variable value
 	 * @return void
 	 */
@@ -80,7 +79,7 @@ 
 	 *
 	 * @access public
 	 * @static
-	 * @param mixed $key The variable name
+	 * @param string $key The variable name
 	 * @return void
 	 */
 	static public function delete($key){
@@ -107,7 +106,7 @@ 
 	 *
 	 * @access public
 	 * @static
-	 * @return void
+	 * @return boolean
 	 */
 	static public function active(){
 		return session_status() == PHP_SESSION_ACTIVE;

classes/FileSystem/Native.php

Doc Comments +3 added lines

@@ -28,6 +28,9 @@
       return $this->exists($path) ? file_get_contents($this->realPath($path)) : false;
   }
 
+  /**
+   * @param string|false $data
+   */
   public function write($path, $data){
       $r_path = $this->realPath($path);
       if ( ! is_dir($r_dir = dirname($r_path)) ) @mkdir($r_dir,0775,true);

classes/View/PHP.php

Doc Comments +3 added lines

@@ -56,6 +56,9 @@
 class PHPContext {
   protected $data = [];
 
+  /**
+   * @param string $path
+   */
   public function __construct($data=[], $path=null){
       $this->data = $data;
   }

classes/Request.php

Doc Comments +1 added lines

@@ -92,6 +92,7 @@
    * Returns all elements if you pass `null` as $key
    *
    * @param  string $key The name of the input value
+   * @param boolean $default
    *
    * @return Object The returned value or $default.
    */

classes/Relation.php

Doc Comments +1 added lines, -2 removed lines

@@ -17,7 +17,6 @@ 
    * This function can be used to get all options passing null, setting options passing an associative
    * array or retrieve a single value passing a string
    *
-   * @param  mixed $options The options passed to the relation layer.
    * @return mixed          All options array or a single value
    */
   protected static function & relationOptions(){
@@ -31,7 +30,7 @@ 
    * The save callback interface is
    *   function($table, array $options)
    *
-   * @param  callable $callback The callback to use on model save
+   * @param string $plurality
    * @return callable           Current save callback
    */
   private static function relationAddRelationshipTo($link, $plurality, $extra=[]){

classes/View.php

Doc Comments +3 added lines, -3 removed lines

@@ -21,7 +21,7 @@ 
 
     /**
      * Construct a new view based on the passed template
-     * @param  mixed $template The template path or an array of them.
+     * @param  string $template The template path or an array of them.
      */
     public function __construct($template){
       foreach ((array)$template as $templ){
@@ -33,7 +33,7 @@ 
 
     /**
      * Load a Template Handler
-     * @param  class $handler The template handler class instance
+     * @param  View\Adapter $handler The template handler class instance
      */
     public static function using(View\Adapter $handler){
       static::$handler = $handler;
@@ -73,7 +73,7 @@ 
 
     /**
      * Returns the handler instance
-     * @return mixed
+     * @return View\Adapter
      */
     public static function & handler(){
       return static::$handler;

classes/CLI.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
     /**
      * Dispatch the router
      * @param  string[] $args The arguments array.
-     * @return boolean  True if route was correctly dispatched.
+     * @return null|boolean  True if route was correctly dispatched.
      */
     public static function run($args=null){
       if (PHP_SAPI != 'cli') return false;