@@ -922,6 +922,7 @@ discard block |
||
| 922 | 922 | * |
| 923 | 923 | * @param String File extension, without dot prefix. Use an asterisk ('*') |
| 924 | 924 | * to specify a generic fallback if no mapping is found for an extension. |
| 925 | + * @param string $ext |
|
| 925 | 926 | * @return String Classname for a subclass of {@link File} |
| 926 | 927 | */ |
| 927 | 928 | public static function get_class_for_file_extension($ext) { |
@@ -1055,7 +1056,6 @@ discard block |
||
| 1055 | 1056 | * Note that the result will not have a leading slash, and should not be used |
| 1056 | 1057 | * with local file paths. |
| 1057 | 1058 | * |
| 1058 | - * @param string $part,... Parts |
|
| 1059 | 1059 | * @return string |
| 1060 | 1060 | */ |
| 1061 | 1061 | public static function join_paths() { |
@@ -99,7 +99,7 @@ |
||
| 99 | 99 | protected $transliterator; |
| 100 | 100 | |
| 101 | 101 | /** |
| 102 | - * @return SS_Transliterator|NULL |
|
| 102 | + * @return SS_Transliterator |
|
| 103 | 103 | */ |
| 104 | 104 | public function getTransliterator() { |
| 105 | 105 | if($this->transliterator === null && $this->config()->default_use_transliterator) { |
@@ -45,7 +45,7 @@ |
||
| 45 | 45 | * Find the given folder or create it as a database record |
| 46 | 46 | * |
| 47 | 47 | * @param string $folderPath Directory path relative to assets root |
| 48 | - * @return Folder|null |
|
| 48 | + * @return null|DataObject |
|
| 49 | 49 | */ |
| 50 | 50 | public static function find_or_make($folderPath) { |
| 51 | 51 | // replace leading and trailing slashes |
@@ -184,7 +184,6 @@ discard block |
||
| 184 | 184 | * Check if this image has previously crashed GD when attempting to open it - if it's opened |
| 185 | 185 | * successfully, the manipulation's cache key is removed. |
| 186 | 186 | * |
| 187 | - * @param string $args,... Any number of args that identify this image |
|
| 188 | 187 | * @return bool True if failed |
| 189 | 188 | */ |
| 190 | 189 | public function failedResample() { |
@@ -195,7 +194,6 @@ discard block |
||
| 195 | 194 | /** |
| 196 | 195 | * Mark a file as failed |
| 197 | 196 | * |
| 198 | - * @param string $args,... Any number of args that identify this image |
|
| 199 | 197 | */ |
| 200 | 198 | protected function markFailed() { |
| 201 | 199 | $key = sha1(implode('|', func_get_args())); |
@@ -205,7 +203,6 @@ discard block |
||
| 205 | 203 | /** |
| 206 | 204 | * Mark a file as succeeded |
| 207 | 205 | * |
| 208 | - * @param string $args,... Any number of args that identify this image |
|
| 209 | 206 | */ |
| 210 | 207 | protected function markSucceeded() { |
| 211 | 208 | $key = sha1(implode('|', func_get_args())); |
@@ -347,7 +344,7 @@ discard block |
||
| 347 | 344 | * using built-in function. Used when imagerotate function is not available(i.e. Ubuntu) |
| 348 | 345 | * |
| 349 | 346 | * @param float $angle Angle in degrees |
| 350 | - * @return static |
|
| 347 | + * @return null|resource |
|
| 351 | 348 | */ |
| 352 | 349 | public function rotatePixelByPixel($angle) { |
| 353 | 350 | if(!$this->gd) { |
@@ -509,7 +509,7 @@ |
||
| 509 | 509 | /** |
| 510 | 510 | * Get HTML for img containing the icon for this file |
| 511 | 511 | * |
| 512 | - * @return type |
|
| 512 | + * @return DBField |
|
| 513 | 513 | */ |
| 514 | 514 | public function IconTag() { |
| 515 | 515 | return DBField::create_field( |
@@ -144,7 +144,6 @@ discard block |
||
| 144 | 144 | * |
| 145 | 145 | * @param string $name The internal field name, passed to forms. |
| 146 | 146 | * @param string $title The field label. |
| 147 | - * @param Form $form Reference to the container form |
|
| 148 | 147 | */ |
| 149 | 148 | public function __construct($name, $title = null) { |
| 150 | 149 | $this->addExtraClass('ss-upload'); // class, used by js |
@@ -256,6 +255,10 @@ discard block |
||
| 256 | 255 | return $this->record; |
| 257 | 256 | } |
| 258 | 257 | |
| 258 | + /** |
|
| 259 | + * @param null|DataObject $value |
|
| 260 | + * @param DataObject $record |
|
| 261 | + */ |
|
| 259 | 262 | public function setValue($value, $record = null) { |
| 260 | 263 | // Extract value from underlying record |
| 261 | 264 | if(empty($value) && $this->getName() && $record instanceof DataObject) { |
@@ -94,6 +94,7 @@ discard block |
||
| 94 | 94 | |
| 95 | 95 | /** |
| 96 | 96 | * @param string |
| 97 | + * @param string $tag |
|
| 97 | 98 | */ |
| 98 | 99 | public function setTag($tag) { |
| 99 | 100 | $this->tag = $tag; |
@@ -110,6 +111,7 @@ discard block |
||
| 110 | 111 | |
| 111 | 112 | /** |
| 112 | 113 | * @param string |
| 114 | + * @param string $legend |
|
| 113 | 115 | */ |
| 114 | 116 | public function setLegend($legend) { |
| 115 | 117 | $this->legend = $legend; |
@@ -200,6 +202,9 @@ discard block |
||
| 200 | 202 | return false; |
| 201 | 203 | } |
| 202 | 204 | |
| 205 | + /** |
|
| 206 | + * @param string $name |
|
| 207 | + */ |
|
| 203 | 208 | public function fieldByName($name) { |
| 204 | 209 | return $this->children->fieldByName($name); |
| 205 | 210 | } |
@@ -224,6 +229,8 @@ discard block |
||
| 224 | 229 | |
| 225 | 230 | /** |
| 226 | 231 | * @uses FieldList->insertAfter() |
| 232 | + * @param string $insertAfter |
|
| 233 | + * @param FormField $field |
|
| 227 | 234 | */ |
| 228 | 235 | public function insertAfter($insertAfter, $field) { |
| 229 | 236 | $ret = $this->children->insertAfter($insertAfter, $field); |
@@ -309,6 +316,7 @@ discard block |
||
| 309 | 316 | * the children collection. Doesn't work recursively. |
| 310 | 317 | * |
| 311 | 318 | * @param string|FormField |
| 319 | + * @param string $field |
|
| 312 | 320 | * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't |
| 313 | 321 | * be found. |
| 314 | 322 | */ |
@@ -120,7 +120,7 @@ discard block |
||
| 120 | 120 | /** |
| 121 | 121 | * @param array $properties |
| 122 | 122 | * |
| 123 | - * @return HTMLText |
|
| 123 | + * @return string |
|
| 124 | 124 | */ |
| 125 | 125 | public function Field($properties = array()) { |
| 126 | 126 | Requirements::javascript(FRAMEWORK_DIR . '/thirdparty/jquery/jquery.js'); |
@@ -417,7 +417,7 @@ discard block |
||
| 417 | 417 | * |
| 418 | 418 | * @param DataObjectInterface $record |
| 419 | 419 | * |
| 420 | - * @return boolean |
|
| 420 | + * @return false|null |
|
| 421 | 421 | */ |
| 422 | 422 | public function saveInto(DataObjectInterface $record) { |
| 423 | 423 | if(!$this->isSaveable()) { |
@@ -90,6 +90,11 @@ discard block |
||
| 90 | 90 | */ |
| 91 | 91 | protected $valueObj = null; |
| 92 | 92 | |
| 93 | + /** |
|
| 94 | + * @param string $name |
|
| 95 | + * @param string $title |
|
| 96 | + * @param string $value |
|
| 97 | + */ |
|
| 93 | 98 | public function __construct($name, $title = null, $value = null) { |
| 94 | 99 | if(!$this->locale) { |
| 95 | 100 | $this->locale = i18n::get_locale(); |
@@ -288,6 +293,9 @@ discard block |
||
| 288 | 293 | return $field; |
| 289 | 294 | } |
| 290 | 295 | |
| 296 | + /** |
|
| 297 | + * @param string $class |
|
| 298 | + */ |
|
| 291 | 299 | public function castedCopy($class) { |
| 292 | 300 | $copy = new $class($this->name); |
| 293 | 301 | if($copy->hasMethod('setConfig')) { |
@@ -326,7 +334,7 @@ discard block |
||
| 326 | 334 | * @deprecated 4.0 Use the "DateField.default_config" config setting instead |
| 327 | 335 | * @param String $k |
| 328 | 336 | * @param mixed $v |
| 329 | - * @return boolean |
|
| 337 | + * @return boolean|null |
|
| 330 | 338 | */ |
| 331 | 339 | public static function set_default_config($k, $v) { |
| 332 | 340 | Deprecation::notice('4.0', 'Use the "DateField.default_config" config setting instead'); |