pH7Software / pH7-Social-Dating-CMS

_protected/app/system/modules/picture/models/PictureModel.php

Doc Comments +32 added lines

@@ -12,6 +12,11 @@ 
 class PictureModel extends PictureCoreModel
 {
 
+    /**
+     * @param string $iProfileId
+     * @param string $sThumb
+     * @param string $sCreatedDate
+     */
     public function addAlbum($iProfileId, $sTitle, $sDescription, $sThumb, $sCreatedDate, $iApproved = 1)
     {
         $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('AlbumsPictures') . '(profileId, name, description, thumb, createdDate, approved)
@@ -26,6 +31,12 @@ 
         return $rStmt->execute();
     }
 
+    /**
+     * @param string $iProfileId
+     * @param integer $iAlbumId
+     * @param string $sFile
+     * @param string $sCreatedDate
+     */
     public function addPhoto($iProfileId, $iAlbumId, $sTitle, $sDescription, $sFile, $sCreatedDate, $iApproved = 1)
     {
         $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('Pictures') . '(profileId, albumId, title, description, file, createdDate, approved)
@@ -49,6 +60,9 @@ 
         return $rStmt->execute();
     }
 
+    /**
+     * @param string $iProfileId
+     */
     public function getAlbumsName($iProfileId)
     {
         $this->cache->start(self::CACHE_GROUP, 'albumName' . $iProfileId, static::CACHE_TIME);
@@ -66,6 +80,13 @@ 
         return $oData;
     }
 
+    /**
+     * @param string $iProfileId
+     * @param string $iAlbumId
+     * @param string $iPictureId
+     * @param integer $iOffset
+     * @param integer $iLimit
+     */
     public function photo($iProfileId, $iAlbumId, $iPictureId = null, $iApproved = 1, $iOffset, $iLimit)
     {
         $this->cache->start(self::CACHE_GROUP, 'photo' . $iProfileId . $iAlbumId . $iPictureId . $iApproved . $iOffset . $iLimit, static::CACHE_TIME);
@@ -132,6 +153,11 @@ 
         return $iData;
     }
 
+    /**
+     * @param string $iProfileId
+     * @param integer $iAlbumId
+     * @param string $sUpdatedDate
+     */
     public function updateAlbum($iProfileId, $iAlbumId, $sTitle, $sDescription, $sUpdatedDate)
     {
         $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('AlbumsPictures') .
@@ -145,6 +171,12 @@ 
         return $rStmt->execute();
     }
 
+    /**
+     * @param string $iProfileId
+     * @param integer $iAlbumId
+     * @param integer $iPictureId
+     * @param string $sUpdatedDate
+     */
     public function updatePhoto($iProfileId, $iAlbumId, $iPictureId, $sTitle, $sDescription, $sUpdatedDate)
     {
         $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('Pictures') .

_protected/app/system/modules/video/models/VideoModel.php

Doc Comments +29 added lines

@@ -12,6 +12,9 @@ 
 class VideoModel extends VideoCoreModel
 {
 
+    /**
+     * @param string $sThumb
+     */
     public function addAlbum($iProfileId, $sTitle, $sDescription, $sThumb, $sCreatedDate, $iApproved = 1)
     {
         $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('AlbumsVideos') . '(profileId, name, description, thumb, createdDate, approved)
@@ -26,6 +29,13 @@ 
         return $rStmt->execute();
     }
 
+    /**
+     * @param string $iProfileId
+     * @param integer $iAlbumId
+     * @param string $sFile
+     * @param string $sThumb
+     * @param string $sCreatedDate
+     */
     public function addVideo($iProfileId, $iAlbumId, $sTitle, $sDescription, $sFile, $sThumb, $sDuration, $sCreatedDate, $iApproved = 1)
     {
         $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('Videos') . '(profileId, albumId, title, description, file, thumb, duration, createdDate, approved)
@@ -51,6 +61,9 @@ 
         return $rStmt->execute();
     }
 
+    /**
+     * @param string $iProfileId
+     */
     public function getAlbumsName($iProfileId)
     {
         $this->cache->start(self::CACHE_GROUP, 'albumName' . $iProfileId, static::CACHE_TIME);
@@ -68,6 +81,13 @@ 
         return $oData;
     }
 
+    /**
+     * @param string $iProfileId
+     * @param string $iAlbumId
+     * @param string $iVideoId
+     * @param integer $iOffset
+     * @param integer $iLimit
+     */
     public function video($iProfileId, $iAlbumId, $iVideoId = null, $iApproved = 1, $iOffset, $iLimit)
     {
         $this->cache->start(self::CACHE_GROUP, 'video' . $iProfileId . $iAlbumId . $iVideoId . $iApproved . $iOffset . $iLimit, static::CACHE_TIME);
@@ -134,6 +154,9 @@ 
         return $iData;
     }
 
+    /**
+     * @param integer $iAlbumId
+     */
     public function updateAlbum($iProfileId, $iAlbumId, $sTitle, $sDescription, $sUpdatedDate)
     {
         $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('AlbumsVideos') . 'SET name =:name, description =:description, updatedDate =:updatedDate
@@ -147,6 +170,12 @@ 
         return $rStmt->execute();
     }
 
+    /**
+     * @param string $iProfileId
+     * @param integer $iAlbumId
+     * @param integer $iVideoId
+     * @param string $sUpdatedDate
+     */
     public function updateVideo($iProfileId, $iAlbumId, $iVideoId, $sTitle, $sDescription, $sUpdatedDate)
     {
         $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('Videos') . 'SET title =:title, description =:description, updatedDate =:updatedDate

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