pH7Software / pH7-Social-Dating-CMS

_protected/framework/Cache/Cache.class.php

Doc Comments +9 added lines, -9 removed lines

@@ -44,7 +44,7 @@ 
      * Enabled/Disabled the cache.
      *
      * @param boolean $bIsEnable
-     * @return object this
+     * @return Cache this
      */
     public function enabled($bIsEnable)
     {
@@ -59,7 +59,7 @@ 
      * If you do not use this method, a default directory will be created.
      *
      * @param string $sCacheDir
-     * @return object this
+     * @return Cache this
      * @throws \PH7\Framework\Error\CException\PH7InvalidArgumentException An explanatory message if the directory does not exist.
      */
     public function setCacheDir($sCacheDir)
@@ -76,7 +76,7 @@ 
      * Sets the cache prefix.
      *
      * @param string $sPrefix
-     * @return object this
+     * @return Cache this
      */
     public function setPrefix($sPrefix)
     {
@@ -88,7 +88,7 @@ 
      * Sets the time expire cache.
      *
      * @param integer $iExpire (the time with the 'touch' function).
-     * @return object this
+     * @return Cache this
      */
     public function setExpire($iExpire)
     {
@@ -104,7 +104,7 @@ 
      * @param string $sGroup The Group Cache (This creates a folder).
      * @param string $sId (The ID for the file).
      * @param integer $iTtl Cache lifetime in seconds. If NULL, the file never expires.
-     * @return object this
+     * @return Cache this
      */
     public function start($sGroup, $sId, $iTtl)
     {
@@ -162,7 +162,7 @@ 
      * Puts the data in the cache.
      *
      * @param string $sData
-     * @return string (object | null) If the cache is disabled, returns null otherwise returns a this object.
+     * @return null|Cache (object | null) If the cache is disabled, returns null otherwise returns a this object.
      */
     public function put($sData)
     {
@@ -176,7 +176,7 @@ 
     /**
      * Clear the cache.
      *
-     * @return object this
+     * @return Cache this
      */
     public function clear()
     {
@@ -263,7 +263,7 @@ 
      *
      * @access private
      * @param boolean $bPrint
-     * @return mixed (boolean | string) Returns TRUE or a string if successful, FALSE otherwise.
+     * @return string (boolean | string) Returns TRUE or a string if successful, FALSE otherwise.
      */
     private function _read($bPrint)
     {
@@ -324,7 +324,7 @@ 
      *
      * If the folder cache does not exist, it creates a folder.
      * @access private
-     * @return object this
+     * @return Cache this
      */
     private function _checkCacheDir()
     {

_protected/framework/Compress/Compress.class.php

Doc Comments +3 added lines

@@ -68,6 +68,9 @@
         $this->_bIsGoogleClosure = (bool) Config::getInstance()->values['cache']['enable.js.closure_compiler_service'];
     }
 
+    /**
+     * @param string $sPhp
+     */
     public function parsePhp($sPhp)
     {
         $sPhp = preg_replace('#/\*.*+\*#', '', $sPhp); # Removing PHP comments

_protected/framework/File/File.class.php

Doc Comments +9 added lines, -5 removed lines

@@ -120,6 +120,7 @@ 
      * Check if file exists.
      *
      * @param mixed (array | string) $mFile
+     * @param string $mFile
      * @return boolean TRUE if file exists, FALSE otherwise.
      */
     public function existFile($mFile)
@@ -273,6 +274,7 @@ 
      *
      * @param mixed (string | array) $mDir
      * @param integer (octal) $iMode Default: 0777
+     * @param string $mDir
      * @return void
      * @throws \PH7\Framework\File\Exception If the file cannot be created.
      */
@@ -321,7 +323,7 @@ 
      *
      * @param string $sFrom File or directory.
      * @param string $sTo File or directory.
-     * @return mixed (integer | boolean) Returns the last line on success, and FALSE on failure.
+     * @return string|false (integer | boolean) Returns the last line on success, and FALSE on failure.
      */
     public function systemCopy($sFrom, $sTo)
     {
@@ -363,7 +365,7 @@ 
      *
      * @param string $sFrom File or directory.
      * @param string $sTo File or directory.
-     * @return mixed (integer | boolean) Returns the last line on success, and FALSE on failure.
+     * @return string|false (integer | boolean) Returns the last line on success, and FALSE on failure.
      */
     public function systemRename($sFrom, $sTo)
     {
@@ -417,6 +419,7 @@ 
      * Get the creation/modification time of a file in the Unix timestamp.
      *
      * @param string Full path of the file.
+     * @param string $sFile
      * @return mixed (integer | boolean) Returns the time the file was last modified, or FALSE if it not found.
      */
     public function getModifTime($sFile)
@@ -430,6 +433,7 @@ 
      *
      * @static
      * @param string Full path of the file.
+     * @param string $sFile
      * @return integer Returns the latest modification time of the file in Unix timestamp.
      */
     public static function version($sFile)
@@ -441,7 +445,7 @@ 
      * Delay script execution.
      *
      * @param integer $iSleep Halt time in seconds. Optional parameter, default value is 5.
-     * @return mixed (integer | boolean) Returns "0" on success, or "false" on error.
+     * @return integer (integer | boolean) Returns "0" on success, or "false" on error.
      */
     public function sleep($iSleep = null)
     {
@@ -681,7 +685,7 @@ 
      * Get the URL contents (For URLs, it is better to use CURL because it is faster than file_get_contents function).
      *
      * @param string $sUrl URL to be read contents.
-     * @return mixed (string | boolean) Return the result content on success, FALSE on failure.
+     * @return string (string | boolean) Return the result content on success, FALSE on failure.
      */
     public function getUrlContents($sUrl)
     {
@@ -754,7 +758,7 @@ 
      * Create a recurive directory iterator for a given directory.
      *
      * @param string $sPath
-     * @return string The directory.
+     * @return \RecursiveDirectoryIterator The directory.
      */
     public function getDirIterator($sPath)
     {

_protected/framework/Geo/Map/Api.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -217,7 +217,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return boolean
      */
     public function getEnableGeolocation()
     {
@@ -445,7 +445,7 @@ 
      *
      * @param string $address an address
      *
-     * @return array array with precision, lat & lng
+     * @return string array with precision, lat & lng
      */
     public function geocoding($address)
     {

_protected/framework/Http/Http.class.php

Doc Comments +3 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
     /**
      * @static
      * @param integer $iStatus The "code" for the HTTP status
-     * @return mixed (string | boolean) $iStatus Returns the "HTTP status code" if found otherwise returns "false"
+     * @return integer (string | boolean) $iStatus Returns the "HTTP status code" if found otherwise returns "false"
      */
     public static function getStatusCodes($iStatus)
     {
@@ -129,6 +129,7 @@ 
      *
      * @static
      * @param mixed (string | array) $mHeaders Headers to send.
+     * @param string $mHeaders
      * @throws \PH7\Framework\Http\Exception
      */
     public static function setHeaders($mHeaders)
@@ -188,7 +189,7 @@ 
      * @static
      * @param string $sUsr
      * @param string $sPwd
-     * @return boolean TRUE if the authentication is correct, otherwise FALSE.
+     * @return null|boolean TRUE if the authentication is correct, otherwise FALSE.
      */
     public static function requireAuth($sUsr, $sPwd)
     {

_protected/framework/Layout/Form/Engine/PFBC/Form.class.php

Doc Comments +15 added lines

@@ -283,6 +283,10 @@ 
      }
 
     /*This method restores the serialized form instance.*/
+
+    /**
+     * @param string $id
+     */
     private static function recover($id)
     {
         if(!empty($_SESSION['pfbc'][$id]['form']))
@@ -483,6 +487,10 @@ 
 
     /*Valldation errors are saved in the session after the form submission, and will be displayed to the user
     when redirected back to the form.*/
+
+    /**
+     * @param string $id
+     */
     public static function setError($id, $messages, $element = '')
     {
         if (!is_array($messages))
@@ -496,11 +504,18 @@ 
     }
 
     /*setSuccess*/
+
+    /**
+     * @param string $id
+     */
     public static function setSuccess($id, $message, $element = '')
     {
          return (new Design)->setFlashMsg($message, Design::SUCCESS_TYPE);
     }
 
+    /**
+     * @param string $id
+     */
     public static function setSessionValue($id, $element, $value)
     {
         $_SESSION['pfbc'][$id]['values'][$element] = $value;

_protected/framework/Math/Measure/Weight.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
      * @see get()
      *
      * @param boolean $bPrint Default FALSE
-     * @return void
+     * @return null|string
      */
     public function display($bPrint = false)
     {

_protected/framework/Mvc/Request/Http.class.php

Doc Comments +2 added lines

@@ -108,6 +108,7 @@ 
      *
      * @param mixed (array or string) $mKey The key of the request or an array with the list of key of the variables request.
      * @param string $sParam Optional parameter, check the type of the request variable | Value type is: str, int, float, bool
+     * @param string $mKey
      * @return boolean
      */
     public function postExists($mKey, $sParam = null)
@@ -280,6 +281,7 @@ 
     }
 
     /**
+     * @param string $sUrl
      * @return string The correct pH7's URL.
      */
     public function pH7Url($sUrl)

_protected/framework/Str/Str.class.php

Doc Comments +7 added lines, -4 removed lines

@@ -77,7 +77,7 @@ 
       * Count the length of a string and supports the special characters (Asian, Latin, ...).
       *
       * @param string $sText
-      * @return string
+      * @return integer
       */
      public function length($sText)
      {
@@ -115,8 +115,8 @@ 
       * Test the equality of two strings.
       *
       * @personal For the PHP AND C functions, strcmp and strcasecmp returns a positive or negative integer value if they are different and 0 if they are equal.
-      * @param string $text1
-      * @param string $text2
+      * @param string $sText1
+      * @param string $sText2
       * @return boolean
       */
      public function equals($sText1, $sText2)
@@ -298,7 +298,7 @@ 
       * @access protected
       * @param string $sText
       * @param boolean $bStrip
-      * @return The text parsed with Str::stripTags() method if $bStrip parameter is TRUE, otherwise with Str::htmlSpecialChars method.
+      * @return string text parsed with Str::stripTags() method if $bStrip parameter is TRUE, otherwise with Str::htmlSpecialChars method.
       */
      protected function cEscape($sText, $bStrip)
      {
@@ -325,6 +325,9 @@ 
          return htmlspecialchars($sText, ENT_QUOTES, 'utf-8');
      }
 
+     /**
+      * @param string $sPattern
+      */
      private static function _regexNormalize($sPattern)
      {
          return self::$_sRegexDelimiter . trim($sPattern, self::$_sRegexDelimiter) . self::$_sRegexDelimiter;