@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | * |
| 65 | 65 | * 以下のものは非対応 |
| 66 | 66 | * BITMAPV4HEADER と BITMAPV5HEADER に含まれる色空間に関する様々な機能 |
| 67 | - * @param $filename_or_stream_or_binary |
|
| 67 | + * @param string $filename_or_stream_or_binary |
|
| 68 | 68 | * @return bool|resource |
| 69 | 69 | */ |
| 70 | 70 | |
@@ -96,6 +96,9 @@ discard block |
||
| 96 | 96 | return $bmp; |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | + /** |
|
| 100 | + * @param string $str |
|
| 101 | + */ |
|
| 99 | 102 | public static function loadFromString($str){ |
| 100 | 103 | //data scheme より古いバージョンから対応しているようなので php://memory を使う |
| 101 | 104 | $fp = fopen("php://memory", "r+b"); |
@@ -119,6 +122,9 @@ discard block |
||
| 119 | 122 | return $bmp; |
| 120 | 123 | } |
| 121 | 124 | |
| 125 | + /** |
|
| 126 | + * @param resource $stream |
|
| 127 | + */ |
|
| 122 | 128 | public static function loadFromStream($stream){ |
| 123 | 129 | $buf = fread($stream, 14); //2+4+2+2+4 |
| 124 | 130 | if ($buf === false){ |
@@ -67,6 +67,9 @@ discard block |
||
| 67 | 67 | \PFBC\Form::setSuccess('form_add_fake_profiles', nt('%n% user has successfully been added.', '%n% users have successfully been added.', $this->getUserNumber())); |
| 68 | 68 | } |
| 69 | 69 | |
| 70 | + /** |
|
| 71 | + * @return integer |
|
| 72 | + */ |
|
| 70 | 73 | protected function getUserNumber() |
| 71 | 74 | { |
| 72 | 75 | return $this->httpRequest->post('num'); |
@@ -98,7 +101,7 @@ discard block |
||
| 98 | 101 | * @param string $sApiParms Parameters to send to the API. |
| 99 | 102 | * @param string $sApiVersion Version of the API it will use. If fails from the API server, it will ignore it. |
| 100 | 103 | * |
| 101 | - * @return void |
|
| 104 | + * @return string |
|
| 102 | 105 | */ |
| 103 | 106 | private function getApiResults($sApiUrl, $sApiParms, $sApiVersion) |
| 104 | 107 | { |
@@ -11,6 +11,11 @@ discard block |
||
| 11 | 11 | class ForumModel extends ForumCoreModel |
| 12 | 12 | { |
| 13 | 13 | |
| 14 | + /** |
|
| 15 | + * @param string $iCategoryId |
|
| 16 | + * @param integer $iOffset |
|
| 17 | + * @param integer $iLimit |
|
| 18 | + */ |
|
| 14 | 19 | public function getCategory($iCategoryId = null, $iOffset = null, $iLimit = null) |
| 15 | 20 | { |
| 16 | 21 | $bIsLimit = isset($iOffset, $iLimit); |
@@ -30,6 +35,14 @@ discard block |
||
| 30 | 35 | return (!empty($iCategoryId)) ? $rStmt->fetch(\PDO::FETCH_OBJ) : $rStmt->fetchAll(\PDO::FETCH_OBJ); |
| 31 | 36 | } |
| 32 | 37 | |
| 38 | + /** |
|
| 39 | + * @param string $sForumName |
|
| 40 | + * @param null|string $sTopicSubject |
|
| 41 | + * @param null|string $iProfileId |
|
| 42 | + * @param integer $iApproved |
|
| 43 | + * @param integer $iOffset |
|
| 44 | + * @param integer $iLimit |
|
| 45 | + */ |
|
| 33 | 46 | public function getTopic($sForumName, $iForumId, $sTopicSubject, $iTopicId, $iProfileId, $iApproved, $iOffset, $iLimit) |
| 34 | 47 | { |
| 35 | 48 | $iOffset = (int) $iOffset; |
@@ -67,6 +80,9 @@ discard block |
||
| 67 | 80 | return $rStmt->execute(); |
| 68 | 81 | } |
| 69 | 82 | |
| 83 | + /** |
|
| 84 | + * @param string $sCreatedDate |
|
| 85 | + */ |
|
| 70 | 86 | public function addForum($iCategoryId, $sTitle, $sDescription, $sCreatedDate) |
| 71 | 87 | { |
| 72 | 88 | $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('Forums') . '(categoryId, name, description, createdDate) |
@@ -79,6 +95,10 @@ discard block |
||
| 79 | 95 | return $rStmt->execute(); |
| 80 | 96 | } |
| 81 | 97 | |
| 98 | + /** |
|
| 99 | + * @param integer $iProfileId |
|
| 100 | + * @param string $sCreatedDate |
|
| 101 | + */ |
|
| 82 | 102 | public function addTopic($iProfileId, $iForumId, $sTitle, $sMessage, $sCreatedDate) |
| 83 | 103 | { |
| 84 | 104 | $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('ForumsTopics') . '(profileId, forumId, title, message, createdDate) |
@@ -92,6 +112,10 @@ discard block |
||
| 92 | 112 | return $rStmt->execute(); |
| 93 | 113 | } |
| 94 | 114 | |
| 115 | + /** |
|
| 116 | + * @param integer $iProfileId |
|
| 117 | + * @param string $sCreatedDate |
|
| 118 | + */ |
|
| 95 | 119 | public function addMessage($iProfileId, $iTopicId, $sMessage, $sCreatedDate) |
| 96 | 120 | { |
| 97 | 121 | $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('ForumsMessages') . '(profileId, topicId, message, createdDate) |
@@ -114,6 +138,9 @@ discard block |
||
| 114 | 138 | return $rStmt->execute(); |
| 115 | 139 | } |
| 116 | 140 | |
| 141 | + /** |
|
| 142 | + * @param string $sUpdatedDate |
|
| 143 | + */ |
|
| 117 | 144 | public function updateForum($iForumId, $iCategoryId, $sName, $sDescription, $sUpdatedDate) |
| 118 | 145 | { |
| 119 | 146 | $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('Forums') . |
@@ -127,6 +154,10 @@ discard block |
||
| 127 | 154 | return $rStmt->execute(); |
| 128 | 155 | } |
| 129 | 156 | |
| 157 | + /** |
|
| 158 | + * @param string $iProfileId |
|
| 159 | + * @param string $sUpdatedDate |
|
| 160 | + */ |
|
| 130 | 161 | public function updateTopic($iProfileId, $iTopicId, $sTitle, $sMessage, $sUpdatedDate) |
| 131 | 162 | { |
| 132 | 163 | $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('ForumsTopics') . |
@@ -140,6 +171,10 @@ discard block |
||
| 140 | 171 | return $rStmt->execute(); |
| 141 | 172 | } |
| 142 | 173 | |
| 174 | + /** |
|
| 175 | + * @param string $iProfileId |
|
| 176 | + * @param string $sUpdatedDate |
|
| 177 | + */ |
|
| 143 | 178 | public function updateMessage($iProfileId, $iMessageId, $sMessage, $sUpdatedDate) |
| 144 | 179 | { |
| 145 | 180 | $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('ForumsMessages') . |
@@ -282,6 +317,11 @@ discard block |
||
| 282 | 317 | return $mData; |
| 283 | 318 | } |
| 284 | 319 | |
| 320 | + /** |
|
| 321 | + * @param integer $iApproved |
|
| 322 | + * @param integer $iOffset |
|
| 323 | + * @param integer $iLimit |
|
| 324 | + */ |
|
| 285 | 325 | public function getPostByProfile($iProfileId, $iApproved, $iOffset, $iLimit) |
| 286 | 326 | { |
| 287 | 327 | $iOffset = (int) $iOffset; |
@@ -19,6 +19,9 @@ |
||
| 19 | 19 | |
| 20 | 20 | private $oUserModel; |
| 21 | 21 | |
| 22 | + /** |
|
| 23 | + * @param string $sTable |
|
| 24 | + */ |
|
| 22 | 25 | public function __construct($sTable) |
| 23 | 26 | { |
| 24 | 27 | parent::__construct(); |
@@ -12,6 +12,11 @@ discard block |
||
| 12 | 12 | class PictureModel extends PictureCoreModel |
| 13 | 13 | { |
| 14 | 14 | |
| 15 | + /** |
|
| 16 | + * @param string $iProfileId |
|
| 17 | + * @param string $sThumb |
|
| 18 | + * @param string $sCreatedDate |
|
| 19 | + */ |
|
| 15 | 20 | public function addAlbum($iProfileId, $sTitle, $sDescription, $sThumb, $sCreatedDate, $iApproved = 1) |
| 16 | 21 | { |
| 17 | 22 | $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('AlbumsPictures') . '(profileId, name, description, thumb, createdDate, approved) |
@@ -26,6 +31,12 @@ discard block |
||
| 26 | 31 | return $rStmt->execute(); |
| 27 | 32 | } |
| 28 | 33 | |
| 34 | + /** |
|
| 35 | + * @param string $iProfileId |
|
| 36 | + * @param integer $iAlbumId |
|
| 37 | + * @param string $sFile |
|
| 38 | + * @param string $sCreatedDate |
|
| 39 | + */ |
|
| 29 | 40 | public function addPhoto($iProfileId, $iAlbumId, $sTitle, $sDescription, $sFile, $sCreatedDate, $iApproved = 1) |
| 30 | 41 | { |
| 31 | 42 | $rStmt = Db::getInstance()->prepare('INSERT INTO' . Db::prefix('Pictures') . '(profileId, albumId, title, description, file, createdDate, approved) |
@@ -49,6 +60,9 @@ discard block |
||
| 49 | 60 | return $rStmt->execute(); |
| 50 | 61 | } |
| 51 | 62 | |
| 63 | + /** |
|
| 64 | + * @param string $iProfileId |
|
| 65 | + */ |
|
| 52 | 66 | public function getAlbumsName($iProfileId) |
| 53 | 67 | { |
| 54 | 68 | $this->cache->start(self::CACHE_GROUP, 'albumName' . $iProfileId, static::CACHE_TIME); |
@@ -66,6 +80,13 @@ discard block |
||
| 66 | 80 | return $oData; |
| 67 | 81 | } |
| 68 | 82 | |
| 83 | + /** |
|
| 84 | + * @param string $iProfileId |
|
| 85 | + * @param string $iAlbumId |
|
| 86 | + * @param string $iPictureId |
|
| 87 | + * @param integer $iOffset |
|
| 88 | + * @param integer $iLimit |
|
| 89 | + */ |
|
| 69 | 90 | public function photo($iProfileId, $iAlbumId, $iPictureId = null, $iApproved = 1, $iOffset, $iLimit) |
| 70 | 91 | { |
| 71 | 92 | $this->cache->start(self::CACHE_GROUP, 'photo' . $iProfileId . $iAlbumId . $iPictureId . $iApproved . $iOffset . $iLimit, static::CACHE_TIME); |
@@ -132,6 +153,11 @@ discard block |
||
| 132 | 153 | return $iData; |
| 133 | 154 | } |
| 134 | 155 | |
| 156 | + /** |
|
| 157 | + * @param string $iProfileId |
|
| 158 | + * @param integer $iAlbumId |
|
| 159 | + * @param string $sUpdatedDate |
|
| 160 | + */ |
|
| 135 | 161 | public function updateAlbum($iProfileId, $iAlbumId, $sTitle, $sDescription, $sUpdatedDate) |
| 136 | 162 | { |
| 137 | 163 | $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('AlbumsPictures') . |
@@ -145,6 +171,12 @@ discard block |
||
| 145 | 171 | return $rStmt->execute(); |
| 146 | 172 | } |
| 147 | 173 | |
| 174 | + /** |
|
| 175 | + * @param string $iProfileId |
|
| 176 | + * @param integer $iAlbumId |
|
| 177 | + * @param integer $iPictureId |
|
| 178 | + * @param string $sUpdatedDate |
|
| 179 | + */ |
|
| 148 | 180 | public function updatePhoto($iProfileId, $iAlbumId, $iPictureId, $sTitle, $sDescription, $sUpdatedDate) |
| 149 | 181 | { |
| 150 | 182 | $rStmt = Db::getInstance()->prepare('UPDATE' . Db::prefix('Pictures') . |
@@ -12,6 +12,9 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
@@ -217,7 +217,7 @@ discard block |
||
| 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 |
||
| 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 | { |
@@ -283,6 +283,10 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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; |
@@ -78,6 +78,9 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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) { |