caffeina-core / core

classes/Response.php

Doc Comments +7 added lines, -6 removed lines

@@ -114,7 +114,7 @@ 
 
     /**
      * Check if an response output buffering is active.
-     * @return boolean
+     * @return boolean|null
      */
     public static function isBuffering(){
         return static::$buffer;
@@ -139,7 +139,6 @@ 
 
     /**
      * Append a text to the buffer.
-     * @param  mixed $payload Text to append to the response buffer
      */
     public static function text(...$args){
         static::type(static::TYPE_TEXT);
@@ -148,7 +147,6 @@ 
 
     /**
      * Append an XML string to the buffer.
-     * @param  mixed $payload Data to append to the response buffer
      */
     public static function xml(...$args){
         static::type(static::TYPE_XML);
@@ -157,7 +155,6 @@ 
 
     /**
      * Append a SVG string to the buffer.
-     * @param  mixed $payload Data to append to the response buffer
      */
     public static function svg(...$args){
         static::type(static::TYPE_SVG);
@@ -166,7 +163,6 @@ 
 
     /**
      * Append an HTML string to the buffer.
-     * @param  mixed $payload Data to append to the response buffer
      */
     public static function html(...$args){
         static::type(static::TYPE_HTML);
@@ -181,7 +177,6 @@ 
      *  - Objects, arrays and bools will be JSON encoded
      *  - Strings and numbers will be appendend to the response
      *
-     * @param  mixed $payload Data to append to the response buffer
      */
     public static function add(){
       foreach(func_get_args() as $data){
@@ -198,10 +193,16 @@ 
       }
     }
 
+    /**
+     * @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){
       if (empty(static::$headers[$name])){
         static::$headers[$name] = [[$value,$code]];

classes/Route.php

Doc Comments +3 added lines, -4 removed lines

@@ -105,7 +105,7 @@ 
      * Run one of the mapped callbacks to a passed HTTP Method.
      * @param  array  $args The arguments to be passed to the callback
      * @param  string $method The HTTP Method requested.
-     * @return array The callback response.
+     * @return string[] The callback response.
      */
     public function run(array $args, $method='get'){
       $method = strtolower($method);
@@ -235,7 +235,6 @@ 
 
     /**
      * 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).
      * @return Route
      */
     public function & before($callback){
@@ -359,7 +358,7 @@ 
      * Helper for reverse routing : obtain a complete URL for a named route with passed parameters
      * @param  string $name The name tag of the route.
      * @param  array $params The parameter map of the route dynamic values.
-     * @return string
+     * @return URL
      */
     public static function URL($name, $params = []){
       return ($r = static::tagged($name)) ? $r-> getURL($params) : new URL();
@@ -389,7 +388,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();

classes/HTTP.php

Doc Comments +6 added lines

@@ -21,6 +21,9 @@ 
                    $last_info             = null,
                    $proxy                 = null; // host:port
 
+  /**
+   * @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);
@@ -86,6 +89,9 @@ 
     return $value===null ? static::$json_data : static::$json_data = $value;
   }
 
+  /**
+   * @param string $headers
+   */
   protected static function trasformRawHeaders($headers) {
     foreach (explode("\r\n", trim($headers)) as $line) {
       if (empty($line)) continue;