danielgp / common-lib

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

@@ -567,7 +567,7 @@ 
 
     private function stFldLmtsExact($colType)
     {
-        $xct     = [
+        $xct = [
             'bigint'    => ['l' => -9223372036854775808, 'L' => 999999999999, 's' => 21, 'sUS' => 20],
             'int'       => ['l' => -2147483648, 'L' => 2147483647, 's' => 11, 'sUS' => 10],
             'mediumint' => ['l' => -8388608, 'L' => 8388607, 's' => 9, 'sUS' => 8],
@@ -635,7 +635,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,
@@ -645,7 +645,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/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;
                         }

source/CommonBasic.php

Doc Comments +8 added lines, -2 removed lines

@@ -63,6 +63,9 @@ 
         return $aDetails;
     }
 
+    /**
+     * @param string $fileGiven
+     */
     protected function getFileDetailsRawStatistic(\SplFileInfo $info, $fileGiven)
     {
         return [
@@ -81,6 +84,9 @@ 
         ];
     }
 
+    /**
+     * @param integer $timeAsPhpNumber
+     */
     private function getFileTimes($timeAsPhpNumber)
     {
         return [
@@ -94,7 +100,7 @@ 
      *
      * @param type $sourcePath
      * @param type $targetPath
-     * @return type
+     * @return string
      */
     protected function moveFilesIntoTargetFolder($sourcePath, $targetPath)
     {
@@ -210,7 +216,7 @@ 
     /**
      * Provides a list of all known JSON errors and their description
      *
-     * @return type
+     * @return null|string
      */
     protected function setJsonErrorInPlainEnglish()
     {

Spacing +2 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
             'Name'                   => $info->getRealPath(),
             'Type'                   => $info->getType(),
         ];
-        $aDetails          = array_merge($aFileBasicDetails, $this->getFileDetailsRawStatistic($info, $fileGiven));
+        $aDetails = array_merge($aFileBasicDetails, $this->getFileDetailsRawStatistic($info, $fileGiven));
         ksort($aDetails);
         return $aDetails;
     }
@@ -214,7 +214,7 @@ 
      */
     protected 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/DomCssAndJavascriptByDanielGPwithCDN.php

Spacing +1 added lines, -1 removed lines

@@ -133,7 +133,7 @@
             'highcharts' => 'setJavascriptFileCDNforHighCharts',
             'exporting'  => 'setJavascriptFileCDNforHighChartsExporting',
         ];
-        $rootFN     = pathinfo($sFileParts[0])['basename'];
+        $rootFN = pathinfo($sFileParts[0])['basename'];
         if (array_key_exists($rootFN, $knownFNs)) {
             return call_user_func([$this, $knownFNs[$rootFN]], pathinfo($jsFileName)['basename']);
         }

source/MySQLiAdvancedOutput.php

Spacing +3 added lines, -3 removed lines

@@ -214,7 +214,7 @@ 
 
     private function getFieldOutputNumericNonFK($fkArray, $value, $iar = [])
     {
-        $query         = $this->sQueryGenericSelectKeyValue([
+        $query = $this->sQueryGenericSelectKeyValue([
             $fkArray[$value['COLUMN_NAME']][1],
             $fkArray[$value['COLUMN_NAME']][2],
             $fkArray[$value['COLUMN_NAME']][0],
@@ -254,7 +254,7 @@ 
 
     private function getFieldOutputTextFK($foreignKeysArray, $value, $iar)
     {
-        $query   = $this->sQueryGenericSelectKeyValue([
+        $query = $this->sQueryGenericSelectKeyValue([
             $foreignKeysArray[$value['COLUMN_NAME']][1],
             $foreignKeysArray[$value['COLUMN_NAME']][2],
             $foreignKeysArray[$value['COLUMN_NAME']][0]
@@ -541,7 +541,7 @@ 
 
     private function handleFeaturesSingle($fieldName, $features, $featureKey)
     {
-        $fMap    = [
+        $fMap = [
             'readonly' => ['readonly', 'class', 'input_readonly'],
             'disabled' => ['disabled']
         ];

Doc Comments +11 added lines, -4 removed lines

@@ -298,7 +298,7 @@ 
      * @param type $foreignKeysArray
      * @param type $value
      * @param type $iar
-     * @return type
+     * @return string
      */
     private function getFieldOutputTextFK($foreignKeysArray, $value, $iar)
     {
@@ -797,7 +797,7 @@ 
      * @param string $tableSource
      * @param array $details
      * @param array $features
-     * @return string|array
+     * @return null|string
      */
     private function setNeededField($tableSource, $details, $features)
     {
@@ -819,7 +819,7 @@ 
      * @param string $tblName
      * @param array $dtls
      * @param array $features
-     * @return string|array
+     * @return string
      */
     private function setNeededFieldByType($tblName, $dtls, $features)
     {
@@ -830,6 +830,9 @@ 
         return $this->setNeededFieldKnown($tblName, $dtls, $features);
     }
 
+    /**
+     * @param string $tblName
+     */
     private function setNeededFieldKnown($tblName, $dtls, $features)
     {
         $iar      = $this->handleFeatures($dtls['COLUMN_NAME'], $features);
@@ -845,6 +848,10 @@ 
         return $this->getFieldCompletionType($dtls) . $sReturn;
     }
 
+    /**
+     * @param string $tableSource
+     * @param string $fieldLabel
+     */
     private function setNeededFieldFinal($tableSource, $details, $features, $fieldLabel)
     {
         $sReturn = $this->setField($tableSource, $details, $features, $fieldLabel);
@@ -881,7 +888,7 @@ 
     /**
      * create a Cache for given table to use it in many places
      *
-     * @param type $tblSrc
+     * @param string $tblSrc
      */
     private function setTableCache($tblSrc)
     {