====
composer install eden/image
====
Instantiate image in this manner.
$image = eden('image', '/path/to/image.jpg');
Once you are done modifying the image you can save the image to a file or simply echo out the image object like below.
header('Content-Type: image/jpg');
echo $image;
====
====
Applies the selective blur filter. Blurs the image
eden('image', '/path/to/image.jpg')->blur();
Returns Eden\Image\Index
====
Applies the brightness filter. Changes the brightness of the image.
eden('image', '/path/to/image.jpg')->brightness(*number $level);
*number $level- The level of brightness
Returns Eden\Image\Index
eden('image', '/path/to/image.jpg')->brightness($level);
====
Applies the colorize filter. Like greyscale except you can specify the color.
eden('image', '/path/to/image.jpg')->colorize(*number $red, *number $blue, *number $green, number $alpha);
*number $red- The 255 value of red to use*number $blue- The 255 value of blue to use*number $green- The 255 value of green to usenumber $alpha- The level of alpha transparency
Returns Eden\Image\Index
eden('image', '/path/to/image.jpg')->colorize($red, $blue, $green);
====
Applies the contrast filter. Changes the contrast of the image.
eden('image', '/path/to/image.jpg')->contrast(*number $level);
*number $level- The level of contrast
Returns Eden\Image\Index
eden('image', '/path/to/image.jpg')->contrast($level);
====
Crops the image
eden('image', '/path/to/image.jpg')->crop(int|null $width, int|null $height);
int|null $width- The width; If null will use the original widthint|null $height- The height; If null will use the original height
Returns Eden\Image\Index
eden('image', '/path/to/image.jpg')->crop();
====
Applies the edgedetect filter. Uses edge detection to highlight the edges in the image.
eden('image', '/path/to/image.jpg')->edgedetect();
Returns Eden\Image\Index
====
Applies the emboss filter. Embosses the image.
eden('image', '/path/to/image.jpg')->emboss();
Returns Eden\Image\Index
====
Applies the gaussian blur filter. Blurs the image using the Gaussian method.
eden('image', '/path/to/image.jpg')->gaussianBlur();
Returns Eden\Image\Index
====
Returns the size of the image
eden('image', '/path/to/image.jpg')->getDimensions();
Returns array
====
Returns the resource for custom editing
eden('image', '/path/to/image.jpg')->getResource();
Returns [RESOURCE]
====
Applies the greyscale filter. Converts the image into grayscale.
eden('image', '/path/to/image.jpg')->greyscale();
Returns Eden\Image\Index
====
Inverts the image.
eden('image', '/path/to/image.jpg')->invert(bool $vertical);
bool $vertical- If true invert vertical; if false invert horizontal
Returns Eden\Image\Index
eden('image', '/path/to/image.jpg')->invert();
====
Applies the mean removal filter. Uses mean removal to achieve a "sketchy" effect.
eden('image', '/path/to/image.jpg')->meanRemoval();
Returns Eden\Image\Index
====
Applies the greyscale filter. Reverses all colors of the image.
eden('image', '/path/to/image.jpg')->negative();
Returns Eden\Image\Index
====
Resizes the image. This is a version of scale but keeping it's original aspect ratio
eden('image', '/path/to/image.jpg')->resize(int|null $width, int|null $height);
int|null $width- the width; if null will use the original widthint|null $height- the height; if null will use the original height
Returns Eden\Image\Index
eden('image', '/path/to/image.jpg')->resize();
====
Rotates the image.
eden('image', '/path/to/image.jpg')->rotate(*int $degree, int $background);
*int $degree- The degree to rotate byint $background- Background color code
Returns Eden\Image\Index
eden('image', '/path/to/image.jpg')->rotate(123);
====
Scales the image. If width or height is set to null a width or height will be auto determined based on the aspect ratio
eden('image', '/path/to/image.jpg')->scale(int|null $width, int|null $height);
int|null $width- The width; if null will use the original widthint|null $height- The height; if null will use the original height
Returns Eden\Image\Index
eden('image', '/path/to/image.jpg')->scale();
====
Sets the background color to be transparent
eden('image', '/path/to/image.jpg')->setTransparency();
Returns Eden\Image\Index
====
Applies the smooth filter. Makes the image smoother.
eden('image', '/path/to/image.jpg')->smooth(*number $level);
*number $level- The level of smoothness
Returns Eden\Image\Index
eden('image', '/path/to/image.jpg')->smooth($level);
====
Saves the image data to a file
eden('image', '/path/to/image.jpg')->save(*string $path, string|null $type);
*string $path- The path to save tostring|null $type- The render type
Returns Eden\Image\Index
eden('image', '/path/to/image.jpg')->save('foo');
====
Contributions to Eden are following the Github work flow. Please read up before contributing.
##Setting up your machine with the Eden repository and your fork
- Fork the repository
- Fire up your local terminal create a new branch from the
v4branch of your fork with a branch name describing what your changes are. Possible branch name types:- bugfix
- feature
- improvement
- Make your changes. Always make sure to sign-off (-s) on all commits made (git commit -s -m "Commit message")
##Making pull requests
- Please ensure to run
phpunitbefore making a pull request. - Push your code to your remote forked version.
- Go back to your forked version on GitHub and submit a pull request.
- An Eden developer will review your code and merge it in when it has been classified as suitable.