@@ -22,7 +22,7 @@ |
||
22 | 22 | /** |
23 | 23 | * Gets the list of shortcodes provided by this handler |
24 | 24 | * |
25 | - * @return mixed |
|
25 | + * @return string[] |
|
26 | 26 | */ |
27 | 27 | public static function get_shortcodes() |
28 | 28 | { |
@@ -356,7 +356,7 @@ discard block |
||
356 | 356 | * |
357 | 357 | * @param string $property |
358 | 358 | * the name of the property |
359 | - * @param object $object |
|
359 | + * @param string $object |
|
360 | 360 | * the object to be set |
361 | 361 | */ |
362 | 362 | public function addAutoProperty($property, $object) { |
@@ -450,7 +450,7 @@ discard block |
||
450 | 450 | * The name of the service to update the definition for |
451 | 451 | * @param string $property |
452 | 452 | * The name of the property to update. |
453 | - * @param mixed $value |
|
453 | + * @param string $value |
|
454 | 454 | * The value to set |
455 | 455 | * @param boolean $append |
456 | 456 | * Whether to append (the default) when the property is an array |
@@ -755,6 +755,7 @@ discard block |
||
755 | 755 | * |
756 | 756 | * Will recursively call hasService for each depth of dotting |
757 | 757 | * |
758 | + * @param string $name |
|
758 | 759 | * @return string |
759 | 760 | * The name of the service (as it might be different from the one passed in) |
760 | 761 | */ |
@@ -918,7 +919,6 @@ discard block |
||
918 | 919 | * Additional parameters are passed through as |
919 | 920 | * |
920 | 921 | * @param string $name |
921 | - * @param mixed $arguments,... arguments to pass to the constructor |
|
922 | 922 | * @return mixed A new instance of the specified object |
923 | 923 | */ |
924 | 924 | public function create($name) { |
@@ -932,8 +932,6 @@ discard block |
||
932 | 932 | * |
933 | 933 | * @param string $name |
934 | 934 | * Name of the class to create an object of |
935 | - * @param array $args |
|
936 | - * Arguments to pass to the constructor |
|
937 | 935 | * @return mixed |
938 | 936 | */ |
939 | 937 | public function createWithArgs($name, $constructorArgs) { |
@@ -260,6 +260,9 @@ discard block |
||
260 | 260 | return $this; |
261 | 261 | } |
262 | 262 | |
263 | + /** |
|
264 | + * @param string $type |
|
265 | + */ |
|
263 | 266 | protected function invokeCallbacks($type, $args = array()) { |
264 | 267 | foreach($this->callbacks[$type] as $callback) { |
265 | 268 | call_user_func_array($callback, $args); |
@@ -299,6 +302,9 @@ discard block |
||
299 | 302 | $obj->$name = $this->parseValue($value, $fixtures); |
300 | 303 | } |
301 | 304 | |
305 | + /** |
|
306 | + * @param string $fieldName |
|
307 | + */ |
|
302 | 308 | protected function overrideField($obj, $fieldName, $value, $fixtures = null) { |
303 | 309 | $class = get_class($obj); |
304 | 310 | $table = DataObject::getSchema()->tableForField($class, $fieldName); |
@@ -133,6 +133,7 @@ discard block |
||
133 | 133 | * {@inheritdoc} |
134 | 134 | * |
135 | 135 | * Also set the URLParams |
136 | + * @param SS_HTTPRequest $request |
|
136 | 137 | */ |
137 | 138 | public function setRequest($request) { |
138 | 139 | $return = parent::setRequest($request); |
@@ -509,7 +510,7 @@ discard block |
||
509 | 510 | * |
510 | 511 | * @param array $params |
511 | 512 | * |
512 | - * @return string |
|
513 | + * @return DBHTMLText |
|
513 | 514 | */ |
514 | 515 | public function render($params = null) { |
515 | 516 | $template = $this->getViewer($this->getAction()); |
@@ -674,7 +675,7 @@ discard block |
||
674 | 675 | * Tests whether a redirection has been requested. If redirect() has been called, it will return |
675 | 676 | * the URL redirected to. Otherwise, it will return null. |
676 | 677 | * |
677 | - * @return null|string |
|
678 | + * @return boolean |
|
678 | 679 | */ |
679 | 680 | public function redirectedTo() { |
680 | 681 | return $this->getResponse() && $this->getResponse()->getHeader('Location'); |
@@ -144,7 +144,7 @@ |
||
144 | 144 | /** |
145 | 145 | * Get meta-data details on a named method |
146 | 146 | * |
147 | - * @param array $method |
|
147 | + * @param string $method |
|
148 | 148 | * @return array List of custom method details, if defined for this method |
149 | 149 | */ |
150 | 150 | protected function getExtraMethodConfig($method) { |
@@ -38,6 +38,9 @@ discard block |
||
38 | 38 | ] |
39 | 39 | ); |
40 | 40 | |
41 | + /** |
|
42 | + * @param string $root |
|
43 | + */ |
|
41 | 44 | public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS) { |
42 | 45 | // Get root path |
43 | 46 | $root = $this->findRoot($root); |
@@ -118,7 +121,7 @@ discard block |
||
118 | 121 | * Render server configuration file from a template file |
119 | 122 | * |
120 | 123 | * @param string $template |
121 | - * @return DBHTMLText Rendered results |
|
124 | + * @return string Rendered results |
|
122 | 125 | */ |
123 | 126 | protected function renderTemplate($template) { |
124 | 127 | // Build allowed extensions |
@@ -200,7 +200,7 @@ |
||
200 | 200 | * |
201 | 201 | * @todo refactor this into GridFieldComponent |
202 | 202 | * |
203 | - * @param mixed $value |
|
203 | + * @param string $value |
|
204 | 204 | * @param string|array $castingDefinition |
205 | 205 | * |
206 | 206 | * @return mixed |
@@ -123,6 +123,10 @@ discard block |
||
123 | 123 | )); |
124 | 124 | } |
125 | 125 | |
126 | + /** |
|
127 | + * @param DBHTMLText $result |
|
128 | + * @param string[] $expected |
|
129 | + */ |
|
126 | 130 | private function assertExpectedStrings($result, $expected) { |
127 | 131 | foreach ($expected as $expectedStr) { |
128 | 132 | $this->assertTrue( |
@@ -756,6 +760,10 @@ discard block |
||
756 | 760 | $this->assertEquals('A A1 A1 i A1 ii A2 A3', $rationalisedResult); |
757 | 761 | } |
758 | 762 | |
763 | + /** |
|
764 | + * @param string $a |
|
765 | + * @param string $b |
|
766 | + */ |
|
759 | 767 | public function assertEqualIgnoringWhitespace($a, $b) { |
760 | 768 | $this->assertEquals(preg_replace('/\s+/', '', $a), preg_replace('/\s+/', '', $b)); |
761 | 769 | } |
@@ -1375,6 +1383,11 @@ discard block |
||
1375 | 1383 | Config::inst()->update('SSViewer', 'source_file_comments', false); |
1376 | 1384 | Config::inst()->update('Director', 'environment_type', $origEnv); |
1377 | 1385 | } |
1386 | + |
|
1387 | + /** |
|
1388 | + * @param string $name |
|
1389 | + * @param string $expected |
|
1390 | + */ |
|
1378 | 1391 | private function _renderWithSourceFileComments($name, $expected) { |
1379 | 1392 | $viewer = new SSViewer(array($name)); |
1380 | 1393 | $data = new ArrayData(array()); |
@@ -211,7 +211,7 @@ discard block |
||
211 | 211 | * |
212 | 212 | * @todo Mix in custom column mappings |
213 | 213 | * |
214 | - * @return array |
|
214 | + * @return string |
|
215 | 215 | **/ |
216 | 216 | public function getImportSpec() { |
217 | 217 | $spec = array(); |
@@ -237,7 +237,7 @@ discard block |
||
237 | 237 | * so this is mainly a customization method. |
238 | 238 | * |
239 | 239 | * @param mixed $val |
240 | - * @param string $field Name of the field as specified in the array-values for {@link self::$columnMap}. |
|
240 | + * @param string $fieldName Name of the field as specified in the array-values for {@link self::$columnMap}. |
|
241 | 241 | * @return boolean |
242 | 242 | */ |
243 | 243 | protected function isNullValue($val, $fieldName = null) { |
@@ -361,7 +361,7 @@ discard block |
||
361 | 361 | |
362 | 362 | /** |
363 | 363 | * @param $obj DataObject |
364 | - * @param $message string |
|
364 | + * @param string $message string |
|
365 | 365 | */ |
366 | 366 | public function addCreated($obj, $message = null) { |
367 | 367 | $this->created[] = $this->lastChange = array( |
@@ -374,7 +374,7 @@ discard block |
||
374 | 374 | |
375 | 375 | /** |
376 | 376 | * @param $obj DataObject |
377 | - * @param $message string |
|
377 | + * @param string $message string |
|
378 | 378 | */ |
379 | 379 | public function addUpdated($obj, $message = null) { |
380 | 380 | $this->updated[] = $this->lastChange = array( |
@@ -386,8 +386,8 @@ discard block |
||
386 | 386 | } |
387 | 387 | |
388 | 388 | /** |
389 | - * @param $obj DataObject |
|
390 | - * @param $message string |
|
389 | + * @param DataObject|null $obj DataObject |
|
390 | + * @param string $message string |
|
391 | 391 | */ |
392 | 392 | public function addDeleted($obj, $message = null) { |
393 | 393 | $data = $obj->toMap(); |