@@ -2,7 +2,6 @@ |
||
| 2 | 2 | |
| 3 | 3 | namespace SilverStripe\Filesystem\Storage; |
| 4 | 4 | |
| 5 | -use Config; |
|
| 6 | 5 | use Exception; |
| 7 | 6 | use League\Flysystem\Filesystem; |
| 8 | 7 | |
@@ -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) { |
@@ -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()) { |
@@ -93,6 +93,11 @@ discard block |
||
| 93 | 93 | */ |
| 94 | 94 | protected $valueObj = null; |
| 95 | 95 | |
| 96 | + /** |
|
| 97 | + * @param string $name |
|
| 98 | + * @param string $title |
|
| 99 | + * @param string $value |
|
| 100 | + */ |
|
| 96 | 101 | public function __construct($name, $title = null, $value = null) { |
| 97 | 102 | if(!$this->locale) { |
| 98 | 103 | $this->locale = i18n::get_locale(); |
@@ -291,6 +296,9 @@ discard block |
||
| 291 | 296 | return $field; |
| 292 | 297 | } |
| 293 | 298 | |
| 299 | + /** |
|
| 300 | + * @param string $class |
|
| 301 | + */ |
|
| 294 | 302 | public function castedCopy($class) { |
| 295 | 303 | $copy = new $class($this->name); |
| 296 | 304 | if($copy->hasMethod('setConfig')) { |
@@ -329,7 +337,7 @@ discard block |
||
| 329 | 337 | * @deprecated 4.0 Use the "DateField.default_config" config setting instead |
| 330 | 338 | * @param String $k |
| 331 | 339 | * @param mixed $v |
| 332 | - * @return boolean |
|
| 340 | + * @return boolean|null |
|
| 333 | 341 | */ |
| 334 | 342 | public static function set_default_config($k, $v) { |
| 335 | 343 | Deprecation::notice('4.0', 'Use the "DateField.default_config" config setting instead'); |
@@ -59,6 +59,10 @@ discard block |
||
| 59 | 59 | */ |
| 60 | 60 | protected $config; |
| 61 | 61 | |
| 62 | + /** |
|
| 63 | + * @param string $name |
|
| 64 | + * @param string $title |
|
| 65 | + */ |
|
| 62 | 66 | public function __construct($name, $title = null, $value = ""){ |
| 63 | 67 | $this->config = $this->config()->default_config; |
| 64 | 68 | |
@@ -71,6 +75,9 @@ discard block |
||
| 71 | 75 | parent::__construct($name, $title, $value); |
| 72 | 76 | } |
| 73 | 77 | |
| 78 | + /** |
|
| 79 | + * @param Form $form |
|
| 80 | + */ |
|
| 74 | 81 | public function setForm($form) { |
| 75 | 82 | parent::setForm($form); |
| 76 | 83 | |
@@ -81,6 +88,9 @@ discard block |
||
| 81 | 88 | return $this; |
| 82 | 89 | } |
| 83 | 90 | |
| 91 | + /** |
|
| 92 | + * @param string $name |
|
| 93 | + */ |
|
| 84 | 94 | public function setName($name) { |
| 85 | 95 | parent::setName($name); |
| 86 | 96 | |
@@ -93,7 +103,7 @@ discard block |
||
| 93 | 103 | |
| 94 | 104 | /** |
| 95 | 105 | * @param array $properties |
| 96 | - * @return HTMLText |
|
| 106 | + * @return string |
|
| 97 | 107 | */ |
| 98 | 108 | public function FieldHolder($properties = array()) { |
| 99 | 109 | $config = array( |
@@ -108,7 +118,7 @@ discard block |
||
| 108 | 118 | |
| 109 | 119 | /** |
| 110 | 120 | * @param array $properties |
| 111 | - * @return HTMLText |
|
| 121 | + * @return DBField |
|
| 112 | 122 | */ |
| 113 | 123 | public function Field($properties = array()) { |
| 114 | 124 | Requirements::css(FRAMEWORK_DIR . '/css/DatetimeField.css'); |
@@ -243,6 +253,7 @@ discard block |
||
| 243 | 253 | |
| 244 | 254 | /** |
| 245 | 255 | * @param FormField |
| 256 | + * @param DateField $field |
|
| 246 | 257 | */ |
| 247 | 258 | public function setDateField($field) { |
| 248 | 259 | $expected = $this->getName() . '[date]'; |
@@ -268,6 +279,7 @@ discard block |
||
| 268 | 279 | |
| 269 | 280 | /** |
| 270 | 281 | * @param FormField |
| 282 | + * @param TimeField $field |
|
| 271 | 283 | */ |
| 272 | 284 | public function setTimeField($field) { |
| 273 | 285 | $expected = $this->getName() . '[time]'; |
@@ -306,7 +318,7 @@ discard block |
||
| 306 | 318 | * to set field-specific config options. |
| 307 | 319 | * |
| 308 | 320 | * @param string $name |
| 309 | - * @param mixed $val |
|
| 321 | + * @param string $val |
|
| 310 | 322 | */ |
| 311 | 323 | public function setConfig($name, $val) { |
| 312 | 324 | $this->config[$name] = $val; |
@@ -324,7 +336,7 @@ discard block |
||
| 324 | 336 | * to get field-specific config options. |
| 325 | 337 | * |
| 326 | 338 | * @param String $name Optional, returns the whole configuration array if empty |
| 327 | - * @return mixed |
|
| 339 | + * @return string |
|
| 328 | 340 | */ |
| 329 | 341 | public function getConfig($name = null) { |
| 330 | 342 | if($name) { |
@@ -334,6 +346,9 @@ discard block |
||
| 334 | 346 | } |
| 335 | 347 | } |
| 336 | 348 | |
| 349 | + /** |
|
| 350 | + * @param RequiredFields $validator |
|
| 351 | + */ |
|
| 337 | 352 | public function validate($validator) { |
| 338 | 353 | $dateValid = $this->dateField->validate($validator); |
| 339 | 354 | $timeValid = $this->timeField->validate($validator); |
@@ -85,7 +85,7 @@ discard block |
||
| 85 | 85 | |
| 86 | 86 | /** |
| 87 | 87 | * @param array $properties |
| 88 | - * @return HTMLText |
|
| 88 | + * @return string |
|
| 89 | 89 | */ |
| 90 | 90 | public function Field($properties = array()) { |
| 91 | 91 | $properties = array_merge($properties, array( |
@@ -249,7 +249,6 @@ discard block |
||
| 249 | 249 | * for each of these categories |
| 250 | 250 | * |
| 251 | 251 | * @param string $category Category name |
| 252 | - * @param string,... $categories Additional category names |
|
| 253 | 252 | * @return $this |
| 254 | 253 | */ |
| 255 | 254 | public function setAllowedFileCategories($category) { |