@@ -211,7 +211,7 @@ |
||
| 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(); |
@@ -132,8 +132,8 @@ discard block |
||
| 132 | 132 | } |
| 133 | 133 | |
| 134 | 134 | /** |
| 135 | - * @param $obj DataObject |
|
| 136 | - * @param $message string |
|
| 135 | + * @param DataObject $obj DataObject |
|
| 136 | + * @param string $message string |
|
| 137 | 137 | */ |
| 138 | 138 | public function addCreated($obj, $message = null) |
| 139 | 139 | { |
@@ -146,8 +146,8 @@ discard block |
||
| 146 | 146 | } |
| 147 | 147 | |
| 148 | 148 | /** |
| 149 | - * @param $obj DataObject |
|
| 150 | - * @param $message string |
|
| 149 | + * @param DataObject $obj DataObject |
|
| 150 | + * @param string $message string |
|
| 151 | 151 | */ |
| 152 | 152 | public function addUpdated($obj, $message = null) |
| 153 | 153 | { |
@@ -160,8 +160,8 @@ discard block |
||
| 160 | 160 | } |
| 161 | 161 | |
| 162 | 162 | /** |
| 163 | - * @param $obj DataObject |
|
| 164 | - * @param $message string |
|
| 163 | + * @param DataObject|null $obj DataObject |
|
| 164 | + * @param string $message string |
|
| 165 | 165 | */ |
| 166 | 166 | public function addDeleted($obj, $message = null) |
| 167 | 167 | { |
@@ -93,7 +93,7 @@ |
||
| 93 | 93 | * @param string $path Path to large file to split |
| 94 | 94 | * @param int $lines Number of lines per file |
| 95 | 95 | * |
| 96 | - * @return array List of file paths |
|
| 96 | + * @return string[] List of file paths |
|
| 97 | 97 | */ |
| 98 | 98 | protected function splitFile($path, $lines = null) { |
| 99 | 99 | $previous = ini_get('auto_detect_line_endings'); |
@@ -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); |
@@ -617,10 +617,10 @@ discard block |
||
| 617 | 617 | /** |
| 618 | 618 | * Assert that the matching email was sent since the last call to clearEmails() |
| 619 | 619 | * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression. |
| 620 | - * @param $to |
|
| 620 | + * @param string $to |
|
| 621 | 621 | * @param $from |
| 622 | - * @param $subject |
|
| 623 | - * @param $content |
|
| 622 | + * @param string $subject |
|
| 623 | + * @param string $content |
|
| 624 | 624 | * @return array Contains the keys: 'type', 'to', 'from', 'subject', 'content', 'plainContent', 'attachedFiles', |
| 625 | 625 | * 'customHeaders', 'htmlContent', inlineImages' |
| 626 | 626 | */ |
@@ -794,7 +794,7 @@ discard block |
||
| 794 | 794 | * @param string $expectedSQL |
| 795 | 795 | * @param string $actualSQL |
| 796 | 796 | * @param string $message |
| 797 | - * @param float|int $delta |
|
| 797 | + * @param integer $delta |
|
| 798 | 798 | * @param integer $maxDepth |
| 799 | 799 | * @param boolean $canonicalize |
| 800 | 800 | * @param boolean $ignoreCase |
@@ -319,7 +319,7 @@ discard block |
||
| 319 | 319 | * @access private |
| 320 | 320 | * @param obj PHPUnit_Framework_Test, current test that is being run |
| 321 | 321 | * @param obj PHPUnit_Framework_AssertationFailedError, PHPUnit error |
| 322 | - * @return array |
|
| 322 | + * @return string |
|
| 323 | 323 | */ |
| 324 | 324 | private function getTestException(PHPUnit_Framework_Test $test, Exception $e) { |
| 325 | 325 | // get the name of the testFile from the test |
@@ -406,6 +406,9 @@ discard block |
||
| 406 | 406 | |
| 407 | 407 | } |
| 408 | 408 | |
| 409 | + /** |
|
| 410 | + * @param string $name |
|
| 411 | + */ |
|
| 409 | 412 | protected function testNameToPhrase($name) { |
| 410 | 413 | return ucfirst(preg_replace("/([a-z])([A-Z])/", "$1 $2", $name)); |
| 411 | 414 | } |
@@ -195,7 +195,7 @@ discard block |
||
| 195 | 195 | /** |
| 196 | 196 | * Determine if the target folder for new uploads in is visible the field UI. |
| 197 | 197 | * |
| 198 | - * @return boolean |
|
| 198 | + * @return boolean|string |
|
| 199 | 199 | */ |
| 200 | 200 | public function canPreviewFolder() { |
| 201 | 201 | if(!$this->isActive()) { |
@@ -264,6 +264,10 @@ discard block |
||
| 264 | 264 | return $this->record; |
| 265 | 265 | } |
| 266 | 266 | |
| 267 | + /** |
|
| 268 | + * @param null|DataObject $value |
|
| 269 | + * @param DataObject $record |
|
| 270 | + */ |
|
| 267 | 271 | public function setValue($value, $record = null) { |
| 268 | 272 | // Extract value from underlying record |
| 269 | 273 | if(empty($value) && $this->getName() && $record instanceof DataObject) { |
@@ -370,7 +374,7 @@ discard block |
||
| 370 | 374 | /** |
| 371 | 375 | * Determine if the user has permission to upload. |
| 372 | 376 | * |
| 373 | - * @return boolean |
|
| 377 | + * @return boolean|string |
|
| 374 | 378 | */ |
| 375 | 379 | public function canUpload() { |
| 376 | 380 | if(!$this->isActive()) { |
@@ -209,6 +209,9 @@ discard block |
||
| 209 | 209 | |
| 210 | 210 | |
| 211 | 211 | |
| 212 | + /** |
|
| 213 | + * @param boolean $disabled |
|
| 214 | + */ |
|
| 212 | 215 | public function setDisabled($disabled) { |
| 213 | 216 | parent::setDisabled($disabled); |
| 214 | 217 | foreach($this->getChildren() as $child) { |
@@ -217,6 +220,9 @@ discard block |
||
| 217 | 220 | return $this; |
| 218 | 221 | } |
| 219 | 222 | |
| 223 | + /** |
|
| 224 | + * @param boolean $readonly |
|
| 225 | + */ |
|
| 220 | 226 | public function setReadonly($readonly) |
| 221 | 227 | { |
| 222 | 228 | parent::setReadonly($readonly); |
@@ -299,6 +305,10 @@ discard block |
||
| 299 | 305 | $this->children->removeByName($fieldName, $dataFieldOnly); |
| 300 | 306 | } |
| 301 | 307 | |
| 308 | + /** |
|
| 309 | + * @param string $fieldName |
|
| 310 | + * @param FormField $newField |
|
| 311 | + */ |
|
| 302 | 312 | public function replaceField($fieldName, $newField) { |
| 303 | 313 | return $this->children->replaceField($fieldName, $newField); |
| 304 | 314 | } |
@@ -362,6 +372,9 @@ discard block |
||
| 362 | 372 | return $clone; |
| 363 | 373 | } |
| 364 | 374 | |
| 375 | + /** |
|
| 376 | + * @return boolean |
|
| 377 | + */ |
|
| 365 | 378 | public function IsReadonly() { |
| 366 | 379 | return $this->readonly; |
| 367 | 380 | } |
@@ -371,6 +384,7 @@ discard block |
||
| 371 | 384 | * the children collection. Doesn't work recursively. |
| 372 | 385 | * |
| 373 | 386 | * @param string|FormField |
| 387 | + * @param string $field |
|
| 374 | 388 | * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't |
| 375 | 389 | * be found. |
| 376 | 390 | */ |
@@ -99,6 +99,11 @@ discard block |
||
| 99 | 99 | */ |
| 100 | 100 | protected $valueObj = null; |
| 101 | 101 | |
| 102 | + /** |
|
| 103 | + * @param string $name |
|
| 104 | + * @param string $title |
|
| 105 | + * @param string $value |
|
| 106 | + */ |
|
| 102 | 107 | public function __construct($name, $title = null, $value = null) { |
| 103 | 108 | if(!$this->locale) { |
| 104 | 109 | $this->locale = i18n::get_locale(); |
@@ -300,7 +305,7 @@ discard block |
||
| 300 | 305 | } |
| 301 | 306 | |
| 302 | 307 | /** |
| 303 | - * @param mixed $class |
|
| 308 | + * @param string $class |
|
| 304 | 309 | * @return FormField |
| 305 | 310 | */ |
| 306 | 311 | public function castedCopy($class) { |