@@ -379,7 +379,7 @@ discard block |
||
379 | 379 | /** |
380 | 380 | * Return the IDs of all the marked nodes. |
381 | 381 | * |
382 | - * @return array |
|
382 | + * @return integer[] |
|
383 | 383 | */ |
384 | 384 | public function markedNodeIDs() { |
385 | 385 | return array_keys($this->markedNodes); |
@@ -756,7 +756,7 @@ discard block |
||
756 | 756 | * Get the next node in the tree of the type. If there is no instance of the className descended from this node, |
757 | 757 | * then search the parents. |
758 | 758 | * @param string $className Class name of the node to find. |
759 | - * @param string|int $root ID/ClassName of the node to limit the search to |
|
759 | + * @param integer $root ID/ClassName of the node to limit the search to |
|
760 | 760 | * @param DataObject $afterNode Used for recursive calls to this function |
761 | 761 | * @return DataObject |
762 | 762 | */ |
@@ -24,7 +24,7 @@ discard block |
||
24 | 24 | /** |
25 | 25 | * Modify method visibility to public for testing |
26 | 26 | * |
27 | - * @param mixed $errors |
|
27 | + * @param string $errors |
|
28 | 28 | */ |
29 | 29 | public function setDisplayErrors($errors) |
30 | 30 | { |
@@ -33,6 +33,10 @@ discard block |
||
33 | 33 | } |
34 | 34 | |
35 | 35 | // Change function visibility to be testable directly |
36 | + |
|
37 | + /** |
|
38 | + * @param string $memstring |
|
39 | + */ |
|
36 | 40 | public function translateMemstring($memstring) { |
37 | 41 | return parent::translateMemstring($memstring); |
38 | 42 | } |
@@ -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 |
@@ -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(); |
@@ -385,9 +385,9 @@ discard block |
||
385 | 385 | * it's only advisable to send small files through this method. |
386 | 386 | * |
387 | 387 | * @static |
388 | - * @param $fileData |
|
388 | + * @param string $fileData |
|
389 | 389 | * @param $fileName |
390 | - * @param null $mimeType |
|
390 | + * @param string $mimeType |
|
391 | 391 | * @return SS_HTTPResponse |
392 | 392 | */ |
393 | 393 | public static function send_file($fileData, $fileName, $mimeType = null) { |
@@ -605,7 +605,7 @@ discard block |
||
605 | 605 | * This is used by the request handler to prevent infinite parsing loops. |
606 | 606 | * |
607 | 607 | * @param $pattern |
608 | - * @return bool |
|
608 | + * @return boolean|null |
|
609 | 609 | */ |
610 | 610 | public function isEmptyPattern($pattern) { |
611 | 611 | if(preg_match('/^([A-Za-z]+) +(.*)$/', $pattern, $matches)) { |
@@ -56,7 +56,7 @@ discard block |
||
56 | 56 | * Test if a cache is available or not (for the given id) |
57 | 57 | * |
58 | 58 | * @param string $id cache id |
59 | - * @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record |
|
59 | + * @return boolean false (a cache is not available) or "last modified" timestamp (int) of the available cache record |
|
60 | 60 | */ |
61 | 61 | public function test($id) |
62 | 62 | { |
@@ -192,7 +192,7 @@ discard block |
||
192 | 192 | * - mtime : timestamp of last modification time |
193 | 193 | * |
194 | 194 | * @param string $id cache id |
195 | - * @return array array of metadatas (false if the cache id is not found) |
|
195 | + * @return boolean array of metadatas (false if the cache id is not found) |
|
196 | 196 | */ |
197 | 197 | public function getMetadatas($id) |
198 | 198 | { |
@@ -136,7 +136,7 @@ |
||
136 | 136 | * Helper method to calculate the correct class path |
137 | 137 | * |
138 | 138 | * @param string $class |
139 | - * @return False if not matched other wise the correct path |
|
139 | + * @return false|string if not matched other wise the correct path |
|
140 | 140 | */ |
141 | 141 | public function getClassPath($class) |
142 | 142 | { |
@@ -283,7 +283,7 @@ |
||
283 | 283 | * Whether or not a Plugin by a specific name is loaded |
284 | 284 | * |
285 | 285 | * @param string $name |
286 | - * @return Zend_Loader_PluginLoader |
|
286 | + * @return boolean |
|
287 | 287 | */ |
288 | 288 | public function isLoaded($name) |
289 | 289 | { |
@@ -555,6 +555,7 @@ discard block |
||
555 | 555 | * Returns the menu title for the given LeftAndMain subclass. |
556 | 556 | * Implemented static so that we can get this value without instantiating an object. |
557 | 557 | * Menu title is *not* internationalised. |
558 | + * @return string |
|
558 | 559 | */ |
559 | 560 | public static function menu_title_for_class($class) { |
560 | 561 | $title = Config::inst()->get($class, 'menu_title', Config::FIRST_SET); |
@@ -720,6 +721,7 @@ discard block |
||
720 | 721 | * Return a list of appropriate templates for this class, with the given suffix using |
721 | 722 | * {@link SSViewer::get_templates_by_class()} |
722 | 723 | * |
724 | + * @param string $suffix |
|
723 | 725 | * @return array |
724 | 726 | */ |
725 | 727 | public function getTemplatesWithSuffix($suffix) { |
@@ -1740,7 +1742,7 @@ discard block |
||
1740 | 1742 | } |
1741 | 1743 | |
1742 | 1744 | /** |
1743 | - * @return String |
|
1745 | + * @return DBField |
|
1744 | 1746 | */ |
1745 | 1747 | public function Locale() { |
1746 | 1748 | return DBField::create_field('DBLocale', i18n::get_locale()); |
@@ -1906,6 +1908,9 @@ discard block |
||
1906 | 1908 | return (parent::isFinished() || $this->isFinished); |
1907 | 1909 | } |
1908 | 1910 | |
1911 | + /** |
|
1912 | + * @param boolean $bool |
|
1913 | + */ |
|
1909 | 1914 | public function setIsFinished($bool) { |
1910 | 1915 | $this->isFinished = $bool; |
1911 | 1916 | } |