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)

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()
     {

source/MySQLiAdvancedOutput.php

Doc Comments +19 added lines, -2 removed lines

@@ -57,6 +57,9 @@ 
         return explode('.', str_replace('`', '', $tblSrc));
     }
 
+    /**
+     * @param string $fldType
+     */
     private function establishDefaultEnumSet($fldType)
     {
         $dfltArray = [
@@ -315,6 +318,9 @@ 
         return $this->setStringIntoShortTag('input', $inAdtnl);
     }
 
+    /**
+     * @param string $tbl
+     */
     private function getFieldOutputTextPrerequisites($tbl, $value)
     {
         $foreignKeysArray = null;
@@ -542,6 +548,10 @@ 
         return array_merge([], $rOly, $rDbld, $rNl);
     }
 
+    /**
+     * @param string $fieldName
+     * @param string $featureKey
+     */
     private function handleFeaturesSingle($fieldName, $features, $featureKey)
     {
         $fMap    = [
@@ -656,7 +666,7 @@ 
      * @param string $tableSource
      * @param array $details
      * @param array $features
-     * @return string|array
+     * @return null|string
      */
     private function setNeededField($tableSource, $details, $features)
     {
@@ -678,7 +688,7 @@ 
      * @param string $tblName
      * @param array $dtls
      * @param array $features
-     * @return string|array
+     * @return string
      */
     private function setNeededFieldByType($tblName, $dtls, $features)
     {
@@ -689,6 +699,9 @@ 
         return $this->setNeededFieldKnown($tblName, $dtls, $features);
     }
 
+    /**
+     * @param string $tblName
+     */
     private function setNeededFieldKnown($tblName, $dtls, $features)
     {
         $iar      = $this->handleFeatures($dtls['COLUMN_NAME'], $features);
@@ -704,6 +717,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);