atk4 / atk4

lib/Controller/Data/Mongo.php

Doc Comments +4 added lines

@@ -36,6 +36,10 @@
     public function _get($model,$key){
         return $model->_table[$this->short_name][$key];
     }
+
+    /**
+     * @param string $key
+     */
     public function _set($model,$key,$val){
         $model->_table[$this->short_name][$key]=$val;
     }

lib/Controller/Validator/Abstract.php

Doc Comments +4 added lines

@@ -232,6 +232,10 @@
      * the default hook. This is done to avoid double-validation
      */
     public $custom_hook=false;
+
+    /**
+     * @param string $hook
+     */
     function on($hook,$object=null,$default_hook=false)
     {
         if(!$object)$object=$this->owner;

lib/DB.php

Doc Comments +4 added lines, -4 removed lines

@@ -240,7 +240,7 @@ 
      * @param string $statement for unsupported db's
      * @param string $table     for unsupported db's
      *
-     * @return int|mixed
+     * @return string
      */
     function lastID($statement = null, $table = null)
     {
@@ -261,7 +261,7 @@ 
      * So if you have been working with the database and got unhandled exception
      * in the middle of your code, everything would be rolled back.
      *
-     * @return mixed Don't rely on any meaningful return
+     * @return boolean Don't rely on any meaningful return
      */
     public function beginTransaction()
     {
@@ -279,7 +279,7 @@ 
      * issued to the database.
      *
      * @see beginTransaction()
-     * @return mixed Don't rely on any meaningful return
+     * @return boolean Don't rely on any meaningful return
      */
     public function commit()
     {
@@ -328,7 +328,7 @@ 
      * Rollbacks queries since beginTransaction and resets transaction depth
      *
      * @see beginTransaction()
-     * @return mixed Don't rely on any meaningful return
+     * @return boolean Don't rely on any meaningful return
      */
     public function rollBack()
     {

lib/Form/Field/DateSelector.php

Doc Comments +3 added lines

@@ -112,6 +112,9 @@
         $this->required = $is_required === true;
     }
 
+    /**
+     * @param double $to
+     */
     function setYearRange($from=null, $to=null){
         if(!is_numeric($from))
             $from = null;

lib/Form/Field/Upload.php

Doc Comments +11 added lines

@@ -182,6 +182,10 @@ 
             json_encode($data).");</script></head></html>";
         exit;
     }
+
+    /**
+     * @param string $message
+     */
     function uploadFailed($message){
 
         $d='';
@@ -195,6 +199,9 @@ 
         exit;
     }
 
+    /**
+     * @param string $val
+     */
     function convertToBytes($val){
         $val = trim($val);
         $last = strtolower($val[strlen($val) - 1]);
@@ -348,6 +355,10 @@ 
         if(function_exists('mime_content_type'))return mime_content_type($this->getFilePath());
         return $_FILES[$this->name]['type'];
     }
+
+    /**
+     * @return string
+     */
     function getFilePath(){
         return $_FILES[$this->name]['tmp_name'];
     }

lib/Lister.php

Doc Comments +1 added lines, -1 removed lines

@@ -191,7 +191,7 @@
     /**
      * Sets default template
      *
-     * @return array
+     * @return string[]
      */
     function defaultTemplate()
     {

lib/System/ProcessIO.php

Doc Comments +2 added lines, -2 removed lines

@@ -143,7 +143,7 @@ 
      * this function  will be waiting.
      *
      * @param  string $res optional descriptor (either out or err)
-     * @return self
+     * @return string
      */
     function readLine($res='out'){
         $str=fgets($this->pipes[$res]);
@@ -156,7 +156,7 @@ 
      * Reads all output and returns. Closes stdout when EOF reached.
      *
      * @param  string $res optional descriptor (out or err)
-     * @return self
+     * @return string
      */
     function readAll($res='out'){
         $str='';

lib/TMail/Compat.php

Doc Comments +9 added lines

@@ -137,12 +137,17 @@ 
      * - text: plain text
      * - html: HTML only
      * - both: text and HTML
+     * @param string $type
      */
     function setBodyType($type){
         if($type=='html'||$type=='text'||$type='both')$this->body_type=$type;
         else throw new MailException("Unsupported body type: $type");
         return $this;
     }
+
+    /**
+     * @param string $tag
+     */
     function set($tag,$value){
         /**
          * Sets the mail attribute
@@ -256,6 +261,10 @@ 
         }
         return $this->boundary;
     }
+
+    /**
+     * @return string
+     */
     function get($tag,$plain=true){
         $value=null;
         if(isset($this->attrs[$tag]))$value=$this->attrs[$tag];

lib/Controller/Validator/Basic.php

Doc Comments +2 added lines

@@ -1043,6 +1043,7 @@ 
 
     /**
      * Reduce sequential whitespaces to a single space.
+     * @return string
      */
     protected function strip_excess_whitespace($a)
     {
@@ -1051,6 +1052,7 @@ 
 
     /**
      * Helper for validating card to and from dates.
+     * @param string $type
      */
     protected function card_date_parser($a, $type)
     {