caffeina-core / core

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($args) {

classes/Email/Smtp.php

Doc Comments +6 added lines

@@ -57,6 +57,9 @@ 
     fwrite($this->socket, $payload);
   }
 
+  /**
+   * @param integer $code
+   */
   protected function expectCode($code){
 
     $this->lastMessage = '';
@@ -98,6 +101,9 @@ 
     $this->attachments[] = $file;
   }
 
+  /**
+   * @param string $body
+   */
   protected function SMTPmail($to,$subject,$body,$heads=''){
     $this->connect();
     $this->expectCode(220);

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/FileSystem/Native.php

Doc Comments +3 added lines

@@ -27,6 +27,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/HTTP.php

Doc Comments +6 added lines

@@ -18,6 +18,9 @@ 
   protected static $headers     = [];
   protected static $last_info   = null;
 
+  /**
+   * @param string $method
+   */
   protected static function request($method, $url, $data=[], array $headers=[], $data_as_json=false, $username=null, $password = null){
     $http_method = strtoupper($method);
     $ch = curl_init($url);
@@ -97,6 +100,9 @@ 
     return static::request('get',$url,$data,$headers,false,$username,$password);
   }
 
+  /**
+   * @param string $url
+   */
   public static function post($url,$data=null,array $headers=[], $username = null, $password = null){
     return static::request('post',$url,$data,$headers,static::$json_data,$username,$password);
   }

classes/Persistence.php

Doc Comments +2 added lines, -1 removed lines

@@ -118,7 +118,8 @@
 
   /**
    * Load the model from the persistence layer
-   * @return mixed The retrieved object
+   * @param integer $pk
+   * @return boolean The retrieved object
    */
   public static function load($pk){
     $table = static::persistenceOptions('table');

classes/Response.php

Doc Comments +10 added lines, -6 removed lines

@@ -34,6 +34,9 @@ 
         static::$charset = $charset;
     }
 
+    /**
+     * @param string $mime
+     */
     public static function type($mime){
         static::header('Content-Type',$mime . (static::$charset ? '; charset='.static::$charset : ''));
     }
@@ -89,7 +92,7 @@ 
 
     /**
      * Check if an response output buffering is active.
-     * @return boolean
+     * @return boolean|null
      */
     public static function isBuffering(){
         return static::$buffer;
@@ -113,7 +116,6 @@ 
 
     /**
      * Append a text to the buffer.
-     * @param  mixed $payload Text to append to the response buffer
      */
     public static function text(){
         static::type(static::TYPE_TEXT);
@@ -122,7 +124,6 @@ 
 
     /**
      * Append an XML string to the buffer.
-     * @param  mixed $payload Data to append to the response buffer
      */
     public static function xml(){
         static::type(static::TYPE_XML);
@@ -131,7 +132,6 @@ 
 
     /**
      * Append a SVG string to the buffer.
-     * @param  mixed $payload Data to append to the response buffer
      */
     public static function svg(){
         static::type(static::TYPE_SVG);
@@ -140,7 +140,6 @@ 
 
     /**
      * Append an HTML string to the buffer.
-     * @param  mixed $payload Data to append to the response buffer
      */
     public static function html(){
         static::type(static::TYPE_HTML);
@@ -149,16 +148,21 @@ 
 
     /**
      * Append a raw string to the buffer.
-     * @param  mixed $payload Data to append to the response buffer
      */
     public static function add(){
         static::$payload[] = implode('',func_get_args());
     }
 
+    /**
+     * @param integer $code
+     */
     public static function status($code,$message=''){
         static::header('Status',$message?:$code,$code);
     }
 
+    /**
+     * @param string $name
+     */
     public static function header($name,$value,$code=null){
         static::$headers[$name] = [$value,$code];
     }

classes/Route.php

Doc Comments +6 added lines, -5 removed lines

@@ -169,7 +169,7 @@ 
     /**
      * Start a route definition, default to HTTP GET.
      * @param  string $URLPattern The URL to match against, you can define named segments to be extracted and passed to the callback.
-     * @param  $callback The callback to be invoked (with variables extracted from the route if present) when the route match the request URI.
+     * @param  Closure $callback The callback to be invoked (with variables extracted from the route if present) when the route match the request URI.
      * @return Route
      */
     public static function on($URLPattern, $callback = null){
@@ -179,7 +179,7 @@ 
     /**
      * Start a route definition, for any HTTP Method (using * wildcard).
      * @param  string $URLPattern The URL to match against, you can define named segments to be extracted and passed to the callback.
-     * @param  $callback The callback to be invoked (with variables extracted from the route if present) when the route match the request URI.
+     * @param  Closure $callback The callback to be invoked (with variables extracted from the route if present) when the route match the request URI.
      * @return Route
      */
     public static function any($URLPattern, $callback = null){
@@ -198,7 +198,7 @@ 
 
     /**
      * Bind a middleware callback to invoked before the route definition
-     * @param  callable $before The callback to be invoked ($this is binded to the route object).
+     * @param Closure $callback
      * @return Route
      */
     public function & before($callback){
@@ -208,7 +208,7 @@ 
 
     /**
      * Bind a middleware callback to invoked after the route definition
-     * @param  $callback The callback to be invoked ($this is binded to the route object).
+     * @param  Closure $callback The callback to be invoked ($this is binded to the route object).
      * @return Route
      */
     public function & after($callback){
@@ -318,7 +318,7 @@ 
      * @param  string  $pattern The URL schema with the named parameters
      * @param  string  $URL The URL to process, if omitted the current request URI will be used.
      * @param  boolean $cut If true don't limit the matching to the whole URL (used for group pattern extraction)
-     * @return array The extracted variables
+     * @return callable The extracted variables
      */
     protected static function extractVariablesFromURL($pattern,$URL=null,$cut=false){
         $URL     = $URL ?: Request::URI();
@@ -413,6 +413,7 @@ 
     /**
      * Start the route dispatcher and resolve the URL request.
      * @param  string $URL The URL to match onto.
+     * @param string $method
      * @return boolean true if a route callback was executed.
      */
     public static function dispatch($URL=null,$method=null){

classes/Service.php

Doc Comments +8 added lines

@@ -15,12 +15,20 @@
     use Module;
     private static $services = [];
 
+    /**
+     * @param string $serviceName
+     * @param Closure $serviceFactory
+     */
     public static function register($serviceName, $serviceFactory){
       static::$services[$serviceName] = function() use ($serviceName, $serviceFactory) {
         return static::$services[$serviceName] = call_user_func_array($serviceFactory, func_get_args());
       };
     }
 
+    /**
+     * @param string $serviceName
+     * @param Closure $serviceFactory
+     */
     public static function registerFactory($serviceName, $serviceFactory){
         static::$services[$serviceName] = function() use ($serviceName, $serviceFactory) {
             return call_user_func_array($serviceFactory, func_get_args());