pH7Software / pH7-Social-Dating-CMS

_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 copyMost($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 renameMost($sFrom, $sTo)
     {
@@ -417,6 +419,7 @@ 
      * Get the 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)
     {
@@ -680,7 +684,7 @@ 
      * Get the URL contents (For URLs, it is better to use CURL because it is faster than file_get_contents function).
      *
      * @param string $sFile 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($sFile)
     {
@@ -732,7 +736,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/MapAPI.class.php

Doc Comments +2 added lines, -5 removed lines

@@ -263,7 +263,6 @@ 
     /**
      * Set the zoom of the infowindow
      *
-     * @param int $zoom GoogleMap  zoom.
      *
      * @return void
      */
@@ -276,8 +275,8 @@ 
     /**
      * Enable the zoom on the marker when you click on it
      *
-     * @param int $zoom GoogleMap  zoom.
      *
+     * @param boolean $enableWindowZoom
      * @return void
      */
 
@@ -289,7 +288,6 @@ 
     /**
      * Enable theautomatic center/zoom at the gmap load
      *
-     * @param int $zoom GoogleMap  zoom.
      *
      * @return void
      */
@@ -400,8 +398,7 @@ 
     /**
      * Remove accentued characters
      *
-     * @param string $chaine        The string to treat
-     * @param string $remplace_par  The replacement character
+     * @param string $text
      * @return string
      */
     public function withoutSpecialChars($text, $replaceBy = '_')

_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
      */
     public static function setHeaders($mHeaders)
     {
@@ -184,7 +185,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/Http/Rest/Rest.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
     }
 
     /**
-     * @param array $aData The data from a request
+     * @param string $aData The data from a request
      * @param integer $iStatus Status Code. Default 200
      * @return void
      */

_protected/framework/Image/Image.class.php

Doc Comments +12 added lines, -12 removed lines

@@ -100,7 +100,7 @@ 
     /**
      * @desc Image Quality.
      * @param integer $iQ Devault value 100.
-     * @return object $this
+     * @return Image $this
      */
     public function quality($iQ = 100)
     {
@@ -111,7 +111,7 @@ 
     /**
      * @desc Image Compression.
      * @param integer $iC Devault value 4.
-     * @return object $this
+     * @return Image $this
      */
     public function compression($iC = 4)
     {
@@ -123,7 +123,7 @@ 
      * @desc Resize
      * @param integer $iX Default value null
      * @param integer $iY Default value null
-     * @return object $this
+     * @return Image $this
      */
     public function resize($iX = null, $iY = null)
     {
@@ -154,7 +154,7 @@ 
      * @param integer $iY Default value 0.
      * @param integer $iWidth Default valie 1.
      * @param integer $iHeight Default value 1.
-     * @return object $this
+     * @return Image $this
      */
     public function crop($iX = 0, $iY = 0, $iWidth = 1, $iHeight = 1)
     {
@@ -173,7 +173,7 @@ 
      * @desc Dynamic Resize.
      * @param integer $iNewWidth
      * @param integer $iNewHeight
-     * @return object $this
+     * @return Image $this
      */
     public function dynamicResize($iNewWidth, $iNewHeight)
     {
@@ -204,7 +204,7 @@ 
      * @desc Square.
      * @param integer $iSize
      * @see \PH7\Framework\Image\Image::dynamicResize() The method that is returned by this method.
-     * @return object $this
+     * @return Image $this
      */
     public function square($iSize)
     {
@@ -217,7 +217,7 @@ 
      * @param integer $iHeight
      * @param string $sZone Default value is center.
      * @see \PH7\Framework\Image\Image::crop() The method that is returned by this method.
-     * @return object $this
+     * @return Image $this
      * @throws \PH7\Framework\Error\CException\PH7InvalidArgumentException If the image crop is invalid.
      */
     public function zoneCrop($iWidth, $iHeight, $sZone = 'center')
@@ -291,7 +291,7 @@ 
      * @desc Rotate.
      * @param integer $iDeg Default value 0.
      * @param integer $iBg Default value 0.
-     * @return object $this
+     * @return Image $this
      */
     public function rotate($iDeg = 0, $iBg = 0)
     {
@@ -304,7 +304,7 @@ 
      * @desc Create a Watermark text.
      * @param string $sText Text of watermark.
      * @param integer $iSize The size of text. Between 0 to 5.
-     * @return object $this
+     * @return Image $this
      */
      public function watermarkText($sText, $iSize)
      {
@@ -341,7 +341,7 @@ 
     /**
      * @desc Save Image.
      * @param string $sFile
-     * @return object $this
+     * @return Image $this
      * @throws \PH7\Framework\Error\CException\PH7InvalidArgumentException If the image format is invalid.
      */
     public function save($sFile)
@@ -373,7 +373,7 @@ 
 
     /**
      * @desc Show Image.
-     * @return object $this
+     * @return Image $this
      * @throws \PH7\Framework\Error\CException\PH7InvalidArgumentException If the image format is invalid.
      */
     public function show()
@@ -408,7 +408,7 @@ 
 
     /**
      * @desc Get File Name.
-     * @return string
+     * @return resource
      */
     public function getFileName()
     {

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

Doc Comments +3 added lines

@@ -198,6 +198,9 @@
         $this->form = $form;
     }
 
+    /**
+     * @param string $id
+     */
     public function setID($id)
     {
         $this->attributes['id'] = $id;

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

Doc Comments +15 added lines

@@ -281,6 +281,10 @@ 
      }
 
     /*This method restores the serialized form instance.*/
+
+    /**
+     * @param string $id
+     */
     private static function recover($id)
     {
         if(!empty($_SESSION['pfbc'][$id]['form']))
@@ -481,6 +485,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, $errors, $element = '')
     {
         if(!is_array($errors))
@@ -493,11 +501,18 @@ 
     }
 
     /*setSuccess*/
+
+    /**
+     * @param string $id
+     */
     public static function setSuccess($id, $success, $element = '')
     {
          return (new \PH7\Framework\Layout\Html\Design)->setFlashMsg($success);
     }
 
+    /**
+     * @param string $id
+     */
     public static function setSessionValue($id, $element, $value)
     {
         $_SESSION['pfbc'][$id]['values'][$element] = $value;

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

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
      * Get Time text.
      *
      * @param integer $iWaitTime
-     * @return integer
+     * @return string
      */
     private static function _getTimeText($iWaitTime)
     {

_protected/framework/Layout/Gzip/Gzip.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -357,7 +357,7 @@
     /**
      * Set CSS/JS variables.
      *
-     * @param array $aVars Variable names containing the values.
+     * @param array $aVals Variable names containing the values.
      * @return void
      */
     private function _setVariables(array $aVals)