Completed
Branch master (57084d)
by Pierre-Henry
35:51
created
_protected/app/system/modules/video/models/VideoModel.php 1 patch
Doc Comments   +29 added lines patch added patch discarded remove patch
@@ -12,6 +12,9 @@  discard block
 block discarded – undo
12 12
 class VideoModel extends VideoCoreModel
13 13
 {
14 14
 
15
+    /**
16
+     * @param string $sThumb
17
+     */
15 18
     public function addAlbum($iProfileId, $sTitle, $sDescription, $sThumb, $sCreatedDate, $iApproved = 1)
16 19
     {
17 20
         $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('AlbumsVideos') . '(profileId, name, description, thumb, createdDate, approved)
@@ -26,6 +29,13 @@  discard block
 block discarded – undo
26 29
         return $rStmt->execute();
27 30
     }
28 31
 
32
+    /**
33
+     * @param string $iProfileId
34
+     * @param integer $iAlbumId
35
+     * @param string $sFile
36
+     * @param string $sThumb
37
+     * @param string $sCreatedDate
38
+     */
29 39
     public function addVideo($iProfileId, $iAlbumId, $sTitle, $sDescription, $sFile, $sThumb, $sDuration, $sCreatedDate, $iApproved = 1)
30 40
     {
31 41
         $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('Videos') . '(profileId, albumId, title, description, file, thumb, duration, createdDate, approved)
@@ -51,6 +61,9 @@  discard block
 block discarded – undo
51 61
         return $rStmt->execute();
52 62
     }
53 63
 
64
+    /**
65
+     * @param string $iProfileId
66
+     */
54 67
     public function getAlbumsName($iProfileId)
55 68
     {
56 69
         $this->cache->start(self::CACHE_GROUP, 'albumName' . $iProfileId, static::CACHE_TIME);
@@ -68,6 +81,13 @@  discard block
 block discarded – undo
68 81
         return $oData;
69 82
     }
70 83
 
84
+    /**
85
+     * @param string $iProfileId
86
+     * @param string $iAlbumId
87
+     * @param string $iVideoId
88
+     * @param integer $iOffset
89
+     * @param integer $iLimit
90
+     */
71 91
     public function video($iProfileId, $iAlbumId, $iVideoId = null, $iApproved = 1, $iOffset, $iLimit)
72 92
     {
73 93
         $this->cache->start(self::CACHE_GROUP, 'video' . $iProfileId . $iAlbumId . $iVideoId . $iApproved . $iOffset . $iLimit, static::CACHE_TIME);
@@ -134,6 +154,9 @@  discard block
 block discarded – undo
134 154
         return $iData;
135 155
     }
136 156
 
157
+    /**
158
+     * @param integer $iAlbumId
159
+     */
137 160
     public function updateAlbum($iProfileId, $iAlbumId, $sTitle, $sDescription, $sUpdatedDate)
138 161
     {
139 162
         $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('AlbumsVideos') . 'SET name =:name, description =:description, updatedDate =:updatedDate
@@ -147,6 +170,12 @@  discard block
 block discarded – undo
147 170
         return $rStmt->execute();
148 171
     }
149 172
 
173
+    /**
174
+     * @param string $iProfileId
175
+     * @param integer $iAlbumId
176
+     * @param integer $iVideoId
177
+     * @param string $sUpdatedDate
178
+     */
150 179
     public function updateVideo($iProfileId, $iAlbumId, $iVideoId, $sTitle, $sDescription, $sUpdatedDate)
151 180
     {
152 181
         $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('Videos') . 'SET title =:title, description =:description, updatedDate =:updatedDate
Please login to merge, or discard this patch.
_protected/framework/Cache/Cache.class.php 2 patches
Doc Comments   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -44,7 +44,7 @@  discard block
 block discarded – undo
44 44
      * Enabled/Disabled the cache.
45 45
      *
46 46
      * @param boolean $bIsEnable
47
-     * @return object this
47
+     * @return Cache this
48 48
      */
49 49
     public function enabled($bIsEnable)
50 50
     {
@@ -59,7 +59,7 @@  discard block
 block discarded – undo
59 59
      * If you do not use this method, a default directory will be created.
60 60
      *
61 61
      * @param string $sCacheDir
62
-     * @return object this
62
+     * @return Cache this
63 63
      * @throws \PH7\Framework\Error\CException\PH7InvalidArgumentException An explanatory message if the directory does not exist.
64 64
      */
65 65
     public function setCacheDir($sCacheDir)
@@ -76,7 +76,7 @@  discard block
 block discarded – undo
76 76
      * Sets the cache prefix.
77 77
      *
78 78
      * @param string $sPrefix
79
-     * @return object this
79
+     * @return Cache this
80 80
      */
81 81
     public function setPrefix($sPrefix)
82 82
     {
@@ -88,7 +88,7 @@  discard block
 block discarded – undo
88 88
      * Sets the time expire cache.
89 89
      *
90 90
      * @param integer $iExpire (the time with the 'touch' function).
91
-     * @return object this
91
+     * @return Cache this
92 92
      */
93 93
     public function setExpire($iExpire)
94 94
     {
@@ -104,7 +104,7 @@  discard block
 block discarded – undo
104 104
      * @param string $sGroup The Group Cache (This creates a folder).
105 105
      * @param string $sId (The ID for the file).
106 106
      * @param integer $iTtl Cache lifetime in seconds. If NULL, the file never expires.
107
-     * @return object this
107
+     * @return Cache this
108 108
      */
109 109
     public function start($sGroup, $sId, $iTtl)
110 110
     {
@@ -162,7 +162,7 @@  discard block
 block discarded – undo
162 162
      * Puts the data in the cache.
163 163
      *
164 164
      * @param string $sData
165
-     * @return string (object | null) If the cache is disabled, returns null otherwise returns a this object.
165
+     * @return null|Cache (object | null) If the cache is disabled, returns null otherwise returns a this object.
166 166
      */
167 167
     public function put($sData)
168 168
     {
@@ -176,7 +176,7 @@  discard block
 block discarded – undo
176 176
     /**
177 177
      * Clear the cache.
178 178
      *
179
-     * @return object this
179
+     * @return Cache this
180 180
      */
181 181
     public function clear()
182 182
     {
@@ -263,7 +263,7 @@  discard block
 block discarded – undo
263 263
      *
264 264
      * @access private
265 265
      * @param boolean $bPrint
266
-     * @return mixed (boolean | string) Returns TRUE or a string if successful, FALSE otherwise.
266
+     * @return string (boolean | string) Returns TRUE or a string if successful, FALSE otherwise.
267 267
      */
268 268
     private function _read($bPrint)
269 269
     {
@@ -324,7 +324,7 @@  discard block
 block discarded – undo
324 324
      *
325 325
      * If the folder cache does not exist, it creates a folder.
326 326
      * @access private
327
-     * @return object this
327
+     * @return Cache this
328 328
      */
329 329
     private function _checkCacheDir()
330 330
     {
Please login to merge, or discard this patch.
Unused Use Statements   +3 added lines, -4 removed lines patch added patch discarded remove patch
@@ -13,10 +13,9 @@
 block discarded – undo
13 13
 namespace PH7\Framework\Cache;
14 14
 defined('PH7') or exit('Restricted access');
15 15
 
16
-use
17
-PH7\Framework\Core\Kernel,
18
-PH7\Framework\Config\Config,
19
-PH7\Framework\File\File;
16
+use PH7\Framework\Core\Kernel;
17
+use PH7\Framework\Config\Config;
18
+use PH7\Framework\File\File;
20 19
 
21 20
 class Cache
22 21
 {
Please login to merge, or discard this patch.
_protected/framework/Geo/Map/Api.class.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -217,7 +217,7 @@  discard block
 block discarded – undo
217 217
     }
218 218
 
219 219
     /**
220
-     * @return mixed
220
+     * @return boolean
221 221
      */
222 222
     public function getEnableGeolocation()
223 223
     {
@@ -445,7 +445,7 @@  discard block
 block discarded – undo
445 445
      *
446 446
      * @param string $address an address
447 447
      *
448
-     * @return array array with precision, lat & lng
448
+     * @return string array with precision, lat & lng
449 449
      */
450 450
     public function geocoding($address)
451 451
     {
Please login to merge, or discard this patch.
_protected/framework/Http/Http.class.php 1 patch
Doc Comments   +3 added lines, -2 removed lines patch added patch discarded remove patch
@@ -91,7 +91,7 @@  discard block
 block discarded – undo
91 91
     /**
92 92
      * @static
93 93
      * @param integer $iStatus The "code" for the HTTP status
94
-     * @return mixed (string | boolean) $iStatus Returns the "HTTP status code" if found otherwise returns "false"
94
+     * @return integer (string | boolean) $iStatus Returns the "HTTP status code" if found otherwise returns "false"
95 95
      */
96 96
     public static function getStatusCodes($iStatus)
97 97
     {
@@ -129,6 +129,7 @@  discard block
 block discarded – undo
129 129
      *
130 130
      * @static
131 131
      * @param mixed (string | array) $mHeaders Headers to send.
132
+     * @param string $mHeaders
132 133
      * @throws \PH7\Framework\Http\Exception
133 134
      */
134 135
     public static function setHeaders($mHeaders)
@@ -188,7 +189,7 @@  discard block
 block discarded – undo
188 189
      * @static
189 190
      * @param string $sUsr
190 191
      * @param string $sPwd
191
-     * @return boolean TRUE if the authentication is correct, otherwise FALSE.
192
+     * @return null|boolean TRUE if the authentication is correct, otherwise FALSE.
192 193
      */
193 194
     public static function requireAuth($sUsr, $sPwd)
194 195
     {
Please login to merge, or discard this patch.
_protected/framework/Layout/Form/Engine/PFBC/Form.class.php 1 patch
Doc Comments   +15 added lines patch added patch discarded remove patch
@@ -283,6 +283,10 @@  discard block
 block discarded – undo
283 283
      }
284 284
 
285 285
     /*This method restores the serialized form instance.*/
286
+
287
+    /**
288
+     * @param string $id
289
+     */
286 290
     private static function recover($id)
287 291
     {
288 292
         if(!empty($_SESSION['pfbc'][$id]['form']))
@@ -483,6 +487,10 @@  discard block
 block discarded – undo
483 487
 
484 488
     /*Valldation errors are saved in the session after the form submission, and will be displayed to the user
485 489
     when redirected back to the form.*/
490
+
491
+    /**
492
+     * @param string $id
493
+     */
486 494
     public static function setError($id, $messages, $element = '')
487 495
     {
488 496
         if (!is_array($messages))
@@ -496,11 +504,18 @@  discard block
 block discarded – undo
496 504
     }
497 505
 
498 506
     /*setSuccess*/
507
+
508
+    /**
509
+     * @param string $id
510
+     */
499 511
     public static function setSuccess($id, $message, $element = '')
500 512
     {
501 513
          return (new Design)->setFlashMsg($message, Design::SUCCESS_TYPE);
502 514
     }
503 515
 
516
+    /**
517
+     * @param string $id
518
+     */
504 519
     public static function setSessionValue($id, $element, $value)
505 520
     {
506 521
         $_SESSION['pfbc'][$id]['values'][$element] = $value;
Please login to merge, or discard this patch.
_protected/framework/Math/Measure/Weight.class.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -35,7 +35,7 @@
 block discarded – undo
35 35
      * @see get()
36 36
      *
37 37
      * @param boolean $bPrint Default FALSE
38
-     * @return void
38
+     * @return null|string
39 39
      */
40 40
     public function display($bPrint = false)
41 41
     {
Please login to merge, or discard this patch.
_protected/framework/Mvc/Request/Http.class.php 2 patches
Doc Comments   +2 added lines patch added patch discarded remove patch
@@ -108,6 +108,7 @@  discard block
 block discarded – undo
108 108
      *
109 109
      * @param mixed (array or string) $mKey The key of the request or an array with the list of key of the variables request.
110 110
      * @param string $sParam Optional parameter, check the type of the request variable | Value type is: str, int, float, bool
111
+     * @param string $mKey
111 112
      * @return boolean
112 113
      */
113 114
     public function postExists($mKey, $sParam = null)
@@ -280,6 +281,7 @@  discard block
 block discarded – undo
280 281
     }
281 282
 
282 283
     /**
284
+     * @param string $sUrl
283 285
      * @return string The correct pH7's URL.
284 286
      */
285 287
     public function pH7Url($sUrl)
Please login to merge, or discard this patch.
Unused Use Statements   +2 added lines, -3 removed lines patch added patch discarded remove patch
@@ -15,9 +15,8 @@
 block discarded – undo
15 15
 namespace PH7\Framework\Mvc\Request;
16 16
 defined('PH7') or exit('Restricted access');
17 17
 
18
-use
19
-PH7\Framework\Registry\Registry,
20
-PH7\Framework\Security as Secty;
18
+use PH7\Framework\Registry\Registry;
19
+use PH7\Framework\Security as Secty;
21 20
 
22 21
 /**
23 22
  * Small example of using this class.
Please login to merge, or discard this patch.
_protected/framework/Str/Str.class.php 1 patch
Doc Comments   +7 added lines, -4 removed lines patch added patch discarded remove patch
@@ -77,7 +77,7 @@  discard block
 block discarded – undo
77 77
       * Count the length of a string and supports the special characters (Asian, Latin, ...).
78 78
       *
79 79
       * @param string $sText
80
-      * @return string
80
+      * @return integer
81 81
       */
82 82
      public function length($sText)
83 83
      {
@@ -115,8 +115,8 @@  discard block
 block discarded – undo
115 115
       * Test the equality of two strings.
116 116
       *
117 117
       * @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.
118
-      * @param string $text1
119
-      * @param string $text2
118
+      * @param string $sText1
119
+      * @param string $sText2
120 120
       * @return boolean
121 121
       */
122 122
      public function equals($sText1, $sText2)
@@ -298,7 +298,7 @@  discard block
 block discarded – undo
298 298
       * @access protected
299 299
       * @param string $sText
300 300
       * @param boolean $bStrip
301
-      * @return The text parsed with Str::stripTags() method if $bStrip parameter is TRUE, otherwise with Str::htmlSpecialChars method.
301
+      * @return string text parsed with Str::stripTags() method if $bStrip parameter is TRUE, otherwise with Str::htmlSpecialChars method.
302 302
       */
303 303
      protected function cEscape($sText, $bStrip)
304 304
      {
@@ -325,6 +325,9 @@  discard block
 block discarded – undo
325 325
          return htmlspecialchars($sText, ENT_QUOTES, 'utf-8');
326 326
      }
327 327
 
328
+     /**
329
+      * @param string $sPattern
330
+      */
328 331
      private static function _regexNormalize($sPattern)
329 332
      {
330 333
          return self::$_sRegexDelimiter . trim($sPattern, self::$_sRegexDelimiter) . self::$_sRegexDelimiter;
Please login to merge, or discard this patch.
_protected/framework/Translate/Adapter/Gettext/gettext.php 1 patch
Doc Comments   +10 added lines, -1 removed lines patch added patch discarded remove patch
@@ -78,6 +78,9 @@  discard block
 block discarded – undo
78 78
       }
79 79
     }
80 80
 
81
+  /**
82
+   * @param integer $bytes
83
+   */
81 84
   function read($bytes) {
82 85
     return $this->STREAM->read($bytes);
83 86
   }
@@ -86,6 +89,7 @@  discard block
 block discarded – undo
86 89
    * Reads an array of Integers from the Stream
87 90
    *
88 91
    * @param int count How many elements should be read
92
+   * @param integer $count
89 93
    * @return Array of Integers
90 94
    */
91 95
   function readintarray($count) {
@@ -103,6 +107,7 @@  discard block
 block discarded – undo
103 107
    *
104 108
    * @param object Reader the StreamReader object
105 109
    * @param boolean enable_cache Enable or disable caching of strings (default on)
110
+   * @param FileReader|null $Reader
106 111
    */
107 112
   public function __construct($Reader, $enable_cache = true) {
108 113
     // If there isn't a StreamReader, turn on short circuit mode.
@@ -177,6 +182,7 @@  discard block
 block discarded – undo
177 182
    *
178 183
    * @access private
179 184
    * @param int num Offset number of original string
185
+   * @param integer $num
180 186
    * @return string Requested string if found, otherwise ''
181 187
    */
182 188
   function get_original_string($num) {
@@ -194,6 +200,7 @@  discard block
 block discarded – undo
194 200
    *
195 201
    * @access private
196 202
    * @param int num Offset number of original string
203
+   * @param integer $num
197 204
    * @return string Requested string if found, otherwise ''
198 205
    */
199 206
   function get_translation_string($num) {
@@ -279,6 +286,7 @@  discard block
 block discarded – undo
279 286
    * Sanitize plural form expression for use in PHP eval call.
280 287
    *
281 288
    * @access private
289
+   * @param string $expr
282 290
    * @return string sanitized plural form expression
283 291
    */
284 292
   function sanitize_plural_expression($expr) {
@@ -380,7 +388,8 @@  discard block
 block discarded – undo
380 388
    * @param string single
381 389
    * @param string plural
382 390
    * @param string number
383
-   * @return translated plural form
391
+   * @param string $single
392
+   * @return string plural form
384 393
    */
385 394
   function ngettext($single, $plural, $number) {
386 395
     if ($this->short_circuit) {
Please login to merge, or discard this patch.