cviebrock/image-validator

Custom Laravel Validator for image dimensions - abandoned since these are now built in to Laravel 5.2 and later

Image-Validator

Extra validation rules for dealing with images in Laravel 5., _(*1)

NOTE: As of Laravel version 5.2, there are now built-in validation rules for image dimensions and aspect ratios. This package is not required and will no longer be maintained., _(*2)

, _(*3)

• Installation
• Usage
  • image_size
  • image_aspect
• Examples
• Bugs, Suggestions and Contributions
• Copyright and License

Installation

NOTE: Depending on your version of Laravel, you should install a different version of the package:, _(*4)

Laravel Version	Package Version
4.*	1.x
5.0–5.3	2.1†
5.4	2.2†
5.5	not supported†

† Laravel 5.2 and later have built-in validation rules for image dimensions., _(*5)

Install the package through Composer., _(*6)

composer require "cviebrock/image-validator"

Add the following to your providers array in app/config/app.php:, _(*7)

'providers' => [
    ...
    \Cviebrock\ImageValidator\ImageValidatorServiceProvider::class,
],

Usage

Use it like any Validator rule. The package offers two rules for image validation:, _(*8)

image_size

$rules = [
    'my_image_field' => 'image_size:<width>[,<height>]',
];

The values for width and _height can be integers, or integers with a modifier prefix:, _(*9)

• 300 or =300 means the dimension must be exactly 300 pixels.
• <300 means the dimension must be less than 300 pixels
• <=300 means the dimension must be less than or equal to 300 pixels
• >300 means the dimension must be greater than 300 pixels
• >=300 means the dimension must be greater than or equal to 300 pixels
• 200-300 means the dimension must be between 200 and 300 pixels (inclusive)
• * means the dimension can be any value

If you only pass one value, it's assumed to apply to both dimensions (i.e. a square image with the given dimensions)., _(*10)

image_aspect

$rules = [
    'my_image_field' => 'image_aspect:<ratio>',
];

The value for ratio represents width ÷ height and be either a decimal or two values (width, height; both integers):, _(*11)

• 0.75
• 3,4

The value (or first value, if providing height and width) can also be prefixed with a tilde ~ character, in which case the orientation does not matter:, _(*12)

• ~3,4 means the image can have an aspect ratio of either 3:4 or 4:3.

Note that you may run into issues with floating point rounding., _(*13)

Examples

// logo must be 300px wide by 400px tall
$rules = [
    'logo' => 'required|image|image_size:300,400',
];

// logo must be less than or equal to 300x300px.
$rules = [
    'logo' => 'required|image|image_size:<=300',
];

// logo must be 300px wide but can be any height
$rules = [
    'logo' => 'required|image|image_size:300,*',
];

// logo must be at least 100px tall and 200-300 pixels wide (inclusive)
$rules = [
    'logo' => 'required|image|image_size:>=100,200-300',
];

// logo must be square
$rules = [
    'logo' => 'required|image|image_aspect:1',
];

// logo must be ready for the big screen TV :)
$rules = [
    'logo' => 'required|image|image_aspect:16,9',
];

Bugs, Suggestions and Contributions

Thanks to everyone who has contributed to this project!, _(*14)

Please use Github for reporting bugs, and making comments or suggestions., _(*15)

See CONTRIBUTING.md for how to contribute changes., _(*16)

Copyright and License

image-validator was written by Colin Viebrock and is released under the MIT License., _(*17)

Copyright 2013 Colin Viebrock, _(*18)

Thanks

Lots of thanks to https://bitbucket.org/hampel/validate-laravel for the structure of creating a package to add validator rules to Laravel, and setting up useful unit tests., _(*19)