From b9f9c3abda1bd13708034ddfb6023194284f7bc0 Mon Sep 17 00:00:00 2001 From: Oliver Vogel Date: Mon, 28 Apr 2025 16:58:02 +0200 Subject: [PATCH] Fix documentation links --- src/ImageManager.php | 8 +- src/Interfaces/ImageInterface.php | 116 +++++++++++------------ src/Interfaces/ImageManagerInterface.php | 6 +- 3 files changed, 65 insertions(+), 65 deletions(-) diff --git a/src/ImageManager.php b/src/ImageManager.php index 24fe68ae..57b0c4d2 100644 --- a/src/ImageManager.php +++ b/src/ImageManager.php @@ -18,7 +18,7 @@ final class ImageManager implements ImageManagerInterface private DriverInterface $driver; /** - * @link https://image.intervention.io/v3/basics/image-manager#create-a-new-image-manager-instance + * @link https://image.intervention.io/v3/basics/configuration-drivers#create-a-new-image-manager-instance * * @param string|DriverInterface $driver * @param mixed $options @@ -33,7 +33,7 @@ final class ImageManager implements ImageManagerInterface /** * Create image manager with given driver * - * @link https://image.intervention.io/v3/basics/image-manager + * @link https://image.intervention.io/v3/basics/configuration-drivers#static-constructor * * @param string|DriverInterface $driver * @param mixed $options @@ -49,7 +49,7 @@ final class ImageManager implements ImageManagerInterface /** * Create image manager with GD driver * - * @link https://image.intervention.io/v3/basics/image-manager#static-gd-driver-constructor + * @link https://image.intervention.io/v3/basics/configuration-drivers#static-gd-driver-constructor * * @param mixed $options * @throws DriverException @@ -64,7 +64,7 @@ final class ImageManager implements ImageManagerInterface /** * Create image manager with Imagick driver * - * @link https://image.intervention.io/v3/basics/image-manager#static-imagick-driver-constructor + * @link https://image.intervention.io/v3/basics/configuration-drivers#static-imagick-driver-constructor * * @param mixed $options * @throws DriverException diff --git a/src/Interfaces/ImageInterface.php b/src/Interfaces/ImageInterface.php index 4f763344..ea87be31 100644 --- a/src/Interfaces/ImageInterface.php +++ b/src/Interfaces/ImageInterface.php @@ -57,7 +57,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Return width of current image * - * @link https://image.intervention.io/v3/basics/meta-information#reading-the-pixel-width + * @link https://image.intervention.io/v3/basics/meta-information#read-the-pixel-width * * @throws RuntimeException * @return int @@ -67,7 +67,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Return height of current image * - * @link https://image.intervention.io/v3/basics/meta-information#reading-the-pixel-height + * @link https://image.intervention.io/v3/basics/meta-information#read-the-pixel-height * * @throws RuntimeException * @return int @@ -77,7 +77,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Return size of current image * - * @link https://image.intervention.io/v3/basics/meta-information#reading-the-image-size-as-an-object + * @link https://image.intervention.io/v3/basics/meta-information#read-the-image-size-as-an-object * * @throws RuntimeException * @return SizeInterface @@ -87,7 +87,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Encode image with given encoder * - * @link https://image.intervention.io/v3/basics/image-output#encoding-images + * @link https://image.intervention.io/v3/basics/image-output#encode-images * * @param EncoderInterface $encoder * @throws RuntimeException @@ -99,7 +99,7 @@ interface ImageInterface extends IteratorAggregate, Countable * Save the image to the specified path in the file system. If no path is * given, the image will be saved at its original location. * - * @link https://image.intervention.io/v3/basics/image-output#writing-images-directly + * @link https://image.intervention.io/v3/basics/image-output#encode--save-combined * * @param null|string $path * @throws RuntimeException @@ -110,7 +110,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Apply given modifier to current image * - * @link https://image.intervention.io/v3/modifying/custom-modifiers + * @link https://image.intervention.io/v3/modifying-images/custom-modifiers * * @param ModifierInterface $modifier * @throws RuntimeException @@ -130,7 +130,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Determine if current image is animated * - * @link https://image.intervention.io/v3/modifying/animations#check-the-current-image-instance-for-animation + * @link https://image.intervention.io/v3/modifying-images/animations#check-the-current-image-instance-for-animation * * @return bool */ @@ -144,7 +144,7 @@ interface ImageInterface extends IteratorAggregate, Countable * string values must represent a percentage value between '0%' and '100%' * and the respective frame position is only determined approximately. * - * @link https://image.intervention.io/v3/modifying/animations#removing-animation + * @link https://image.intervention.io/v3/modifying-images/animations#remove-animation * * @param int|string $position * @throws RuntimeException @@ -155,7 +155,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Extract animation frames based on given values and discard the rest * - * @link https://image.intervention.io/v3/modifying/animations#changing-the-animation-frames + * @link https://image.intervention.io/v3/modifying-images/animations#change-the-animation-iteration-count * * @param int $offset * @param null|int $length @@ -167,7 +167,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Return loop count of animated image * - * @link https://image.intervention.io/v3/modifying/animations#reading-the-animation-iteration-count + * @link https://image.intervention.io/v3/modifying-images/animations#read-the-animation-iteration-count * * @return int */ @@ -176,7 +176,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Set loop count of animated image * - * @link https://image.intervention.io/v3/modifying/animations#changing-the-animation-iteration-count + * @link https://image.intervention.io/v3/modifying-images/animations#change-the-animation-iteration-count * * @param int $loops * @return ImageInterface @@ -225,7 +225,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Get the colorspace of the image * - * @link https://image.intervention.io/v3/basics/colors#reading-the-colorspace + * @link https://image.intervention.io/v3/basics/colors#read-the-image-colorspace * * @throws RuntimeException * @return ColorspaceInterface @@ -235,7 +235,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Transform image to given colorspace * - * @link https://image.intervention.io/v3/basics/colors#changing-the-colorspace + * @link https://image.intervention.io/v3/basics/colors#change-the-image-colorspace * * @param string|ColorspaceInterface $colorspace * @throws RuntimeException @@ -330,7 +330,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Apply color quantization to the current image * - * @link https://image.intervention.io/v3/modifying/effects#reduce-colors + * @link https://image.intervention.io/v3/modifying-images/effects#reduce-colors * * @param int $limit * @param mixed $background @@ -342,7 +342,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Sharpen the current image with given strength * - * @link https://image.intervention.io/v3/modifying/effects#sharpening-effect + * @link https://image.intervention.io/v3/modifying-images/effects#sharpening-effect * * @param int $amount * @throws RuntimeException @@ -353,7 +353,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Turn image into a greyscale version * - * @link https://image.intervention.io/v3/modifying/effects#convert-image-to-a-greyscale-version + * @link https://image.intervention.io/v3/modifying-images/effects#convert-image-to-a-greyscale-version * * @throws RuntimeException * @return ImageInterface @@ -363,7 +363,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Adjust brightness of the current image * - * @link https://image.intervention.io/v3/modifying/effects#changing-the-brightness + * @link https://image.intervention.io/v3/modifying-images/effects#change-the-image-brightness * * @param int $level * @throws RuntimeException @@ -374,7 +374,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Adjust color contrast of the current image * - * @link https://image.intervention.io/v3/modifying/effects#changing-the-contrast + * @link https://image.intervention.io/v3/modifying-images/effects#change-the-image-contrast * * @param int $level * @throws RuntimeException @@ -385,7 +385,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Apply gamma correction on the current image * - * @link https://image.intervention.io/v3/modifying/effects#gamma-correction + * @link https://image.intervention.io/v3/modifying-images/effects#gamma-correction * * @param float $gamma * @throws RuntimeException @@ -396,7 +396,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Adjust the intensity of the RGB color channels * - * @link https://image.intervention.io/v3/modifying/effects#color-correction + * @link https://image.intervention.io/v3/modifying-images/effects#color-correction * * @param int $red * @param int $green @@ -409,7 +409,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Mirror the current image horizontally * - * @link https://image.intervention.io/v3/modifying/effects#mirror-image-vertically + * @link https://image.intervention.io/v3/modifying-images/effects#mirror-image-vertically * * @throws RuntimeException * @return ImageInterface @@ -419,7 +419,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Mirror the current image vertically * - * @link https://image.intervention.io/v3/modifying/effects#mirror-image-horizontally + * @link https://image.intervention.io/v3/modifying-images/effects#mirror-image-horizontally * * @throws RuntimeException * @return ImageInterface @@ -429,7 +429,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Blur current image by given strength * - * @link https://image.intervention.io/v3/modifying/effects#blur-effect + * @link https://image.intervention.io/v3/modifying-images/effects#blur-effect * * @param int $amount * @throws RuntimeException @@ -440,7 +440,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Invert the colors of the current image * - * @link https://image.intervention.io/v3/modifying/effects#invert-colors + * @link https://image.intervention.io/v3/modifying-images/effects#invert-colors * * @throws RuntimeException * @return ImageInterface @@ -450,7 +450,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Apply pixelation filter effect on current image * - * @link https://image.intervention.io/v3/modifying/effects#pixelation-effect + * @link https://image.intervention.io/v3/modifying-images/effects#pixelation-effect * * @param int $size * @throws RuntimeException @@ -461,7 +461,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Rotate current image by given angle * - * @link https://image.intervention.io/v3/modifying/effects#image-rotation + * @link https://image.intervention.io/v3/modifying-images/effects#image-rotation * * @param float $angle * @param string $background @@ -473,7 +473,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Rotate the image to be upright according to exif information * - * @link https://image.intervention.io/v3/modifying/effects#image-orientation-according-to-exif-data + * @link https://image.intervention.io/v3/modifying-images/effects#image-orientation-according-to-exif-data * * @throws RuntimeException * @return ImageInterface @@ -483,7 +483,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Draw text on image * - * @link https://image.intervention.io/v3/modifying/text-fonts + * @link https://image.intervention.io/v3/modifying-images/text-fonts * * @param string $text * @param int $x @@ -497,7 +497,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Resize image to the given width and/or height * - * @link https://image.intervention.io/v3/modifying/resizing#simple-image-resizing + * @link https://image.intervention.io/v3/modifying-images/resizing#simple-image-resizing * * @param null|int $width * @param null|int $height @@ -509,7 +509,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Resize image to the given width and/or height without exceeding the original dimensions * - * @link https://image.intervention.io/v3/modifying/resizing#resizing-without-exceeding-the-original-size + * @link https://image.intervention.io/v3/modifying-images/resizing#resize-without-exceeding-the-original-size * * @param null|int $width * @param null|int $height @@ -521,7 +521,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Resize image to the given width and/or height and keep the original aspect ratio * - * @link https://image.intervention.io/v3/modifying/resizing#scaling-images + * @link https://image.intervention.io/v3/modifying-images/resizing#resize-images-proportionally * * @param null|int $width * @param null|int $height @@ -534,7 +534,7 @@ interface ImageInterface extends IteratorAggregate, Countable * Resize image to the given width and/or height, keep the original aspect ratio * and do not exceed the original image width or height * - * @link https://image.intervention.io/v3/modifying/resizing#scaling-images-but-do-not-exceed-the-original-size + * @link https://image.intervention.io/v3/modifying-images/resizing#scale-images-but-do-not-exceed-the-original-size * * @param null|int $width * @param null|int $height @@ -549,7 +549,7 @@ interface ImageInterface extends IteratorAggregate, Countable * then positioned on the original and cropped, before this result is resized * to the desired size using the arguments * - * @link https://image.intervention.io/v3/modifying/resizing#fitted-image-resizing + * @link https://image.intervention.io/v3/modifying-images/resizing#cropping--resizing-combined * * @param int $width * @param int $height @@ -562,7 +562,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Same as cover() but do not exceed the original image size * - * @link https://image.intervention.io/v3/modifying/resizing#fitted-resizing-without-exceeding-the-original-size + * @link https://image.intervention.io/v3/modifying-images/resizing#fitted-resizing-without-exceeding-the-original-size * * @param int $width * @param int $height @@ -578,7 +578,7 @@ interface ImageInterface extends IteratorAggregate, Countable * is fixed. A background color can be passed to define the color of the * new emerging areas. * - * @link https://image.intervention.io/v3/modifying/resizing#resize-image-canvas + * @link https://image.intervention.io/v3/modifying-images/resizing#resize-image-boundaries-without-resampling-the-original-image * * @param null|int $width * @param null|int $height @@ -599,7 +599,7 @@ interface ImageInterface extends IteratorAggregate, Countable * for the width and height, which will be added or subtracted to the * original image size. * - * @link https://image.intervention.io/v3/modifying/resizing#resize-image-boundaries-relative-to-the-original + * @link https://image.intervention.io/v3/modifying-images/resizing#resize-image-boundaries-relative-to-the-original * * @param null|int $width * @param null|int $height @@ -624,7 +624,7 @@ interface ImageInterface extends IteratorAggregate, Countable * but possibly new empty areas on the sides of the result image. These are * filled with the specified background color. * - * @link https://image.intervention.io/v3/modifying/resizing#padded-image-resizing + * @link https://image.intervention.io/v3/modifying-images/resizing#resizing--padding-combined * * @param int $width * @param int $height @@ -644,7 +644,7 @@ interface ImageInterface extends IteratorAggregate, Countable * This method does the same as pad(), but the original image is also scaled * up if the target size exceeds the original size. * - * @link https://image.intervention.io/v3/modifying/resizing#padded-resizing-with-upscaling + * @link https://image.intervention.io/v3/modifying-images/resizing#padded-resizing-with-upscaling * * @param int $width * @param int $height @@ -665,7 +665,7 @@ interface ImageInterface extends IteratorAggregate, Countable * height at a given position. Define optional x,y offset coordinates * to move the cutout by the given amount of pixels. * - * @link https://image.intervention.io/v3/modifying/resizing#crop-image + * @link https://image.intervention.io/v3/modifying-images/resizing#cut-out-a-rectangular-part * * @param int $width * @param int $height @@ -688,7 +688,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Trim the image by removing border areas of similar color within a the given tolerance * - * @link https://image.intervention.io/v3/modifying/resizing#trim-image + * @link https://image.intervention.io/v3/modifying-images/resizing#remove-border-areas-in-similar-color * * @param int $tolerance * @throws RuntimeException @@ -700,7 +700,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Place another image into the current image instance * - * @link https://image.intervention.io/v3/modifying/inserting + * @link https://image.intervention.io/v3/modifying-images/inserting#insert-images * * @param mixed $element * @param string $position @@ -728,7 +728,7 @@ interface ImageInterface extends IteratorAggregate, Countable * * If no coordinates are specified, the entire image area is filled. * - * @link https://image.intervention.io/v3/modifying/drawing#fill-images-with-color + * @link https://image.intervention.io/v3/modifying-images/drawing#fill-images-with-color * * @param mixed $color * @param null|int $x @@ -741,7 +741,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Draw a single pixel at given position defined by the coordinates x and y in a given color. * - * @link https://image.intervention.io/v3/modifying/drawing#drawing-a-pixel + * @link https://image.intervention.io/v3/modifying-images/drawing#draw-pixels * * @param int $x * @param int $y @@ -754,7 +754,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Draw a rectangle on the current image * - * @link https://image.intervention.io/v3/modifying/drawing#drawing-a-rectangle + * @link https://image.intervention.io/v3/modifying-images/drawing#draw-a-rectangle * * @param int $x * @param int $y @@ -767,7 +767,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Draw ellipse on the current image * - * @link https://image.intervention.io/v3/modifying/drawing#drawing-ellipses + * @link https://image.intervention.io/v3/modifying-images/drawing#draw-ellipses * * @param int $x * @param int $y @@ -780,7 +780,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Draw circle on the current image * - * @link https://image.intervention.io/v3/modifying/drawing#drawing-a-circle + * @link https://image.intervention.io/v3/modifying-images/drawing#draw-a-circle * * @param int $x * @param int $y @@ -793,7 +793,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Draw a polygon on the current image * - * @link https://image.intervention.io/v3/modifying/drawing#drawing-a-polygon + * @link https://image.intervention.io/v3/modifying-images/drawing#draw-a-polygon * * @param callable|Closure|Polygon $init * @throws RuntimeException @@ -804,7 +804,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Draw a line on the current image * - * @link https://image.intervention.io/v3/modifying/drawing#drawing-a-line + * @link https://image.intervention.io/v3/modifying-images/drawing#draw-a-line * * @param callable|Closure|Line $init * @throws RuntimeException @@ -815,7 +815,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Draw a bezier curve on the current image * - * @link https://image.intervention.io/v3/modifying/drawing#draw-bezier-curves + * @link https://image.intervention.io/v3/modifying-images/drawing#draw-bezier-curves * * @param callable|Closure|Bezier $init * @throws RuntimeException @@ -867,7 +867,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Encode image to JPEG format * - * @link https://image.intervention.io/v3/basics/image-output#encoding-jpeg-format + * @link https://image.intervention.io/v3/basics/image-output#encode-jpeg-format * * @param mixed $options * @throws RuntimeException @@ -879,7 +879,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Encode image to Jpeg2000 format * - * @link https://image.intervention.io/v3/basics/image-output#encoding-jpeg-2000-format + * @link https://image.intervention.io/v3/basics/image-output#encode-jpeg-2000-format * * @param mixed $options * @throws RuntimeException @@ -890,7 +890,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Encode image to Webp format * - * @link https://image.intervention.io/v3/basics/image-output#encoding-webp-format + * @link https://image.intervention.io/v3/basics/image-output#encode-webp-format * * @param mixed $options * @throws RuntimeException @@ -901,7 +901,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Encode image to PNG format * - * @link https://image.intervention.io/v3/basics/image-output#encoding-png-format + * @link https://image.intervention.io/v3/basics/image-output#encode-png-format * * @param mixed $options * @throws RuntimeException @@ -912,7 +912,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Encode image to GIF format * - * @link https://image.intervention.io/v3/basics/image-output#encoding-gif-format + * @link https://image.intervention.io/v3/basics/image-output#encode-gif-format * * @param mixed $options * @throws RuntimeException @@ -923,7 +923,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Encode image to Bitmap format * - * @link https://image.intervention.io/v3/basics/image-output#encoding-windows-bitmap-format + * @link https://image.intervention.io/v3/basics/image-output#encode-windows-bitmap-format * * @param mixed $options * @throws RuntimeException @@ -934,7 +934,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Encode image to AVIF format * - * @link https://image.intervention.io/v3/basics/image-output#encoding-av1-image-file-format-avif + * @link https://image.intervention.io/v3/basics/image-output#encode-av1-image-file-format-avif * * @param mixed $options * @throws RuntimeException @@ -945,7 +945,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Encode image to TIFF format * - * @link https://image.intervention.io/v3/basics/image-output#encoding-tiff-format + * @link https://image.intervention.io/v3/basics/image-output#encode-tiff-format * * @param mixed $options * @throws RuntimeException @@ -956,7 +956,7 @@ interface ImageInterface extends IteratorAggregate, Countable /** * Encode image to HEIC format * - * @link https://image.intervention.io/v3/basics/image-output#encoding-heic-format + * @link https://image.intervention.io/v3/basics/image-output#encode-heic-format * * @param mixed $options * @throws RuntimeException diff --git a/src/Interfaces/ImageManagerInterface.php b/src/Interfaces/ImageManagerInterface.php index 7bfd9d11..d1fae099 100644 --- a/src/Interfaces/ImageManagerInterface.php +++ b/src/Interfaces/ImageManagerInterface.php @@ -11,7 +11,7 @@ interface ImageManagerInterface /** * Create new image instance with given width & height * - * @link https://image.intervention.io/v3/basics/instantiation#creating-new-images + * @link https://image.intervention.io/v3/basics/instantiation#create-new-images * * @param int $width * @param int $height @@ -43,7 +43,7 @@ interface ImageManagerInterface * If the second parameter is not set, an attempt to decode the input is made * with all available decoders of the driver. * - * @link https://image.intervention.io/v3/basics/instantiation#reading-images + * @link https://image.intervention.io/v3/basics/instantiation#read-image-sources * * @param mixed $input * @param string|array|DecoderInterface $decoders @@ -55,7 +55,7 @@ interface ImageManagerInterface /** * Create new animated image by given callback * - * @link https://image.intervention.io/v3/basics/instantiation#creating-animations + * @link https://image.intervention.io/v3/basics/instantiation#create-animations * * @param callable $init * @throws RuntimeException