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

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 = '')

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/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

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 +6 added lines

@@ -87,6 +87,9 @@ 
         return $sReturn;
     }
 
+    /**
+     * @param string $identifier
+     */
     private function featureArraySimpleTranslated($featArray, $identifier)
     {
         $translation = [
@@ -118,6 +121,9 @@ 
         return $featArray;
     }
 
+    /**
+     * @param string $selectName
+     */
     protected function setArrayToSelectNotReadOnly($aElements, $sDefaultValue, $selectName, $featArray = null)
     {
         if (!is_array($featArray)) {