Completed
Pull Request — master (#396)
by Alexander
10:58
created
lib/private/Comments/Manager.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -205,7 +205,7 @@
 block discarded – undo
205 205
 	/**
206 206
 	 * removes an entry from the comments run time cache
207 207
 	 *
208
-	 * @param mixed $id the comment's id
208
+	 * @param string $id the comment's id
209 209
 	 */
210 210
 	protected function uncache($id) {
211 211
 		$id = strval($id);
Please login to merge, or discard this patch.
lib/private/DateTimeFormatter.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -93,7 +93,7 @@  discard block
 block discarded – undo
93 93
 	/**
94 94
 	 * Formats the date of the given timestamp
95 95
 	 *
96
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
96
+	 * @param integer	$timestamp	Either a Unix timestamp or DateTime object
97 97
 	 * @param string	$format			Either 'full', 'long', 'medium' or 'short'
98 98
 	 * 				full:	e.g. 'EEEE, MMMM d, y'	=> 'Wednesday, August 20, 2014'
99 99
 	 * 				long:	e.g. 'MMMM d, y'		=> 'August 20, 2014'
@@ -192,7 +192,7 @@  discard block
 block discarded – undo
192 192
 	/**
193 193
 	 * Gives the relative past time of the timestamp
194 194
 	 *
195
-	 * @param int|\DateTime	$timestamp	Either a Unix timestamp or DateTime object
195
+	 * @param integer	$timestamp	Either a Unix timestamp or DateTime object
196 196
 	 * @param int|\DateTime	$baseTimestamp	Timestamp to compare $timestamp against, defaults to current time
197 197
 	 * @return string	Dates returned are:
198 198
 	 * 				< 60 sec	=> seconds ago
@@ -228,7 +228,7 @@  discard block
 block discarded – undo
228 228
 	/**
229 229
 	 * Formats the date and time of the given timestamp
230 230
 	 *
231
-	 * @param int|\DateTime $timestamp	Either a Unix timestamp or DateTime object
231
+	 * @param integer $timestamp	Either a Unix timestamp or DateTime object
232 232
 	 * @param string		$formatDate		See formatDate() for description
233 233
 	 * @param string		$formatTime		See formatTime() for description
234 234
 	 * @param \DateTimeZone	$timeZone	The timezone to use
Please login to merge, or discard this patch.
lib/private/DB/Connection.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -173,7 +173,7 @@  discard block
 block discarded – undo
173 173
 	 * If an SQLLogger is configured, the execution is logged.
174 174
 	 *
175 175
 	 * @param string                                      $query  The SQL query to execute.
176
-	 * @param array                                       $params The parameters to bind to the query, if any.
176
+	 * @param string[]                                       $params The parameters to bind to the query, if any.
177 177
 	 * @param array                                       $types  The types the previous parameters are in.
178 178
 	 * @param \Doctrine\DBAL\Cache\QueryCacheProfile|null $qcp    The query cache profile, optional.
179 179
 	 *
@@ -218,7 +218,7 @@  discard block
 block discarded – undo
218 218
 	 * columns or sequences.
219 219
 	 *
220 220
 	 * @param string $seqName Name of the sequence object from which the ID should be returned.
221
-	 * @return string A string representation of the last inserted ID.
221
+	 * @return integer A string representation of the last inserted ID.
222 222
 	 */
223 223
 	public function lastInsertId($seqName = null) {
224 224
 		if ($seqName) {
Please login to merge, or discard this patch.
lib/private/DB/QueryBuilder/QueryBuilder.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -306,7 +306,7 @@  discard block
 block discarded – undo
306 306
 	 *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
307 307
 	 * </code>
308 308
 	 *
309
-	 * @param mixed $select The selection expressions.
309
+	 * @param string $select The selection expressions.
310 310
 	 *
311 311
 	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
312 312
 	 */
@@ -330,7 +330,7 @@  discard block
 block discarded – undo
330 330
 	 *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
331 331
 	 * </code>
332 332
 	 *
333
-	 * @param mixed $select The selection expressions.
333
+	 * @param QueryFunction $select The selection expressions.
334 334
 	 * @param string $alias The column alias used in the constructed query.
335 335
 	 *
336 336
 	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
@@ -652,7 +652,7 @@  discard block
 block discarded – undo
652 652
 	 *         ->where($or);
653 653
 	 * </code>
654 654
 	 *
655
-	 * @param mixed $predicates The restriction predicates.
655
+	 * @param CompositeExpression $predicates The restriction predicates.
656 656
 	 *
657 657
 	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
658 658
 	 */
@@ -1034,7 +1034,7 @@  discard block
 block discarded – undo
1034 1034
 	 *
1035 1035
 	 * @param string $name
1036 1036
 	 *
1037
-	 * @return IParameter
1037
+	 * @return string
1038 1038
 	 */
1039 1039
 	public function createParameter($name) {
1040 1040
 		return new Parameter(':' . $name);
Please login to merge, or discard this patch.
lib/private/Encryption/Util.php 1 patch
Unused Use Statements   -1 removed lines patch added patch discarded remove patch
@@ -30,7 +30,6 @@
 block discarded – undo
30 30
 use OC\Files\Filesystem;
31 31
 use OC\Files\View;
32 32
 use OCP\Encryption\IEncryptionModule;
33
-use OCP\Files\Storage;
34 33
 use OCP\IConfig;
35 34
 
36 35
 class Util {
Please login to merge, or discard this patch.
lib/private/Files/Cache/Scanner.php 1 patch
Doc Comments   +11 added lines patch added patch discarded remove patch
@@ -386,6 +386,14 @@  discard block
 block discarded – undo
386 386
 		return $size;
387 387
 	}
388 388
 
389
+	/**
390
+	 * @param string $path
391
+	 * @param boolean $recursive
392
+	 * @param integer $reuse
393
+	 * @param integer|null $folderId
394
+	 * @param boolean $lock
395
+	 * @param integer $size
396
+	 */
389 397
 	private function handleChildren($path, $recursive, $reuse, $folderId, $lock, &$size) {
390 398
 		// we put this in it's own function so it cleans up the memory before we start recursing
391 399
 		$existingChildren = $this->getExistingChildren($folderId);
@@ -485,6 +493,9 @@  discard block
 block discarded – undo
485 493
 		}
486 494
 	}
487 495
 
496
+	/**
497
+	 * @param string|boolean $path
498
+	 */
488 499
 	private function runBackgroundScanJob(callable $callback, $path) {
489 500
 		try {
490 501
 			$callback();
Please login to merge, or discard this patch.
lib/private/Files/Cache/Wrapper/CacheJail.php 1 patch
Doc Comments   +5 added lines, -2 removed lines patch added patch discarded remove patch
@@ -70,7 +70,7 @@  discard block
 block discarded – undo
70 70
 
71 71
 	/**
72 72
 	 * @param array $entry
73
-	 * @return array
73
+	 * @return string
74 74
 	 */
75 75
 	protected function formatCacheEntry($entry) {
76 76
 		if (isset($entry['path'])) {
@@ -189,6 +189,9 @@  discard block
 block discarded – undo
189 189
 		return $this->cache->getStatus($this->getSourcePath($file));
190 190
 	}
191 191
 
192
+	/**
193
+	 * @param \OCP\Files\Cache\ICacheEntry[] $results
194
+	 */
192 195
 	private function formatSearchResults($results) {
193 196
 		$results = array_filter($results, array($this, 'filterCacheEntry'));
194 197
 		$results = array_values($results);
@@ -274,7 +277,7 @@  discard block
 block discarded – undo
274 277
 	 * use the one with the highest id gives the best result with the background scanner, since that is most
275 278
 	 * likely the folder where we stopped scanning previously
276 279
 	 *
277
-	 * @return string|bool the path of the folder or false when no folder matched
280
+	 * @return boolean the path of the folder or false when no folder matched
278 281
 	 */
279 282
 	public function getIncomplete() {
280 283
 		// not supported
Please login to merge, or discard this patch.
lib/private/Files/Config/UserMountCache.php 2 patches
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -206,7 +206,7 @@
 block discarded – undo
206 206
 	}
207 207
 
208 208
 	/**
209
-	 * @param $fileId
209
+	 * @param integer $fileId
210 210
 	 * @return array
211 211
 	 * @throws \OCP\Files\NotFoundException
212 212
 	 */
Please login to merge, or discard this patch.
Unused Use Statements   -2 removed lines patch added patch discarded remove patch
@@ -22,8 +22,6 @@
 block discarded – undo
22 22
 
23 23
 namespace OC\Files\Config;
24 24
 
25
-use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
26
-use OC\Files\Filesystem;
27 25
 use OCA\Files_Sharing\SharedMount;
28 26
 use OCP\DB\QueryBuilder\IQueryBuilder;
29 27
 use OCP\Files\Config\ICachedMountInfo;
Please login to merge, or discard this patch.
lib/private/Files/Filesystem.php 2 patches
Unused Use Statements   -1 removed lines patch added patch discarded remove patch
@@ -62,7 +62,6 @@
 block discarded – undo
62 62
 use OC\Files\Mount\MountPoint;
63 63
 use OC\Files\Storage\StorageFactory;
64 64
 use OCP\Files\Config\IMountProvider;
65
-use OCP\Files\Mount\IMountPoint;
66 65
 use OCP\Files\NotFoundException;
67 66
 use OCP\IUserManager;
68 67
 
Please login to merge, or discard this patch.
Doc Comments   +28 added lines, -2 removed lines patch added patch discarded remove patch
@@ -338,6 +338,9 @@  discard block
 block discarded – undo
338 338
 		}
339 339
 	}
340 340
 
341
+	/**
342
+	 * @param string $root
343
+	 */
341 344
 	static public function init($user, $root) {
342 345
 		if (self::$defaultInstance) {
343 346
 			return false;
@@ -521,7 +524,7 @@  discard block
 block discarded – undo
521 524
 	/**
522 525
 	 * mount an \OC\Files\Storage\Storage in our virtual filesystem
523 526
 	 *
524
-	 * @param \OC\Files\Storage\Storage|string $class
527
+	 * @param string $class
525 528
 	 * @param array $arguments
526 529
 	 * @param string $mountpoint
527 530
 	 */
@@ -653,6 +656,9 @@  discard block
 block discarded – undo
653 656
 		return self::$defaultInstance->is_dir($path);
654 657
 	}
655 658
 
659
+	/**
660
+	 * @param string $path
661
+	 */
656 662
 	static public function is_file($path) {
657 663
 		return self::$defaultInstance->is_file($path);
658 664
 	}
@@ -665,6 +671,9 @@  discard block
 block discarded – undo
665 671
 		return self::$defaultInstance->filetype($path);
666 672
 	}
667 673
 
674
+	/**
675
+	 * @param string $path
676
+	 */
668 677
 	static public function filesize($path) {
669 678
 		return self::$defaultInstance->filesize($path);
670 679
 	}
@@ -677,6 +686,9 @@  discard block
 block discarded – undo
677 686
 		return self::$defaultInstance->isCreatable($path);
678 687
 	}
679 688
 
689
+	/**
690
+	 * @param string $path
691
+	 */
680 692
 	static public function isReadable($path) {
681 693
 		return self::$defaultInstance->isReadable($path);
682 694
 	}
@@ -689,6 +701,9 @@  discard block
 block discarded – undo
689 701
 		return self::$defaultInstance->isDeletable($path);
690 702
 	}
691 703
 
704
+	/**
705
+	 * @param string $path
706
+	 */
692 707
 	static public function isSharable($path) {
693 708
 		return self::$defaultInstance->isSharable($path);
694 709
 	}
@@ -706,6 +721,7 @@  discard block
 block discarded – undo
706 721
 	}
707 722
 
708 723
 	/**
724
+	 * @param string $path
709 725
 	 * @return string
710 726
 	 */
711 727
 	static public function file_get_contents($path) {
@@ -728,6 +744,10 @@  discard block
 block discarded – undo
728 744
 		return self::$defaultInstance->copy($path1, $path2);
729 745
 	}
730 746
 
747
+	/**
748
+	 * @param string $path
749
+	 * @param string $mode
750
+	 */
731 751
 	static public function fopen($path, $mode) {
732 752
 		return self::$defaultInstance->fopen($path, $mode);
733 753
 	}
@@ -743,6 +763,9 @@  discard block
 block discarded – undo
743 763
 		return self::$defaultInstance->fromTmpFile($tmpFile, $path);
744 764
 	}
745 765
 
766
+	/**
767
+	 * @param string $path
768
+	 */
746 769
 	static public function getMimeType($path) {
747 770
 		return self::$defaultInstance->getMimeType($path);
748 771
 	}
@@ -755,6 +778,9 @@  discard block
 block discarded – undo
755 778
 		return self::$defaultInstance->free_space($path);
756 779
 	}
757 780
 
781
+	/**
782
+	 * @param string $query
783
+	 */
758 784
 	static public function search($query) {
759 785
 		return self::$defaultInstance->search($query);
760 786
 	}
@@ -868,7 +894,7 @@  discard block
 block discarded – undo
868 894
 	 * @param string $path
869 895
 	 * @param boolean $includeMountPoints whether to add mountpoint sizes,
870 896
 	 * defaults to true
871
-	 * @return \OC\Files\FileInfo|bool False if file does not exist
897
+	 * @return \OCP\Files\FileInfo|null False if file does not exist
872 898
 	 */
873 899
 	public static function getFileInfo($path, $includeMountPoints = true) {
874 900
 		return self::$defaultInstance->getFileInfo($path, $includeMountPoints);
Please login to merge, or discard this patch.