class ImageFile extends File (View source)
| Conditionable | |
| Macroable |
| static protected array | $macros | The registered string macros. | from Macroable |
| protected array | $allowedMimetypes | The MIME types that the given file should match. This array may also contain file extensions. | from File |
| protected array | $allowedExtensions | The extensions that the given file should match. | from File |
| protected null|int | $minimumFileSize | The minimum size in kilobytes that the file can be. | from File |
| protected null|int | $maximumFileSize | The maximum size in kilobytes that the file can be. | from File |
| protected array | $customRules | An array of custom rules that will be merged into the validation rules. | from File |
| protected array | $messages | The error message after validation, if any. | from File |
| protected array | $data | The data under validation. | from File |
| protected Validator | $validator | The validator performing the validation. | from File |
| static string|array|callable|null | $defaultCallback | The callback that will generate the "default" version of the file rule. | from File |
| $this|TWhenReturnType | when($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy. | from Conditionable |
| $this|TUnlessReturnType | unless($value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy. | from Conditionable |
| static void | macro(string $name, object|callable $macro)
Register a custom macro. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Mix another object into the class. | from Macroable |
| static bool | hasMacro(string $name)
Checks if macro is registered. | from Macroable |
| static void | flushMacros()
Flush the existing macros. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Dynamically handle calls to the class. | from Macroable |
| mixed | __call(string $method, array $parameters)
Dynamically handle calls to the class. | from Macroable |
| static File|null | defaults(File|callable|null $callback = null)
Set the default callback to be used for determining the file default rules. | from File |
| static File | default()
Get the default configuration of the file rule. | from File |
| static ImageFile | image()
Limit the uploaded file to only image types. | from File |
| static File | types(string|array<int,string> $mimetypes)
Limit the uploaded file to the given MIME types or file extensions. | from File |
| $this | extensions(string|array<int,string> $extensions)
Limit the uploaded file to the given file extensions. | from File |
| $this | size(string|int $size)
Indicate that the uploaded file should be exactly a certain size in kilobytes. | from File |
| $this | between(string|int $minSize, string|int $maxSize)
Indicate that the uploaded file should be between a minimum and maximum size in kilobytes. | from File |
| $this | min(string|int $size)
Indicate that the uploaded file should be no less than the given number of kilobytes. | from File |
| $this | max(string|int $size)
Indicate that the uploaded file should be no more than the given number of kilobytes. | from File |
| mixed | toKilobytes(string|int $size)
Convert a potentially human-friendly file size to kilobytes. | from File |
| $this | rules(string|array $rules)
Specify additional validation rules that should be merged with the default rules during validation. | from File |
| bool | passes(string $attribute, mixed $value)
Determine if the validation rule passes. | from File |
| array | buildValidationRules()
Build the array of underlying validation rules based on the current state. | from File |
| array | buildMimetypes()
Separate the given mimetypes from extensions and return an array of correct rules to validate against. | from File |
| bool | fail(array|string $messages)
Adds the given failures, and return false. | from File |
| string|array | message()
Get the validation error message. | from File |
| $this | setValidator(Validator $validator)
Set the current validator. | from File |
| $this | setData(array $data)
Set the current data under validation. | from File |
| void | __construct()
Create a new image file rule instance. | |
| dimensions(Dimensions $dimensions)
The dimension constraints for the uploaded file. |
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Flush the existing macros.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Set the default callback to be used for determining the file default rules.
If no arguments are passed, the default file rule configuration will be returned.
Get the default configuration of the file rule.
Limit the uploaded file to only image types.
Limit the uploaded file to the given MIME types or file extensions.
Limit the uploaded file to the given file extensions.
Indicate that the uploaded file should be exactly a certain size in kilobytes.
Indicate that the uploaded file should be between a minimum and maximum size in kilobytes.
Indicate that the uploaded file should be no less than the given number of kilobytes.
Indicate that the uploaded file should be no more than the given number of kilobytes.
Convert a potentially human-friendly file size to kilobytes.
Specify additional validation rules that should be merged with the default rules during validation.
Determine if the validation rule passes.
Build the array of underlying validation rules based on the current state.
Separate the given mimetypes from extensions and return an array of correct rules to validate against.
Adds the given failures, and return false.
Get the validation error message.
Set the current validator.
Set the current data under validation.
Create a new image file rule instance.
The dimension constraints for the uploaded file.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Validation/Rules/ImageFile.html