pH7Software / pH7-Social-Dating-CMS

_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/Image/Image.class.php

Doc Comments +13 added lines, -13 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)
      {
@@ -342,7 +342,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)
@@ -374,7 +374,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()
@@ -409,7 +409,7 @@ 
 
     /**
      * @desc Get File Name.
-     * @return string
+     * @return resource
      */
     public function getFileName()
     {
@@ -419,7 +419,7 @@ 
     /**
      * Determine and get the type of the image (even an unallowed image type) by reading the first bytes and checking its signature.
      *
-     * @return mixed (string | boolean) When a correct signature is found, returns the appropriate value, FALSE otherwise.
+     * @return integer (string | boolean) When a correct signature is found, returns the appropriate value, FALSE otherwise.
      */
     public function getType()
     {

_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/Layout/Html/Design.class.php

Doc Comments +8 added lines, -3 removed lines

@@ -253,6 +253,11 @@ 
         }
     }
 
+    /**
+     * @param string $sModule
+     * @param string $sController
+     * @param string $sAction
+     */
     public function url($sModule, $sController, $sAction, $sVars = null, $bClear = true)
     {
         $sUrl = Uri::get($sModule, $sController, $sAction, $sVars, $bClear);
@@ -514,7 +519,7 @@ 
      * @internal If it's an IPv6, show only the beginning, otherwise it would be too long in the template.
      * @param string $sIp IP address. Default NULL
      * @param boolean $bPrint Print or Return the HTML code. Default TRUE
-     * @return mixed (string | void)
+     * @return null|string (string | void)
      */
     public function ip($sIp = null, $bPrint = true)
     {
@@ -531,7 +536,7 @@ 
      * Show the geolocation of the user (with link that points to the Country controller).
      *
      * @param boolean $bPrint Print or Return the HTML code. Default TRUE
-     * @return mixed (string | void)
+     * @return null|string (string | void)
      */
     public function geoIp($bPrint = true)
     {
@@ -563,7 +568,7 @@ 
     /**
      * Get the User Avatar.
      *
-     * @param string $sUername
+     * @param string $sUsername
      * @param string $sSex
      * @param integer $iSize
      * @return void Html contents. URL avatar default 150px or the user avatar.

Unused Use Statements +17 added lines, -18 removed lines

@@ -12,24 +12,23 @@
 namespace PH7\Framework\Layout\Html;
 defined('PH7') or exit('Restricted access');
 
-use
-PH7\Framework\Core\Kernel,
-PH7\Framework\Registry\Registry,
-PH7\Framework\Mvc\Model\Engine\Db,
-PH7\Framework\Mvc\Model\DbConfig,
-PH7\Framework\Url\Url,
-PH7\Framework\Ip\Ip,
-PH7\Framework\Geo\Ip\Geo,
-PH7\Framework\Str\Str,
-PH7\Framework\File\File,
-PH7\Framework\Session\Session,
-PH7\Framework\Navigation\Page,
-PH7\Framework\Geo\Misc\Country,
-PH7\Framework\Benchmark\Benchmark,
-PH7\Framework\Layout\Tpl\Engine\PH7Tpl\PH7Tpl,
-PH7\Framework\Module\Various as SysMod,
-PH7\Framework\Mvc\Request\Http,
-PH7\Framework\Mvc\Router\Uri;
+use PH7\Framework\Core\Kernel;
+use PH7\Framework\Registry\Registry;
+use PH7\Framework\Mvc\Model\Engine\Db;
+use PH7\Framework\Mvc\Model\DbConfig;
+use PH7\Framework\Url\Url;
+use PH7\Framework\Ip\Ip;
+use PH7\Framework\Geo\Ip\Geo;
+use PH7\Framework\Str\Str;
+use PH7\Framework\File\File;
+use PH7\Framework\Session\Session;
+use PH7\Framework\Navigation\Page;
+use PH7\Framework\Geo\Misc\Country;
+use PH7\Framework\Benchmark\Benchmark;
+use PH7\Framework\Layout\Tpl\Engine\PH7Tpl\PH7Tpl;
+use PH7\Framework\Module\Various as SysMod;
+use PH7\Framework\Mvc\Request\Http;
+use PH7\Framework\Mvc\Router\Uri;
 
 class Design
 {

_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)

Unused Use Statements +2 added lines, -3 removed lines

@@ -15,9 +15,8 @@
 namespace PH7\Framework\Mvc\Request;
 defined('PH7') or exit('Restricted access');
 
-use
-PH7\Framework\Registry\Registry,
-PH7\Framework\Security as Secty;
+use PH7\Framework\Registry\Registry;
+use PH7\Framework\Security as Secty;
 
 /**
  * Small example of using this class.