Completed
Pull Request — master (#6394)
by Ed
10:36
created
tests/php/View/SSViewerCacheBlockTest/VersionedModel.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -16,6 +16,9 @@
 block discarded – undo
16 16
 		Versioned::class
17 17
 	);
18 18
 
19
+	/**
20
+	 * @param string $entropy
21
+	 */
19 22
 	public function setEntropy($entropy)
20 23
 	{
21 24
 		$this->entropy = $entropy;
Please login to merge, or discard this patch.
tests/php/View/SSViewerTest.php 1 patch
Doc Comments   +13 added lines patch added patch discarded remove patch
@@ -156,6 +156,10 @@  discard block
 block discarded – undo
156 156
 		));
157 157
 	}
158 158
 
159
+	/**
160
+	 * @param \SilverStripe\ORM\FieldType\DBHTMLText $result
161
+	 * @param string[] $expected
162
+	 */
159 163
 	private function assertExpectedStrings($result, $expected) {
160 164
 		foreach ($expected as $expectedStr) {
161 165
 			$this->assertTrue(
@@ -820,6 +824,10 @@  discard block
 block discarded – undo
820 824
 		$this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult);
821 825
 	}
822 826
 
827
+	/**
828
+	 * @param string $a
829
+	 * @param string $b
830
+	 */
823 831
 	public function assertEqualIgnoringWhitespace($a, $b, $message = '') {
824 832
 		$this->assertEquals(preg_replace('/\s+/', '', $a), preg_replace('/\s+/', '', $b), $message);
825 833
 	}
@@ -1434,6 +1442,11 @@  discard block
 block discarded – undo
1434 1442
 			$this->_renderWithSourceFileComments('SSViewerTestComments/'.$template['name'], $template['expected']);
1435 1443
 		}
1436 1444
 	}
1445
+
1446
+	/**
1447
+	 * @param string $name
1448
+	 * @param string $expected
1449
+	 */
1437 1450
 	private function _renderWithSourceFileComments($name, $expected) {
1438 1451
 		$viewer = new SSViewer(array($name));
1439 1452
 		$data = new ArrayData(array());
Please login to merge, or discard this patch.
src/Assets/File.php 1 patch
Doc Comments   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -423,7 +423,7 @@  discard block
 block discarded – undo
423 423
      * Check if this file can be modified
424 424
      *
425 425
      * @param Member $member
426
-     * @return boolean
426
+     * @return boolean|string
427 427
      */
428 428
     public function canEdit($member = null)
429 429
     {
@@ -444,7 +444,7 @@  discard block
 block discarded – undo
444 444
      *
445 445
      * @param Member $member
446 446
      * @param array $context
447
-     * @return boolean
447
+     * @return boolean|string
448 448
      */
449 449
     public function canCreate($member = null, $context = array())
450 450
     {
@@ -464,7 +464,7 @@  discard block
 block discarded – undo
464 464
      * Check if this file can be deleted
465 465
      *
466 466
      * @param Member $member
467
-     * @return boolean
467
+     * @return boolean|string
468 468
      */
469 469
     public function canDelete($member = null)
470 470
     {
@@ -697,7 +697,7 @@  discard block
 block discarded – undo
697 697
      *
698 698
      * @param string $condition The PHP condition to be evaluated.  The page will be called $item
699 699
      * @param array $collator An array, passed by reference, to collect all of the matching descendants.
700
-     * @return true|null
700
+     * @return boolean|null
701 701
      */
702 702
     public function collateDescendants($condition, &$collator)
703 703
     {
@@ -1089,6 +1089,7 @@  discard block
 block discarded – undo
1089 1089
      *
1090 1090
      * @param String File extension, without dot prefix. Use an asterisk ('*')
1091 1091
      * to specify a generic fallback if no mapping is found for an extension.
1092
+     * @param string $ext
1092 1093
      * @return String Classname for a subclass of {@link File}
1093 1094
      */
1094 1095
     public static function get_class_for_file_extension($ext)
@@ -1248,7 +1249,6 @@  discard block
 block discarded – undo
1248 1249
      * Note that the result will not have a leading slash, and should not be used
1249 1250
      * with local file paths.
1250 1251
      *
1251
-     * @param string $part,... Parts
1252 1252
      * @return string
1253 1253
      */
1254 1254
     public static function join_paths($part = null)
Please login to merge, or discard this patch.
src/Assets/Flysystem/AssetAdapter.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -41,6 +41,9 @@
 block discarded – undo
41 41
         ]
42 42
     );
43 43
 
44
+    /**
45
+     * @param string $root
46
+     */
44 47
     public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS)
45 48
     {
46 49
         // Get root path
Please login to merge, or discard this patch.
src/Assets/Folder.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -62,7 +62,7 @@
 block discarded – undo
62 62
      * Find the given folder or create it as a database record
63 63
      *
64 64
      * @param string $folderPath Directory path relative to assets root
65
-     * @return Folder|null
65
+     * @return null|\SilverStripe\ORM\DataObject
66 66
      */
67 67
     public static function find_or_make($folderPath)
68 68
     {
Please login to merge, or discard this patch.
src/Assets/GDBackend.php 1 patch
Doc Comments   +3 added lines, -4 removed lines patch added patch discarded remove patch
@@ -198,7 +198,7 @@  discard block
 block discarded – undo
198 198
      * Check if this image has previously crashed GD when attempting to open it - if it's opened
199 199
      * successfully, the manipulation's cache key is removed.
200 200
      *
201
-     * @param string $arg,... Any number of args that identify this image
201
+     * @param string $arg
202 202
      * @return bool True if failed
203 203
      */
204 204
     public function failedResample($arg = null)
@@ -210,7 +210,7 @@  discard block
 block discarded – undo
210 210
     /**
211 211
      * Mark a file as failed
212 212
      *
213
-     * @param string $arg,... Any number of args that identify this image
213
+     * @param string $arg
214 214
      */
215 215
     protected function markFailed($arg = null)
216 216
     {
@@ -221,7 +221,6 @@  discard block
 block discarded – undo
221 221
     /**
222 222
      * Mark a file as succeeded
223 223
      *
224
-     * @param string $arg,... Any number of args that identify this image
225 224
      */
226 225
     protected function markSucceeded($arg = null)
227 226
     {
@@ -378,7 +377,7 @@  discard block
 block discarded – undo
378 377
      * using built-in function. Used when imagerotate function is not available(i.e. Ubuntu)
379 378
      *
380 379
      * @param float $angle Angle in degrees
381
-     * @return static
380
+     * @return null|resource
382 381
      */
383 382
     public function rotatePixelByPixel($angle)
384 383
     {
Please login to merge, or discard this patch.
src/Assets/ImageManipulation.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -804,7 +804,6 @@
 block discarded – undo
804 804
      * Name a variant based on a format with arbitrary parameters
805 805
      *
806 806
      * @param string $format The format name.
807
-     * @param mixed $arg,... Additional arguments
808 807
      * @return string
809 808
      * @throws InvalidArgumentException
810 809
      */
Please login to merge, or discard this patch.
src/Assets/Upload.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -128,7 +128,7 @@  discard block
 block discarded – undo
128 128
      * Set a different instance than {@link Upload_Validator}
129 129
      * for this upload session.
130 130
      *
131
-     * @param object $validator
131
+     * @param Upload_Validator $validator
132 132
      */
133 133
     public function setValidator($validator)
134 134
     {
@@ -393,7 +393,7 @@  discard block
 block discarded – undo
393 393
     /**
394 394
      * Determines wether previous operations caused an error.
395 395
      *
396
-     * @return boolean
396
+     * @return integer
397 397
      */
398 398
     public function isError()
399 399
     {
Please login to merge, or discard this patch.
src/Control/Controller.php 1 patch
Doc Comments   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -147,6 +147,7 @@  discard block
 block discarded – undo
147 147
      * {@inheritdoc}
148 148
      *
149 149
      * Also set the URLParams
150
+     * @param HTTPRequest $request
150 151
      */
151 152
     public function setRequest($request)
152 153
     {
@@ -523,7 +524,7 @@  discard block
 block discarded – undo
523 524
      *
524 525
      * @param array $params
525 526
      *
526
-     * @return string
527
+     * @return DBHTMLText
527 528
      */
528 529
     public function render($params = null)
529 530
     {
@@ -702,7 +703,7 @@  discard block
 block discarded – undo
702 703
      * Tests whether a redirection has been requested. If redirect() has been called, it will return
703 704
      * the URL redirected to. Otherwise, it will return null.
704 705
      *
705
-     * @return null|string
706
+     * @return boolean
706 707
      */
707 708
     public function redirectedTo()
708 709
     {
@@ -736,7 +737,6 @@  discard block
 block discarded – undo
736 737
      *
737 738
      * Caution: All parameters are expected to be URI-encoded already.
738 739
      *
739
-     * @param string|array $arg,.. One or more link segments, or list of link segments as an array
740 740
      * @return string
741 741
      */
742 742
     public static function join_links($arg = null)
Please login to merge, or discard this patch.