caffeina-core / core

classes/Session.php

Doc Comments +4 added lines, -5 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){
@@ -45,7 +44,7 @@ 
 	 * @access public
 	 * @static
 	 * @param mixed $key The variable name
-	 * @return mixed The variable value
+	 * @return string The variable value
 	 */
 	static public function get($key,$default=null){
                 if (($active = static::active()) && isset($_SESSION[$key])) {
@@ -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/SQL.php

Doc Comments +14 added lines

@@ -18,6 +18,9 @@ 
   protected static $queries    = [];
   protected static $last_exec_success = true;
 
+  /**
+   * @param string $dsn
+   */
   public static function connect($dsn, $username=null, $password=null, $options=[]){
     static::$connection = [
       'dsn'        => $dsn,
@@ -58,6 +61,9 @@ 
     return isset(static::$queries[$query]) ? static::$queries[$query] : (static::$queries[$query] = static::connection()->prepare($query));
   }
 
+  /**
+   * @return boolean
+   */
   public static function exec($query, $params=[]){
     if(!static::connection()) return false;
 
@@ -139,6 +145,11 @@ 
    return static::each($query,$params,$looper);
   }
 
+  /**
+   * @param string $table
+   *
+   * @return boolean
+   */
   public static function delete($table, $pks=null, $pk='id', $inclusive=true){
     if(!static::connection()) return false;
 
@@ -179,6 +190,9 @@ 
     return static::updateWhere($table, $data, "`$pk`=:$pk $extra_where");
   }
 
+  /**
+   * @return boolean
+   */
   public static function insertOrUpdate($table, $data=[], $pk='id', $extra_where=''){
     if(!static::connection()) return false;
 

classes/View.php

Doc Comments +3 added lines, -2 removed lines

@@ -29,7 +29,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;
@@ -69,7 +69,7 @@ 
 
     /**
      * Returns the handler instance
-     * @return mixed
+     * @return View\Adapter
      */
     public static function & handler(){
       return static::$handler;
@@ -77,6 +77,7 @@ 
 
     /**
      * Check if a template exists
+     * @param string $templatePath
      * @return bool
      */
     public static function exists($templatePath){

classes/View/PHP.php

Doc Comments +6 added lines

@@ -19,6 +19,9 @@ 
     protected static $templatePath,
                      $globals = [];
 
+    /**
+     * @param string $path
+     */
     public function __construct($path=null,$options=[]){
         self::$templatePath = ($path ? rtrim($path,'/') : __DIR__) . '/';
     }
@@ -57,6 +60,9 @@ 
 class PHPContext {
     protected $data      = [];
 
+    /**
+     * @param string $path
+     */
     public function __construct($data=[], $path=null){
         $this->data = $data;
     }

tests/RouteTest.php

Doc Comments +4 added lines

@@ -2,6 +2,10 @@
 
 class RouteTest extends PHPUnit_Framework_TestCase {
 
+		/**
+		 * @param string $uri
+		 * @param string $method
+		 */
 		private function mock_request($uri, $method){
 		    Filter::remove('core.request.method');
 		    Filter::remove('core.request.URI');