mirror of
https://github.com/Intervention/image.git
synced 2025-08-17 19:26:25 +02:00
Merge pull request #244 from tristanlins/feature/phpdoc-magic-methods
Improve the Image class phpDoc.
This commit is contained in:
Oliver Vogel
@@ -3,49 +3,48 @@
|
|||||||
namespace Intervention\Image;
|
namespace Intervention\Image;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @method \Intervention\Image\Image backup(string $name = 'default') Backup current image.
|
* @method \Intervention\Image\Image backup(string $name = 'default') Backups current image state as fallback for reset method under an optional name. Overwrites older state on every call, unless a different name is passed.
|
||||||
* @method \Intervention\Image\Image blur(integer $amount = 1) Apply gaussian blur filter.
|
* @method \Intervention\Image\Image blur(integer $amount = 1) Apply a gaussian blur filter with a optional amount on the current image. Use values between 0 and 100.
|
||||||
* @method \Intervention\Image\Image brightness(integer $level) Change image brightness.
|
* @method \Intervention\Image\Image brightness(integer $level) Changes the brightness of the current image by the given level. Use values between -100 for min. brightness. 0 for no change and +100 for max. brightness.
|
||||||
* @method \Intervention\Image\Image circle(integer $radius, integer $x, integer $y, Closure $callback = null) Draw a circle.
|
* @method \Intervention\Image\Image cache(\Closure $callback, integer $lifetime = null, boolean $returnObj) Method to create a new cached image instance from a Closure callback. Pass a lifetime in minutes for the callback and decide whether you want to get an Intervention Image instance as return value or just receive the image stream.
|
||||||
* @method \Intervention\Image\Image colorize(integer $red, integer $green, integer $blue) Change color balance.
|
* @method \Intervention\Image\Image canvas(integer $width, integer $height, mixed $bgcolor = null) Factory method to create a new empty image instance with given width and height. You can define a background-color optionally. By default the canvas background is transparent.
|
||||||
* @method \Intervention\Image\Image contrast(integer $level) Change image contrast.
|
* @method \Intervention\Image\Image circle(integer $radius, integer $x, integer $y, \Closure $callback = null) Draw a circle at given x, y, coordinates with given radius. You can define the appearance of the circle by an optional closure callback.
|
||||||
* @method \Intervention\Image\Image crop(integer $width, integer $height, integer $x = null, integer $y = null) Crop image.
|
* @method \Intervention\Image\Image colorize(integer $red, integer $green, integer $blue) Change the RGB color values of the current image on the given channels red, green and blue. The input values are normalized so you have to include parameters from 100 for maximum color value. 0 for no change and -100 to take out all the certain color on the image.
|
||||||
* @method void destroy() Destroy instance and free up memory.
|
* @method \Intervention\Image\Image contrast(integer $level) Changes the contrast of the current image by the given level. Use values between -100 for min. contrast 0 for no change and +100 for max. contrast.
|
||||||
* @method \Intervention\Image\Image ellipse(integer $width, integer $height, integer $x, integer $y, Closure $callback = null) Draw an ellipse.
|
* @method \Intervention\Image\Image crop(integer $width, integer $height, integer $x = null, integer $y = null) Cut out a rectangular part of the current image with given width and height. Define optional x,y coordinates to move the top-left corner of the cutout to a certain position.
|
||||||
* @method mixed exif(string $key = null) Read Exif data from image.
|
* @method void destroy() Frees memory associated with the current image instance before the PHP script ends. Normally resources are destroyed automatically after the script is finished.
|
||||||
* @method \Intervention\Image\Image fill(mixed $filling, integer $x = null, integer $y = null) Fill image with color or pattern.
|
* @method \Intervention\Image\Image ellipse(integer $width, integer $height, integer $x, integer $y, \Closure $callback = null) Draw a colored ellipse at given x, y, coordinates. You can define width and height and set the appearance of the circle by an optional closure callback.
|
||||||
* @method \Intervention\Image\Image filter(\Intervention\Image\Filters\FilterInterface $filter) Apply custom filter.
|
* @method mixed exif(string $key = null) Read Exif meta data from current image.
|
||||||
* @method \Intervention\Image\Image flip(mixed $mode = 'h') Mirror an image.
|
* @method \Intervention\Image\Image fill(mixed $filling, integer $x = null, integer $y = null) Fill current image with given color or another image used as tile for filling. Pass optional x, y coordinates to start at a certain point.
|
||||||
* @method \Intervention\Image\Image fit(integer $width, integer $height = null, Closure $callback = null, string $position = 'center') Crop and resize combined.
|
* @method \Intervention\Image\Image flip(mixed $mode = 'h') Mirror the current image horizontally or vertically by specifying the mode.
|
||||||
* @method \Intervention\Image\Image gamma(float $correction) Apply gamma correction.
|
* @method \Intervention\Image\Image fit(integer $width, integer $height = null, \Closure $callback = null, string $position = 'center') Combine cropping and resizing to format image in a smart way. The method will find the best fitting aspect ratio of your given width and height on the current image automatically, cut it out and resize it to the given dimension. You may pass an optional Closure callback as third parameter, to prevent possible upsizing and a custom position of the cutout as fourth parameter.
|
||||||
* @method \Intervention\Image\Image greyscale() Turn image into greyscale version.
|
* @method \Intervention\Image\Image gamma(float $correction) Performs a gamma correction operation on the current image.
|
||||||
* @method integer height() Get height of image.
|
* @method \Intervention\Image\Image greyscale() Turns image into a greyscale version.
|
||||||
* @method \Intervention\Image\Image heighten(integer $height, Closure $callback = null) Resize image proportionally to given height.
|
* @method \Intervention\Image\Image heighten(integer $height, \Closure $callback = null) Resizes the current image to new height, constraining aspect ratio. Pass an optional Closure callback as third parameter, to apply additional constraints like preventing possible upsizing.
|
||||||
* @method \Intervention\Image\Image insert(mixed $source, string $position = 'top-left', integer $x = 0, integer $y = 0) Insert another image.
|
* @method \Intervention\Image\Image insert(mixed $source, string $position = 'top-left', integer $x = 0, integer $y = 0) Paste a given image source over the current image with an optional position and a offset coordinate. This method can be used to apply another image as watermark because the transparency values are maintained.
|
||||||
* @method \Intervention\Image\Image interlace(boolean $interlace = true) Toggle interlaced image mode.
|
* @method \Intervention\Image\Image interlace(boolean $interlace = true) Determine whether an image should be encoded in interlaced or standard mode by toggling interlace mode with a boolean parameter. If an JPEG image is set interlaced the image will be processed as a progressive JPEG.
|
||||||
* @method \Intervention\Image\Image invert() Invert colors of an image.
|
* @method \Intervention\Image\Image invert() Reverses all colors of the current image.
|
||||||
* @method \Intervention\Image\Image limitColors(integer $count, mixed $matte = null) Convert color palette of image to maximum number of colors.
|
* @method \Intervention\Image\Image limitColors(integer $count, mixed $matte = null) Method converts the existing colors of the current image into a color table with a given maximum count of colors. The function preserves as much alpha channel information as possible and blends transarent pixels against a optional matte color.
|
||||||
* @method \Intervention\Image\Image line(integer $x1, integer $y1, integer $x2, integer $y2, Closure $callback = null) Draw a line.
|
* @method \Intervention\Image\Image line(integer $x1, integer $y1, integer $x2, integer $y2, \Closure $callback = null) Draw a line from x,y point 1 to x,y point 2 on current image. Define color and/or width of line in an optional Closure callback.
|
||||||
* @method \Intervention\Image\Image mask(mixed $source, bool $mask_with_alpha = false) Apply alpha mask.
|
* @method \Intervention\Image\Image make(mixed $source) Universal factory method to create a new image instance from source, which can be a filepath, a GD image resource, an Imagick object or a binary image data.
|
||||||
* @method \Intervention\Image\Image opacity(integer $transparency) Set opacity of an image.
|
* @method \Intervention\Image\Image mask(mixed $source, boolean $mask_with_alpha) Apply a given image source as alpha mask to the current image to change current opacity. Mask will be resized to the current image size. By default a greyscale version of the mask is converted to alpha values, but you can set mask_with_alpha to apply the actual alpha channel. Any transparency values of the current image will be maintained.
|
||||||
* @method \Intervention\Image\Image orientate() Adjust image orientation automatically.
|
* @method \Intervention\Image\Image opacity(integer $transparency) Set the opacity in percent of the current image ranging from 100% for opaque and 0% for full transparency.
|
||||||
* @method mixed pickColor(integer $x, integer $y, string $format = 'array') Pick a color out of an image.
|
* @method \Intervention\Image\Image orientate() This method reads the EXIF image profile setting 'Orientation' and performs a rotation on the image to display the image correctly.
|
||||||
* @method \Intervention\Image\Image pixel(mixed $color, integer $x, integer $y) Draw a single pixel.
|
* @method mixed pickColor(integer $x, integer $y, string $format = 'array') Pick a color at point x, y out of current image and return in optional given format.
|
||||||
* @method \Intervention\Image\Image pixelate(integer $size) Apply pixelation effect.
|
* @method \Intervention\Image\Image pixel(mixed $color, integer $x, integer $y) Draw a single pixel in given color on x, y position.
|
||||||
* @method \Intervention\Image\Image polygon(array $points, Closure $callback = null) Draw a polygon.
|
* @method \Intervention\Image\Image pixelate(integer $size) Applies a pixelation effect to the current image with a given size of pixels.
|
||||||
* @method \Intervention\Image\Image rectangle(integer $x1, integer $y1, integer $x2, integer $y2, Closure $callback = null) Draw a rectangle.
|
* @method \Intervention\Image\Image polygon(array $points, \Closure $callback = null) Draw a colored polygon with given points. You can define the appearance of the polygon by an optional closure callback.
|
||||||
* @method \Intervention\Image\Image reset(string $name = 'default') Reset image instance to backup.
|
* @method \Intervention\Image\Image rectangle(integer $x1, integer $y1, integer $x2, integer $y2, \Closure $callback = null) Draw a colored rectangle on current image with top-left corner on x,y point 1 and bottom-right corner at x,y point 2. Define the overall appearance of the shape by passing a Closure callback as an optional parameter.
|
||||||
* @method \Intervention\Image\Image resize(integer $width, integer $height, Closure $callback = null) Resize image.
|
* @method \Intervention\Image\Image reset(string $name = 'default') Resets all of the modifications to a state saved previously by backup under an optional name.
|
||||||
* @method \Intervention\Image\Image resizeCanvas(integer $width, integer $height, string $anchor = 'center', boolean $relative = false, mixed $bgcolor = '#000000') Resize image boundaries.
|
* @method \Intervention\Image\Image resize(integer $width, integer $height, \Closure $callback = null) Resizes current image based on given width and/or height. To contraint the resize command, pass an optional Closure callback as third parameter.
|
||||||
* @method mixed response(string $format, integer $quality) Attach image to new HTTP response.
|
* @method \Intervention\Image\Image resizeCanvas(integer $width, integer $height, string $anchor = 'center', boolean $relative = false, mixed $bgcolor = '#000000') Resize the boundaries of the current image to given width and height. An anchor can be defined to determine from what point of the image the resizing is going to happen. Set the mode to relative to add or subtract the given width or height to the actual image dimensions. You can also pass a background color for the emerging area of the image.
|
||||||
* @method \Intervention\Image\Image rotate(float $angle, string $bgcolor = '#000000') Rotate image.
|
* @method mixed response(string $format = null, integer $quality = 90) Sends HTTP response with current image in given format and quality.
|
||||||
* @method \Intervention\Image\Image sharpen(integer $amount = 10) Sharpen image.
|
* @method \Intervention\Image\Image rotate(float $angle, string $bgcolor = '#000000') Rotate the current image counter-clockwise by a given angle. Optionally define a background color for the uncovered zone after the rotation.
|
||||||
* @method \Intervention\Image\Image text(string $text, integer $x = 0, integer $y = 0, Closure $callback = null) Write text to an image.
|
* @method \Intervention\Image\Image sharpen(integer $amount = 10) Sharpen current image with an optional amount. Use values between 0 and 100.
|
||||||
* @method \Intervention\Image\Image trim(string $base = 'top-left', array $away = null, integer $tolerance = 0, integer $feather = 0) Trim away parts of an image.
|
* @method \Intervention\Image\Image text(string $text, integer $x = 0, integer $y = 0, \Closure $callback = null) Write a text string to the current image at an optional x,y basepoint position. You can define more details like font-size, font-file and alignment via a callback as the fourth parameter.
|
||||||
* @method \Intervention\Image\Image widen(integer $width, Closure $callback = null) Resize image proportionally to given width.
|
* @method \Intervention\Image\Image trim(string $base = 'top-left', array $away = array('top', 'bottom', 'left', 'right'), integer $tolerance = 0, integer $feather = 0) Trim away image space in given color. Define an optional base to pick a color at a certain position and borders that should be trimmed away. You can also set an optional tolerance level, to trim similar colors and add a feathering border around the trimed image.
|
||||||
* @method integer width() Get width of image.
|
* @method \Intervention\Image\Image widen(integer $width, \Closure $callback = null) Resizes the current image to new width, constraining aspect ratio. Pass an optional Closure callback as third parameter, to apply additional constraints like preventing possible upsizing.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
class Image extends File
|
class Image extends File
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user