@@ -114,7 +114,7 @@ discard block |
||
| 114 | 114 | * |
| 115 | 115 | * @param unknown_type $returnVal |
| 116 | 116 | * @param unknown_type $ignoreAjax |
| 117 | - * @return unknown |
|
| 117 | + * @return string|null |
|
| 118 | 118 | */ |
| 119 | 119 | public static function backtrace($returnVal = false, $ignoreAjax = false, $ignoredFunctions = null) { |
| 120 | 120 | $plainText = Director::is_cli() || (Director::is_ajax() && !$ignoreAjax); |
@@ -131,7 +131,7 @@ discard block |
||
| 131 | 131 | * shown |
| 132 | 132 | * |
| 133 | 133 | * @param Object $item |
| 134 | - * @param boolean $showArg |
|
| 134 | + * @param boolean $showArgs |
|
| 135 | 135 | * @param Int $argCharLimit |
| 136 | 136 | * @return String |
| 137 | 137 | */ |
@@ -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) { |
@@ -357,7 +357,7 @@ discard block |
||
| 357 | 357 | |
| 358 | 358 | /** |
| 359 | 359 | * @param $obj DataObject |
| 360 | - * @param $message string |
|
| 360 | + * @param string $message string |
|
| 361 | 361 | */ |
| 362 | 362 | public function addCreated($obj, $message = null) { |
| 363 | 363 | $this->created[] = $this->lastChange = array( |
@@ -370,7 +370,7 @@ discard block |
||
| 370 | 370 | |
| 371 | 371 | /** |
| 372 | 372 | * @param $obj DataObject |
| 373 | - * @param $message string |
|
| 373 | + * @param string $message string |
|
| 374 | 374 | */ |
| 375 | 375 | public function addUpdated($obj, $message = null) { |
| 376 | 376 | $this->updated[] = $this->lastChange = array( |
@@ -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'); |
@@ -101,7 +101,7 @@ |
||
| 101 | 101 | * |
| 102 | 102 | * You can use the object returned in a foreach loop to extract the data. |
| 103 | 103 | * |
| 104 | - * @param $filename The name of the file. If relative, it will be relative to the site's base dir |
|
| 104 | + * @param string $filename The name of the file. If relative, it will be relative to the site's base dir |
|
| 105 | 105 | * @param $delimiter The character for seperating columns |
| 106 | 106 | * @param $enclosure The character for quoting or enclosing columns |
| 107 | 107 | */ |
@@ -142,6 +142,8 @@ |
||
| 142 | 142 | |
| 143 | 143 | /** |
| 144 | 144 | * @deprecated 4.0.0:5.0.0 Use renderInfo() instead |
| 145 | + * @param string $title |
|
| 146 | + * @param string|false $subtitle |
|
| 145 | 147 | */ |
| 146 | 148 | public function writeInfo($title, $subtitle, $description=false) { |
| 147 | 149 | Deprecation::notice('4.0', 'Use renderInfo() instead'); |
@@ -72,7 +72,7 @@ |
||
| 72 | 72 | * greater than or equal to this version, a message will be raised |
| 73 | 73 | * |
| 74 | 74 | * @static |
| 75 | - * @param $ver string - |
|
| 75 | + * @param string $ver string - |
|
| 76 | 76 | * A php standard version string, see http://php.net/manual/en/function.version-compare.php for details. |
| 77 | 77 | * @param null $forModule string - |
| 78 | 78 | * The name of a module. The passed version will be used as the check value for |
@@ -253,6 +253,9 @@ discard block |
||
| 253 | 253 | return $this; |
| 254 | 254 | } |
| 255 | 255 | |
| 256 | + /** |
|
| 257 | + * @param string $type |
|
| 258 | + */ |
|
| 256 | 259 | protected function invokeCallbacks($type, $args = array()) { |
| 257 | 260 | foreach($this->callbacks[$type] as $callback) { |
| 258 | 261 | call_user_func_array($callback, $args); |
@@ -263,7 +266,6 @@ discard block |
||
| 263 | 266 | * Parse a value from a fixture file. If it starts with => |
| 264 | 267 | * it will get an ID from the fixture dictionary |
| 265 | 268 | * |
| 266 | - * @param string $fieldVal |
|
| 267 | 269 | * @param array $fixtures See {@link createObject()} |
| 268 | 270 | * @param string $class If the value parsed is a class relation, this parameter |
| 269 | 271 | * will be given the value of that class's name |
@@ -292,6 +294,9 @@ discard block |
||
| 292 | 294 | $obj->$name = $this->parseValue($value, $fixtures); |
| 293 | 295 | } |
| 294 | 296 | |
| 297 | + /** |
|
| 298 | + * @param string $fieldName |
|
| 299 | + */ |
|
| 295 | 300 | protected function overrideField($obj, $fieldName, $value, $fixtures = null) { |
| 296 | 301 | $table = ClassInfo::table_for_object_field(get_class($obj), $fieldName); |
| 297 | 302 | $value = $this->parseValue($value, $fixtures); |
@@ -117,6 +117,7 @@ discard block |
||
| 117 | 117 | /** |
| 118 | 118 | * Return all of the IDs in the fixture of a particular class name. |
| 119 | 119 | * |
| 120 | + * @param string $class |
|
| 120 | 121 | * @return A map of fixture-identifier => object-id |
| 121 | 122 | */ |
| 122 | 123 | public function getIds($class) { |
@@ -131,6 +132,7 @@ discard block |
||
| 131 | 132 | * @param String |
| 132 | 133 | * @param String $identifier |
| 133 | 134 | * @param Int $databaseId |
| 135 | + * @param string $class |
|
| 134 | 136 | */ |
| 135 | 137 | public function setId($class, $identifier, $databaseId) { |
| 136 | 138 | $this->fixtures[$class][$identifier] = $databaseId; |
@@ -140,8 +142,8 @@ discard block |
||
| 140 | 142 | /** |
| 141 | 143 | * Get an object from the fixture. |
| 142 | 144 | * |
| 143 | - * @param $class The data class, as specified in your fixture file. Parent classes won't work |
|
| 144 | - * @param $identifier The identifier string, as provided in your fixture file |
|
| 145 | + * @param string $class The data class, as specified in your fixture file. Parent classes won't work |
|
| 146 | + * @param string $identifier The identifier string, as provided in your fixture file |
|
| 145 | 147 | */ |
| 146 | 148 | public function get($class, $identifier) { |
| 147 | 149 | $id = $this->getId($class, $identifier); |
@@ -161,7 +163,7 @@ discard block |
||
| 161 | 163 | * or {@link createRaw()}, both from the internal fixture mapping and the database. |
| 162 | 164 | * If the $class argument is set, limit clearing to items of this class. |
| 163 | 165 | * |
| 164 | - * @param String $class |
|
| 166 | + * @param string $limitToClass |
|
| 165 | 167 | */ |
| 166 | 168 | public function clear($limitToClass = null) { |
| 167 | 169 | $classes = ($limitToClass) ? array($limitToClass) : array_keys($this->fixtures); |
@@ -202,7 +204,6 @@ discard block |
||
| 202 | 204 | * Parse a value from a fixture file. If it starts with => |
| 203 | 205 | * it will get an ID from the fixture dictionary |
| 204 | 206 | * |
| 205 | - * @param String $fieldVal |
|
| 206 | 207 | * @return String Fixture database ID, or the original value |
| 207 | 208 | */ |
| 208 | 209 | protected function parseValue($value) { |
@@ -215,7 +215,7 @@ discard block |
||
| 215 | 215 | * Find an attribute in a SimpleXMLElement object by name. |
| 216 | 216 | * @param SimpleXMLElement $object |
| 217 | 217 | * @param string $attribute Name of attribute to find |
| 218 | - * @return SimpleXMLElement object of the attribute |
|
| 218 | + * @return boolean object of the attribute |
|
| 219 | 219 | */ |
| 220 | 220 | public function findAttribute($object, $attribute) { |
| 221 | 221 | $found = false; |
@@ -245,7 +245,7 @@ discard block |
||
| 245 | 245 | * Note: characters are stripped from the content; make sure that your assertions take this into account. |
| 246 | 246 | * |
| 247 | 247 | * @param string $selector A basic CSS selector, e.g. 'li.jobs h3' |
| 248 | - * @param array|string $expectedMatches The content of at least one of the matched tags |
|
| 248 | + * @param string[] $expectedMatches The content of at least one of the matched tags |
|
| 249 | 249 | * @throws PHPUnit_Framework_AssertionFailedError |
| 250 | 250 | * @return boolean |
| 251 | 251 | */ |
@@ -342,7 +342,7 @@ discard block |
||
| 342 | 342 | * @param string $selector A basic CSS selector, e.g. 'li.jobs h3' |
| 343 | 343 | * @param array|string $expectedMatches The content of *all* matched tags as an array |
| 344 | 344 | * @throws PHPUnit_Framework_AssertionFailedError |
| 345 | - * @return boolean |
|
| 345 | + * @return boolean|null |
|
| 346 | 346 | */ |
| 347 | 347 | public function assertExactHTMLMatchBySelector($selector, $expectedMatches) { |
| 348 | 348 | $items = $this->cssParser()->getBySelector($selector); |