danielgp / common-lib

source/CommonCode.php

Doc Comments +4 added lines, -5 removed lines

@@ -168,7 +168,7 @@ 
      *
      * @param string $fullURL
      * @param array $features
-     * @return blob
+     * @return string
      */
     protected function getContentFromUrlThroughCurl($fullURL, $features = null)
     {
@@ -464,8 +464,7 @@ 
      *
      * @param type $sourcePath
      * @param type $targetPath
-     * @param type $overwrite
-     * @return type
+     * @return string
      */
     protected function moveFilesIntoTargetFolder($sourcePath, $targetPath)
     {
@@ -632,7 +631,7 @@ 
      *
      * @param float $fAbove
      * @param float $fBelow
-     * @param mixed $mArguments
+     * @param integer $mArguments
      * @return decimal
      */
     protected function setDividedResult($fAbove, $fBelow, $mArguments = 0)
@@ -656,7 +655,7 @@ 
     /**
      * Provides a list of all known JSON errors and their description
      *
-     * @return type
+     * @return null|string
      */
     private function setJsonErrorInPlainEnglish()
     {

Spacing +4 added lines, -4 removed lines

@@ -194,7 +194,7 @@ 
         curl_setopt($chanel, CURLOPT_FAILONERROR, true);
         $rspJsonFromClient = curl_exec($chanel);
         if (curl_errno($chanel)) {
-            $aReturn['info']     = $this->setArrayToJson([
+            $aReturn['info'] = $this->setArrayToJson([
                 '#'           => curl_errno($chanel),
                 'description' => curl_error($chanel)
             ]);
@@ -477,7 +477,7 @@ 
                 ->ignoreUnreadableDirs(true)
                 ->followLinks()
                 ->in($sourcePath);
-        $sFiles     = [];
+        $sFiles = [];
         foreach ($iterator as $file) {
             $relativePathFile = str_replace($sourcePath, '', $file->getRealPath());
             if (!file_exists($targetPath . $relativePathFile)) {
@@ -517,7 +517,7 @@ 
                     ->ignoreUnreadableDirs(true)
                     ->followLinks()
                     ->in($inputArray['path']);
-            $aFiles   = null;
+            $aFiles = null;
             foreach ($iterator as $file) {
                 if ($file->getATime() < strtotime($inputArray['dateRule'])) {
                     $aFiles[] = $file->getRealPath();
@@ -660,7 +660,7 @@ 
      */
     private function setJsonErrorInPlainEnglish()
     {
-        $knownErrors  = [
+        $knownErrors = [
             JSON_ERROR_NONE           => null,
             JSON_ERROR_DEPTH          => 'Maximum stack depth exceeded',
             JSON_ERROR_STATE_MISMATCH => 'Underflow or the modes mismatch',

source/CommonLibLocale.php

Doc Comments +9 added lines

@@ -105,6 +105,12 @@ 
         return $this->tCmnLb->gettext($localizedStringCode);
     }
 
+    /**
+     * @param string $singularString
+     * @param string $pluralString
+     *
+     * @return string
+     */
     protected function lclMsgCmnNumber($singularString, $pluralString, $numberToEvaluate)
     {
         if (is_null($this->commonLibFlags)) {
@@ -114,6 +120,9 @@ 
         return $this->tCmnLb->ngettext($singularString, $pluralString, $numberToEvaluate);
     }
 
+    /**
+     * @param double $content
+     */
     protected function setNumberFormat($content, $features = null)
     {
         if (is_null($features)) {

source/DomComponentsByDanielGPwithCDN.php

Doc Comments +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
      * Returns css link to a given file
      * Returns an array with CDN call of a known Font-websome css
      *
-     * @param string $cssFile
+     * @param string $cssFileName
      * @return string
      */
     private function setCssFileCDNforFontAwesome($cssFileName)

source/MySQLiAdvancedOutput.php

Doc Comments +4 added lines, -14 removed lines

@@ -75,11 +75,10 @@ 
     /**
      * Returns a Enum or Set field 2 use in a form
      *
-     * @param string $table_source
-     * @param string $field_type
-     * @param array $value
-     * @param array $features
+     * @param string $fld_tp
+     * @param array $val
      * @param string $iar
+     * @param string $tblSrc
      * @return string
      */
     private function getFieldOutputEnumSet($tblSrc, $fld_tp, $val, $iar = null)
@@ -122,7 +121,6 @@ 
      *
      * @param string $tblSrc
      * @param array $value
-     * @param array $features
      * @param string $iar
      * @return string
      */
@@ -192,7 +190,6 @@ 
      * @param string $tbl
      * @param string $fieldType
      * @param array $value
-     * @param array $features
      * @param string $iar
      * @return string
      */
@@ -252,10 +249,8 @@ 
     /**
      * Returns a Text field 2 use in a form
      *
-     * @param string $table_source
      * @param string $fieldType
      * @param array $value
-     * @param array $features
      * @param string $iar
      * @return string
      */
@@ -281,10 +276,8 @@ 
     /**
      * Returns a Time field 2 use in a form
      *
-     * @param string $table_source
      * @param string $field_type
      * @param array $value
-     * @param array $features
      * @param string $iar
      * @return string
      */
@@ -313,10 +306,8 @@ 
     /**
      * Returns a Timestamp field 2 use in a form
      *
-     * @param string $table_source
      * @param string $field_type
      * @param array $value
-     * @param array $features
      * @param string $iar
      * @return string
      */
@@ -402,10 +393,9 @@ 
     /**
      * Returns an array with fields referenced by a Foreign key
      *
-     * @param object $db
      * @param string $database
      * @param string $tblName
-     * @param string $onlyCols
+     * @param string $onlyCol
      * @return array
      */
     private function getForeignKeysToArray($database, $tblName, $onlyCol = '')

Spacing +7 added lines, -7 removed lines

@@ -166,7 +166,7 @@ 
                 }
                 $input = $this->setStringIntoShortTag('input', $inAdtnl);
             } else {
-                $query         = $this->sQueryGenericSelectKeyValue([
+                $query = $this->sQueryGenericSelectKeyValue([
                     $foreign_keys_array[$value['COLUMN_NAME']][1],
                     $foreign_keys_array[$value['COLUMN_NAME']][2],
                     $foreign_keys_array[$value['COLUMN_NAME']][0]
@@ -213,7 +213,7 @@ 
             }
         }
         if (isset($foreignKeysArray)) {
-            $query   = $this->storedQuery('generic_select_key_value', [
+            $query = $this->storedQuery('generic_select_key_value', [
                 $foreignKeysArray[$value['COLUMN_NAME']][1],
                 $foreignKeysArray[$value['COLUMN_NAME']][2],
                 $foreignKeysArray[$value['COLUMN_NAME']][0]
@@ -225,14 +225,14 @@ 
             if (!is_null($iar)) {
                 $inAdtnl = array_merge($inAdtnl, $iar);
             }
-            $slct  = [
+            $slct = [
                 'Options' => $this->setQuery2Server($query, 'array_key_value'),
                 'Value'   => $this->getFieldValue($value),
             ];
             $input = $this->setArrayToSelect($slct['Options'], $slct['Value'], $value['COLUMN_NAME'], $inAdtnl);
             unset($foreignKeysArray);
         } else {
-            $fldNos      = $this->setFieldNumbers($value);
+            $fldNos = $this->setFieldNumbers($value);
             $inAdtnl = [
                 'type'      => ($value['COLUMN_NAME'] == 'password' ? 'password' : 'text'),
                 'name'      => $value['COLUMN_NAME'],
@@ -418,7 +418,7 @@ 
         if (isset($this->advCache['tableFKs'][$database][$tblName])) {
             foreach ($this->advCache['tableFKs'][$database][$tblName] as $value) {
                 if ($value['COLUMN_NAME'] == $onlyCol) {
-                    $query                  = $this->sQueryMySqlColumns([
+                    $query = $this->sQueryMySqlColumns([
                         'TABLE_SCHEMA' => $value['REFERENCED_TABLE_SCHEMA'],
                         'TABLE_NAME'   => $value['REFERENCED_TABLE_NAME'],
                         'DATA_TYPE'    => [
@@ -558,7 +558,7 @@ 
                 $sReturn[] = $this->setNeededField($tblSrc, $value, $feat);
             }
         }
-        $btn[]                = $this->setStringIntoShortTag('input', [
+        $btn[] = $this->setStringIntoShortTag('input', [
             'type'  => 'submit',
             'id'    => 'submit',
             'style' => 'margin-left:220px;',
@@ -591,7 +591,7 @@ 
                         'id'    => $key,
                         'value' => $value,
                     ]);
-                    $sReturn[]   = $this->setStringIntoTag($hiddenInput, 'div');
+                    $sReturn[] = $this->setStringIntoTag($hiddenInput, 'div');
                 }
             }
         }

source/MySQLiByDanielGP.php

Doc Comments +10 added lines, -9 removed lines

@@ -139,7 +139,7 @@ 
     /**
      * returns a list of MySQL databases
      *
-     * @return array
+     * @return string
      */
     protected function getMySQLactiveDatabases()
     {
@@ -149,7 +149,7 @@ 
     /**
      * returns a list of active MySQL engines
      *
-     * @return array
+     * @return string
      */
     protected function getMySQLactiveEngines()
     {
@@ -177,7 +177,7 @@ 
     /**
      * returns the list of all MySQL global variables
      *
-     * @return array
+     * @return string
      */
     protected function getMySQLglobalVariables()
     {
@@ -187,7 +187,7 @@ 
     /**
      * returns a list of MySQL indexes (w. choice of to choose any combination of db/table/column)
      *
-     * @return array
+     * @return string
      */
     protected function getMySQLlistColumns($filterArray = null)
     {
@@ -197,7 +197,7 @@ 
     /**
      * returns a list of MySQL databases (w. choice of exclude/include the system ones)
      *
-     * @return array
+     * @return string
      */
     protected function getMySQLlistDatabases($excludeSystemDbs = true)
     {
@@ -207,7 +207,7 @@ 
     /**
      * returns a list of MySQL engines (w. choice of return only the active ones)
      *
-     * @return array
+     * @return string
      */
     protected function getMySQLlistEngines($onlyActiveOnes = true)
     {
@@ -217,7 +217,7 @@ 
     /**
      * returns a list of MySQL indexes (w. choice of to choose any combination of db/table/column)
      *
-     * @return array
+     * @return string
      */
     protected function getMySQLlistIndexes($filterArray = null)
     {
@@ -227,6 +227,8 @@ 
     /**
      * Return various informations (from predefined list) from the MySQL server
      *
+     * @param string $returnChoice
+     * @param string $returnType
      * @return string
      */
     private function getMySQLlistMultiple($returnChoice, $returnType, $additionalFeatures = null)
@@ -580,7 +582,7 @@ 
      *
      * @param array $entryArray
      * @param string $referenceTable
-     * @return array
+     * @return string
      */
     private function setArrayToFilterValues($entryArray, $referenceTable = '')
     {
@@ -626,7 +628,6 @@ 
     /**
      * Returns maximum length for a given MySQL field
      *
-     * @param string $field_full_type
      * @return array
      */
     protected function setFieldNumbers($fieldDetails, $outputFormated = false)

Spacing +3 added lines, -3 removed lines

@@ -358,7 +358,7 @@ 
      */
     protected function getRowDataFromTable($tableName, $filtersArray)
     {
-        $query   = $this->sQueryRowsFromTable([
+        $query = $this->sQueryRowsFromTable([
             $tableName,
             $this->setArrayToFilterValues($filtersArray),
         ]);
@@ -720,7 +720,7 @@ 
                     case 'array_numbered':
                     case 'array_pairs_key_value':
                     case 'full_array_key_numbered':
-                        $aReturn           = $this->setMySQLquery2ServerByPattern([
+                        $aReturn = $this->setMySQLquery2ServerByPattern([
                             'NoOfColumns' => $result->field_count,
                             'NoOfRows'    => $result->num_rows,
                             'QueryResult' => $result,
@@ -730,7 +730,7 @@ 
                         break;
                     case 'full_array_key_numbered_with_record_number_prefix':
                     case 'full_array_key_numbered_with_prefix':
-                        $aReturn           = $this->setMySQLquery2ServerByPattern([
+                        $aReturn = $this->setMySQLquery2ServerByPattern([
                             'NoOfColumns' => $result->field_count,
                             'NoOfRows'    => $result->num_rows,
                             'QueryResult' => $result,

source/MySQLiByDanielGPqueries.php

Doc Comments +3 added lines, -3 removed lines

@@ -91,7 +91,7 @@ 
      * Internal function to concatenate filters
      *
      * @param type $filters
-     * @return type
+     * @return string
      */
     private function sGlueFiltersIntoWhereArrayFilter($filters)
     {
@@ -129,7 +129,7 @@ 
      * Query to list Databases
      *
      * @param type $excludeSystemDbs
-     * @return type
+     * @return string
      */
     protected function sQueryMySqlActiveDatabases($excludeSystemDbs = true)
     {
@@ -151,7 +151,7 @@ 
      * Query to list MySQL engines
      *
      * @param string $onlyActiveOnes
-     * @return type
+     * @return string
      */
     protected function sQueryMySqlActiveEngines($onlyActiveOnes = true)
     {

source/DomComponentsByDanielGP.php

Spacing +4 added lines, -4 removed lines

@@ -411,7 +411,7 @@ 
                                     . $aElements[$rCntr][$value] . '"/>';
                             break;
                         case 'edit':
-                            $edt           = '';
+                            $edt = '';
                             if (isset($ftrs['NoAjaxEditing'])) {
                                 $edt .= $_SERVER['PHP_SELF'] . '?' . $actPrfx
                                         . $action_key . '=' . $value[0] . '&';
@@ -479,7 +479,7 @@ 
                     switch ($value[1]) {
                         case '/':
                             // next variable is only to avoid a long line
-                            $shorter                 = [
+                            $shorter = [
                                 $aElements[$rCntr][$value[3]],
                                 $aElements[$rCntr][$value[4]],
                             ];
@@ -487,7 +487,7 @@ 
                             break;
                         case '+':
                             // next variable is only to avoid a long line
-                            $iTemp                   = $this->setArrayValuesAsKey([
+                            $iTemp = $this->setArrayValuesAsKey([
                                 $value[0],
                                 $value[1],
                                 $value[2]
@@ -846,7 +846,7 @@ 
                                         . filter_var($value, FILTER_SANITIZE_STRING) . '">';
                                 break;
                             case 'title':
-                                $aFeatures[]                 = '<title>'
+                                $aFeatures[] = '<title>'
                                         . filter_var($value, FILTER_SANITIZE_STRING) . '</title>';
                                 break;
                         }

Doc Comments +8 added lines, -4 removed lines

@@ -108,9 +108,7 @@ 
     /**
      * Returns a table from an query
      *
-     * @param array $gArray
-     * @param array $features
-     * @param boolean $bKeepFullPage
+     * @param boolean $bKpFlPge
      * @return string
      */
     protected function setArrayToTable($aElements, $ftrs = null, $bKpFlPge = true)
@@ -580,7 +578,7 @@ 
     /**
      * Returns css link to a given file
      *
-     * @param string $cssFile
+     * @param string $cssFileName
      * @return string
      */
     protected function setCssFile($cssFileName, $hostsWithoutCDNrq = null)
@@ -676,6 +674,9 @@ 
         return '';
     }
 
+    /**
+     * @param string $outputType
+     */
     private function setGZipedUnsafe($outputType)
     {
         $rqst = new \Symfony\Component\HttpFoundation\Request;
@@ -982,6 +983,9 @@ 
         return $addingUrl;
     }
 
+    /**
+     * @param integer $groupCounter
+     */
     protected function updateDivTitleName($rememberGroupVal, $groupCounter)
     {
         $jsContent = '$(document).ready(function() { $("#tab_'

source/DomDynamicSelectByDanielGP.php

Doc Comments +12 added lines

@@ -57,6 +57,9 @@ 
         return '';
     }
 
+    /**
+     * @param string $identifier
+     */
     private function featureArraySimpleDirect($featArray, $identifier)
     {
         if (in_array($identifier, $featArray)) {
@@ -65,6 +68,9 @@ 
         return '';
     }
 
+    /**
+     * @param string $identifier
+     */
     private function featureArraySimpleTranslated($featArray, $identifier)
     {
         $translation = [
@@ -77,6 +83,9 @@ 
         return '';
     }
 
+    /**
+     * @param string $identifier
+     */
     private function featureArrayAssociative($featArray, $identifier)
     {
         if (in_array($identifier, $featArray)) {
@@ -85,6 +94,9 @@ 
         return '';
     }
 
+    /**
+     * @param string $selectName
+     */
     protected function setArrayToSelectNotReadOnly($aElements, $sDefaultValue, $selectName, $featArray = null)
     {
         if (!is_array($featArray)) {