HuasoFoundries / phpPgAdmin6

src/controllers/ViewsController.php

Doc Comments +2 added lines

@@ -285,6 +285,7 @@ 
 
     /**
      * Ask for select parameters and perform select
+     * @param boolean $confirm
      */
     public function doSelectRows($confirm, $msg = '')
     {
@@ -414,6 +415,7 @@ 
 
     /**
      * Show confirmation of drop and perform actual drop
+     * @param boolean $confirm
      */
     public function doDrop($confirm)
     {

src/database/ADOdbBase.php

Doc Comments +3 added lines, -3 removed lines

@@ -102,7 +102,7 @@ 
      * @@ assumes that the query will return only one row - returns field value in the first row
      *
      * @param $sql   The SQL statement to be executed
-     * @param $field The field name to be returned
+     * @param string $field The field name to be returned
      * @return A single field value
      * @return -1 No rows were found
      */
@@ -347,7 +347,7 @@ 
     /**
      * Get the backend platform
      *
-     * @return The backend platform
+     * @return string backend platform
      */
     public function getPlatform()
     {
@@ -383,7 +383,7 @@ 
      * Change a db array into a PHP array
      *
      * @param $dbarr
-     * @return \PHPPgAdmin\Database\A PHP array
+     * @return string[] PHP array
      * @internal param String $arr representing the DB array
      */
     public function phpArray($dbarr)

src/database/Connection.php

Doc Comments +1 added lines, -1 removed lines

@@ -174,7 +174,7 @@
     /**
      * Get the last error in the connection
      *
-     * @return Error string
+     * @return string string
      */
     public function getLastError()
     {

src/database/Postgres.php

Doc Comments +23 added lines, -23 removed lines

@@ -376,7 +376,7 @@ 
      * Escapes bytea data for display on the screen
      *
      * @param $data The bytea data
-     * @return Data formatted for on-screen display
+     * @return string formatted for on-screen display
      */
     public function escapeBytea($data)
     {
@@ -401,7 +401,7 @@ 
      * Cleans (escapes) a string
      *
      * @param $str The string to clean, by reference
-     * @return The cleaned string
+     * @return null|string cleaned string
      */
     public function clean(&$str)
     {
@@ -484,7 +484,7 @@ 
      * Determines whether or not a user is a super user
      *
      * @param \PHPPgAdmin\Database\The|string $username The username of the user
-     * @return True if is a super user, false otherwise
+     * @return boolean if is a super user, false otherwise
      */
     public function isSuperUser($username = '')
     {
@@ -543,7 +543,7 @@ 
     /**
      * Returns the current database encoding
      *
-     * @return The encoding.  eg. SQL_ASCII, UTF-8, etc.
+     * @return string encoding.  eg. SQL_ASCII, UTF-8, etc.
      */
     public function getDatabaseEncoding()
     {
@@ -654,7 +654,7 @@ 
      * Sets the comment for an object in the database
      *
      * @pre All parameters must already be cleaned
-     * @param      $obj_type One of 'TABLE' | 'COLUMN' | 'VIEW' | 'SCHEMA' | 'SEQUENCE' | 'TYPE' | 'FUNCTION' | 'AGGREGATE'
+     * @param      string $obj_type One of 'TABLE' | 'COLUMN' | 'VIEW' | 'SCHEMA' | 'SEQUENCE' | 'TYPE' | 'FUNCTION' | 'AGGREGATE'
      * @param      $obj_name The name of the object for which to attach a comment.
      * @param      $table    Name of table that $obj_name belongs to.  Ignored unless $obj_type is 'TABLE' or 'COLUMN'.
      * @param      $comment  The comment to add.
@@ -1052,7 +1052,7 @@ 
     /**
      * Return the current schema search path
      *
-     * @return Array of schema names
+     * @return string[] of schema names
      */
     public function getSearchPath()
     {
@@ -1349,7 +1349,7 @@ 
      * @pre MUST be run within a transaction
      * @param           $table The table to define
      * @param bool|True $clean True to issue drop command, false otherwise
-     * @return \PHPPgAdmin\Database\A string containing the formatted SQL code
+     * @return null|string string containing the formatted SQL code
      */
     public function getTableDefPrefix($table, $clean = false)
     {
@@ -1990,7 +1990,7 @@ 
      * given its type.
      *
      * @param $object The name of the object whose privileges are to be retrieved
-     * @param $type   The type of the object (eg. database, schema, relation, function or language)
+     * @param string $type   The type of the object (eg. database, schema, relation, function or language)
      * @param $table  Optional, column's table if type = column
      * @return Privileges array
      * @return -1 invalid type
@@ -2203,8 +2203,8 @@ 
      * dumped after the table contents for speed and efficiency reasons
      *
      * @param $table The table to define
-     * @return A string containing the formatted SQL code
-     * @return null On error
+     * @return null|string string containing the formatted SQL code
+     * @return null|string On error
      */
     public function getTableDefSuffix($table)
     {
@@ -3093,7 +3093,7 @@ 
      *
      * @param $table  The table that contains the column
      * @param $column The column to alter
-     * @param $state  True to set null, false to set not null
+     * @param boolean $state  True to set null, false to set not null
      * @return \PHPPgAdmin\Database\A 0 success
      */
     public function setColumnNull($table, $column, $state)
@@ -3230,7 +3230,7 @@ 
      * Returns all available autovacuum per table information.
      *
      * @param \PHPPgAdmin\Database\if|string $table if given, return autovacuum info for the given table or return all informations for all table
-     * @return \PHPPgAdmin\Database\A recordset
+     * @return \PHPPgAdmin\ArrayRecordSet recordset
      */
     public function getTableAutovacuum($table = '')
     {
@@ -3535,7 +3535,7 @@ 
     /**
      * Delete a row from a table
      *
-     * @param      $table The table from which to delete
+     * @param      string $table The table from which to delete
      * @param      $key   An array mapping column => value to delete
      * @param bool $schema
      * @return bool|int 0 success
@@ -4125,7 +4125,7 @@ 
      *
      * @param $viewname   The name of the view to create
      * @param $definition The definition for the new view
-     * @param $replace    True to replace the view, false otherwise
+     * @param boolean $replace    True to replace the view, false otherwise
      * @param $comment
      * @return bool|int 0 success
      */
@@ -4373,7 +4373,7 @@ 
      *
      * @param $table The table to test
      *
-     * @return true if the table has been already clustered
+     * @return boolean if the table has been already clustered
      */
     public function alreadyClustered($table)
     {
@@ -6148,7 +6148,7 @@ 
      * Note: Only needed for pre-7.4 servers, this function is deprecated
      *
      * @param $trigger An array containing fields from the trigger table
-     * @return The trigger definition string
+     * @return string trigger definition string
      */
     public function getTriggerDef($trigger)
     {
@@ -6278,8 +6278,8 @@ 
     /**
      * Returns a list of all functions in the database
      *
-     * @param bool|\PHPPgAdmin\Database\If $all  If true, will find all available functions, if false just those in search path
-     * @param                              $type If not null, will find all functions with return value = type
+     * @param boolean $all  If true, will find all available functions, if false just those in search path
+     * @param                              string $type If not null, will find all functions with return value = type
      * @return \PHPPgAdmin\Database\All functions
      */
     public function getFunctions($all = false, $type = null)
@@ -8763,7 +8763,7 @@ 
      * @param $name     Entry in $_FILES to use
      * @param $callback (optional) Callback function to call with each query,
      *                  its result and line number.
-     * @return True for general success, false on any failure.
+     * @return boolean for general success, false on any failure.
      */
     public function executeScript($name, $callback = null)
     {
@@ -9033,8 +9033,8 @@ 
      * Private helper method to detect a valid $foo$ quote delimiter at
      * the start of the parameter dquote
      *
-     * @param $dquote
-     * @return True if valid, false otherwise
+     * @param string $dquote
+     * @return boolean if valid, false otherwise
      */
     private function valid_dolquote($dquote)
     {
@@ -9175,7 +9175,7 @@ 
      * @param $ops     An array of the operators to use
      * @param $orderby (optional) An array of column numbers or names (one based)
      *                 mapped to sort direction (asc or desc or '' or null) to order by
-     * @return The SQL query
+     * @return string SQL query
      */
     public function getSelectSQL($table, $show, $values, $ops, $orderby = [])
     {
@@ -9280,7 +9280,7 @@ 
      * Finds the number of rows that would be returned by a
      * query.
      *
-     * @param $query The SQL query
+     * @param string $query The SQL query
      * @param $count The count query
      * @return The count of rows
      * @return -1 error

src/database/Postgres74.php

Doc Comments +1 added lines, -1 removed lines

@@ -423,7 +423,7 @@
         /**
          * Returns the current default_with_oids setting
          *
-         * @return default_with_oids setting
+         * @return string setting
          */
         public function getDefaultWithOid()
         {

src/decorators/Decorator.php

Doc Comments +22 added lines

@@ -15,6 +15,9 @@ 
         return $this->v;
     }
 
+    /**
+     * @param string $esc
+     */
     public static function get_sanitized_value(&$var, &$fields, $esc = null)
     {
 
@@ -54,6 +57,9 @@ 
         }
     }
 
+    /**
+     * @param string $attr
+     */
     public static function value_xml_attr_tag($attr, &$var, &$fields)
     {
         $val = self::get_sanitized_value($var, $fields, 'xml');
@@ -64,6 +70,9 @@ 
         }
     }
 
+    /**
+     * @param \Closure $callback
+     */
     public static function callback($callback, $params = null)
     {
         return new \PHPPgAdmin\Decorators\CallbackDecorator($callback, $params);
@@ -79,11 +88,17 @@ 
         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);
@@ -117,6 +132,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,
@@ -145,6 +163,10 @@ 
         return new UrlDecorator($base, $vars);
     }
 
+    /**
+     * @param FieldDecorator $value
+     * @param string $empty
+     */
     public static function ifempty($value, $empty, $full = null)
     {
         return new IfEmptyDecorator($value, $empty, $full);

src/xhtml/HTMLController.php

Doc Comments +5 added lines

@@ -24,6 +24,10 @@ 
     public $_title          = 'base';
 
     /* Constructor */
+
+    /**
+     * @param string $controller_name
+     */
     public function __construct(\Slim\Container $container, $controller_name = null)
     {
         $this->container      = $container;
@@ -58,6 +62,7 @@ 
      *            'urlvars' => Associative array of (URL variable => field name)
      *                        these are appended to the URL
      * @param $fields Field data from which 'urlfield' and 'vars' are obtained.
+     * @return string
      */
     protected function getActionUrl(&$action, &$fields, $from = null)
     {

src/xhtml/HTMLFooterController.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
 
     /**
      * Outputs JavaScript code that will reload the browser
-     * @param $database True if dropping a database, false otherwise
+     * @param boolean $database True if dropping a database, false otherwise
      * @param $do_print true to echo, false to return;
      */
     public function printReload($database, $do_print = true)

src/xhtml/HTMLNavbarController.php

Doc Comments +4 added lines

@@ -357,6 +357,9 @@ 
         }
     }
 
+    /**
+     * @param string $subject
+     */
     private function getHREFSubject($subject)
     {
         $vars = $this->misc->getSubjectParams($subject);
@@ -367,6 +370,7 @@ 
     /**
      * Create a bread crumb trail of the object hierarchy.
      * @param $object The type of object at the end of the trail.
+     * @param string $subject
      */
     private function getTrail($subject = null)
     {