HuasoFoundries / phpPgAdmin6

src/database/databasetraits/TableTrait.php

Doc Comments +12 added lines

@@ -1525,6 +1525,12 @@ 
 
     abstract public function execute($sql);
 
+    /**
+     * @param string $obj_type
+     * @param string $obj_name
+     * @param string $comment
+     * @param boolean $basetype
+     */
     abstract public function setComment($obj_type, $obj_name, $table, $comment, $basetype = null);
 
     abstract public function selectSet($sql);
@@ -1541,9 +1547,15 @@ 
 
     abstract public function delete($table, $conditions, $schema = '');
 
+    /**
+     * @param boolean $arr
+     */
     abstract public function fieldArrayClean(&$arr);
 
     abstract public function hasCreateFieldWithConstraints();
 
+    /**
+     * @param string $table
+     */
     abstract public function getAttributeNames($table, $atts);
 }

src/database/databasetraits/TriggerTrait.php

Doc Comments +12 added lines

@@ -259,6 +259,12 @@ 
 
     abstract public function execute($sql);
 
+    /**
+     * @param string $obj_type
+     * @param string $obj_name
+     * @param string $comment
+     * @param boolean $basetype
+     */
     abstract public function setComment($obj_type, $obj_name, $table, $comment, $basetype = null);
 
     abstract public function selectSet($sql);
@@ -275,9 +281,15 @@ 
 
     abstract public function delete($table, $conditions, $schema = '');
 
+    /**
+     * @param boolean $arr
+     */
     abstract public function fieldArrayClean(&$arr);
 
     abstract public function hasCreateFieldWithConstraints();
 
+    /**
+     * @param string $table
+     */
     abstract public function getAttributeNames($table, $atts);
 }

src/database/databasetraits/TypeTrait.php

Doc Comments +6 added lines

@@ -502,6 +502,12 @@
 
     abstract public function execute($sql);
 
+    /**
+     * @param string $obj_type
+     * @param string $table
+     * @param string $comment
+     * @param boolean $basetype
+     */
     abstract public function setComment($obj_type, $obj_name, $table, $comment, $basetype = null);
 
     abstract public function selectSet($sql);

src/database/databasetraits/ViewTrait.php

Doc Comments +8 added lines

@@ -345,11 +345,19 @@
 
     abstract public function execute($sql);
 
+    /**
+     * @param string $obj_type
+     * @param string $table
+     * @param string $comment
+     */
     abstract public function setComment($obj_type, $obj_name, $table, $comment, $basetype = null);
 
     abstract public function selectSet($sql);
 
     abstract public function clean(&$str);
 
+    /**
+     * @param boolean $arr
+     */
     abstract public function fieldArrayClean(&$arr);
 }

src/database/Postgres80.php

Doc Comments +1 added lines, -1 removed lines

@@ -155,7 +155,7 @@
      * @param string $username The username
      * @param string $password The new password
      *
-     * @return int 0 if operation was successful
+     * @return \PHPPgAdmin\ADORecordSet 0 if operation was successful
      */
     public function changePassword($username, $password)
     {

src/database/Postgres96.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
      * @param string $expiry     string Format 'YYYY-MM-DD HH:MM:SS'.  '' means never expire
      * @param array  $groups     The groups to create the user in
      *
-     * @return int 0 if operation was successful
+     * @return \PHPPgAdmin\ADORecordSet 0 if operation was successful
      *
      * @internal param $group (array) The groups to create the user in
      */

src/decorators/Decorator.php

Doc Comments +23 added lines

@@ -20,6 +20,9 @@ 
         return $this->v;
     }
 
+    /**
+     * @param string $esc
+     */
     public static function get_sanitized_value(&$var, &$fields, $esc = null)
     {
         //self::statictrace($var, $fields, $esc);
@@ -49,6 +52,9 @@ 
         return $val;
     }
 
+    /**
+     * @param \Closure $callback
+     */
     public static function callback($callback, $params = null)
     {
         return new \PHPPgAdmin\Decorators\CallbackDecorator($callback, $params);
@@ -64,16 +70,25 @@ 
         return new \PHPPgAdmin\Decorators\ConcatDecorator(func_get_args());
     }
 
+    /**
+     * @param string $str
+     */
     public static function replace($str, $params)
     {
         return new \PHPPgAdmin\Decorators\ReplaceDecorator($str, $params);
     }
 
+    /**
+     * @param string $fieldName
+     */
     public static function field($fieldName, $default = null)
     {
         return new FieldDecorator($fieldName, $default);
     }
 
+    /**
+     * @param FieldDecorator $base
+     */
     public static function branchurl($base, $vars = null/* ... */)
     {
         // If more than one array of vars is given,
@@ -104,6 +119,9 @@ 
         return new ActionUrlDecorator($base, $vars);
     }
 
+    /**
+     * @param string $base
+     */
     public static function redirecturl($base, $vars = null/* ... */)
     {
         // If more than one array of vars is given,
@@ -135,6 +153,11 @@ 
         return new UrlDecorator($base, $vars);
     }
 
+    /**
+     * @param FieldDecorator $value
+     * @param string $empty
+     * @param UrlDecorator $full
+     */
     public static function ifempty($value, $empty, $full = null)
     {
         return new IfEmptyDecorator($value, $empty, $full);

src/traits/AdminTrait.php

Doc Comments +16 added lines, -2 removed lines

@@ -542,8 +542,6 @@ 
      * persist changes in autovacuum settings.
      *
      * @param mixed $type
-     * @param mixed $confirm
-     * @param mixed $msg
      */
     public function doEditAutovacuum($type)
     {
@@ -688,6 +686,10 @@ 
         $this->_printAutoVacuumConf($data, $type);
     }
 
+    /**
+     * @param string $action
+     * @param string $type
+     */
     public function adminActions($action, $type)
     {
         if ('database' == $type) {
@@ -764,6 +766,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $table_hidden_inputs
+     */
     private function _getReclusterConf($data, $type, $table_hidden_inputs)
     {
         if (!$data->hasRecluster()) {
@@ -923,11 +928,20 @@ 
 
     abstract public function printTrail($trail = [], $do_print = true);
 
+    /**
+     * @param string $help
+     */
     abstract public function printTitle($title, $help = null, $do_print = true);
 
     abstract public function printMsg($msg, $do_print = true);
 
+    /**
+     * @param string $activetab
+     */
     abstract public function printTabs($tabs, $activetab, $do_print = true);
 
+    /**
+     * @param string $place
+     */
     abstract public function printTable(&$tabledata, &$columns, &$actions, $place, $nodata = '', $pre_fn = null);
 }

src/traits/HelperTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
      * @param mixed $default The default value to set, it $set is true
      * @param bool  $set     True to set the default value if $var2 isn't defined
      *
-     * @return mixed the value of $var2 is $var2 is set, or $default otherwise
+     * @return string the value of $var2 is $var2 is set, or $default otherwise
      */
     public function setIfIsset(&$var1, $var2, $default = null, $set = true)
     {