From 54aa51efda8b9f6d6d3d82c7c35a52fa681d3837 Mon Sep 17 00:00:00 2001 From: Oliver Vogel Date: Sun, 11 Aug 2024 17:13:33 +0200 Subject: [PATCH] Add missing doc blocks --- src/Colors/Hsl/Color.php | 8 ++++++++ src/Colors/Hsv/Color.php | 8 ++++++++ .../Rgb/Decoders/TransparentColorDecoder.php | 5 +++++ src/Drivers/Gd/Analyzers/ColorspaceAnalyzer.php | 5 +++++ src/Drivers/Gd/Analyzers/HeightAnalyzer.php | 5 +++++ src/Drivers/Gd/Analyzers/PixelColorAnalyzer.php | 5 +++++ src/Drivers/Gd/Analyzers/PixelColorsAnalyzer.php | 5 +++++ src/Drivers/Gd/Analyzers/ResolutionAnalyzer.php | 5 +++++ src/Drivers/Gd/Analyzers/WidthAnalyzer.php | 5 +++++ src/Drivers/Gd/ColorProcessor.php | 16 ++++++++++++++++ src/Drivers/Gd/Decoders/Base64ImageDecoder.php | 5 +++++ src/Drivers/Gd/Decoders/DataUriImageDecoder.php | 5 +++++ src/Drivers/Gd/Decoders/FilePathImageDecoder.php | 5 +++++ .../Gd/Decoders/FilePointerImageDecoder.php | 5 +++++ .../Gd/Decoders/SplFileInfoImageDecoder.php | 5 +++++ src/Drivers/Gd/Encoders/AvifEncoder.php | 5 +++++ src/Drivers/Gd/Encoders/BmpEncoder.php | 5 +++++ src/Drivers/Gd/Encoders/GifEncoder.php | 5 +++++ src/Drivers/Gd/Encoders/JpegEncoder.php | 5 +++++ src/Drivers/Gd/Encoders/WebpEncoder.php | 5 +++++ .../Gd/Modifiers/AlignRotationModifier.php | 5 +++++ .../Gd/Modifiers/BlendTransparencyModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/BlurModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/BrightnessModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/ColorizeModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/ColorspaceModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/ContainModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/ContrastModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/CoverModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/CropModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/DrawBezierModifier.php | 3 +++ src/Drivers/Gd/Modifiers/DrawEllipseModifier.php | 3 +++ src/Drivers/Gd/Modifiers/DrawPixelModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/DrawPolygonModifier.php | 3 +++ .../Gd/Modifiers/DrawRectangleModifier.php | 3 +++ src/Drivers/Gd/Modifiers/FillModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/FlipModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/FlopModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/GammaModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/GreyscaleModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/InvertModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/PixelateModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/PlaceModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/ProfileModifier.php | 5 +++++ .../Gd/Modifiers/ProfileRemovalModifier.php | 5 +++++ .../Gd/Modifiers/QuantizeColorsModifier.php | 5 +++++ .../Gd/Modifiers/RemoveAnimationModifier.php | 5 +++++ .../Gd/Modifiers/ResizeCanvasModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/ResizeModifier.php | 11 +++++++++++ src/Drivers/Gd/Modifiers/ResolutionModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/RotateModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/ScaleDownModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/SharpenModifier.php | 5 +++++ .../Gd/Modifiers/SliceAnimationModifier.php | 5 +++++ src/Drivers/Gd/Modifiers/TrimModifier.php | 5 +++++ .../Imagick/Decoders/Base64ImageDecoder.php | 5 +++++ .../Imagick/Decoders/BinaryImageDecoder.php | 5 +++++ .../Imagick/Decoders/DataUriImageDecoder.php | 5 +++++ .../Imagick/Decoders/FilePathImageDecoder.php | 5 +++++ .../Imagick/Decoders/FilePointerImageDecoder.php | 5 +++++ .../Imagick/Decoders/NativeObjectDecoder.php | 5 +++++ .../Imagick/Decoders/SplFileInfoImageDecoder.php | 5 +++++ src/Drivers/Imagick/Frame.php | 8 ++++++++ src/Drivers/SpecializableDecoder.php | 5 +++++ src/Encoders/AvifEncoder.php | 6 ++++++ src/Encoders/GifEncoder.php | 6 ++++++ src/Encoders/HeicEncoder.php | 6 ++++++ src/Encoders/Jpeg2000Encoder.php | 6 ++++++ src/Encoders/JpegEncoder.php | 7 +++++++ src/Encoders/PngEncoder.php | 7 +++++++ src/Encoders/TiffEncoder.php | 6 ++++++ src/Encoders/WebpEncoder.php | 6 ++++++ src/Interfaces/ProfileInterface.php | 5 +++++ src/Modifiers/BlendTransparencyModifier.php | 6 ++++++ src/Modifiers/ColorizeModifier.php | 8 ++++++++ src/Modifiers/ContrastModifier.php | 6 ++++++ src/Modifiers/CoverModifier.php | 8 ++++++++ src/Modifiers/CropModifier.php | 11 +++++++++++ src/Modifiers/DrawBezierModifier.php | 11 +++++++++++ src/Modifiers/DrawLineModifier.php | 11 +++++++++++ src/Modifiers/DrawPixelModifier.php | 7 +++++++ src/Modifiers/DrawRectangleModifier.php | 11 +++++++++++ src/Modifiers/PlaceModifier.php | 10 ++++++++++ src/Modifiers/QuantizeColorsModifier.php | 7 +++++++ src/Modifiers/ResizeCanvasModifier.php | 9 +++++++++ src/Modifiers/ResizeModifier.php | 7 +++++++ src/Modifiers/ResolutionModifier.php | 7 +++++++ src/Modifiers/TextModifier.php | 8 ++++++++ src/Modifiers/TrimModifier.php | 6 ++++++ src/Typography/TextBlock.php | 6 ++++++ 90 files changed, 532 insertions(+) diff --git a/src/Colors/Hsl/Color.php b/src/Colors/Hsl/Color.php index 20ca0e5d..ad03c6cc 100644 --- a/src/Colors/Hsl/Color.php +++ b/src/Colors/Hsl/Color.php @@ -16,6 +16,14 @@ use Intervention\Image\Interfaces\ColorspaceInterface; class Color extends AbstractColor { + /** + * Create new color object + * + * @param int $h + * @param int $s + * @param int $l + * @return void + */ public function __construct(int $h, int $s, int $l) { /** @throws void */ diff --git a/src/Colors/Hsv/Color.php b/src/Colors/Hsv/Color.php index 8a4f18b2..62893ec0 100644 --- a/src/Colors/Hsv/Color.php +++ b/src/Colors/Hsv/Color.php @@ -16,6 +16,14 @@ use Intervention\Image\Interfaces\ColorspaceInterface; class Color extends AbstractColor { + /** + * Create new color object + * + * @param int $h + * @param int $s + * @param int $v + * @return void + */ public function __construct(int $h, int $s, int $v) { /** @throws void */ diff --git a/src/Colors/Rgb/Decoders/TransparentColorDecoder.php b/src/Colors/Rgb/Decoders/TransparentColorDecoder.php index c3823d74..f818b790 100644 --- a/src/Colors/Rgb/Decoders/TransparentColorDecoder.php +++ b/src/Colors/Rgb/Decoders/TransparentColorDecoder.php @@ -10,6 +10,11 @@ use Intervention\Image\Interfaces\ColorInterface; class TransparentColorDecoder extends HexColorDecoder { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!is_string($input)) { diff --git a/src/Drivers/Gd/Analyzers/ColorspaceAnalyzer.php b/src/Drivers/Gd/Analyzers/ColorspaceAnalyzer.php index b1082cfd..73057f72 100644 --- a/src/Drivers/Gd/Analyzers/ColorspaceAnalyzer.php +++ b/src/Drivers/Gd/Analyzers/ColorspaceAnalyzer.php @@ -11,6 +11,11 @@ use Intervention\Image\Interfaces\SpecializedInterface; class ColorspaceAnalyzer extends GenericColorspaceAnalyzer implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see AnalyzerInterface::analyze() + */ public function analyze(ImageInterface $image): mixed { return new Colorspace(); diff --git a/src/Drivers/Gd/Analyzers/HeightAnalyzer.php b/src/Drivers/Gd/Analyzers/HeightAnalyzer.php index 40ffb9bc..cf8ed31b 100644 --- a/src/Drivers/Gd/Analyzers/HeightAnalyzer.php +++ b/src/Drivers/Gd/Analyzers/HeightAnalyzer.php @@ -10,6 +10,11 @@ use Intervention\Image\Interfaces\SpecializedInterface; class HeightAnalyzer extends GenericHeightAnalyzer implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see AnalyzerInterface::analyze() + */ public function analyze(ImageInterface $image): mixed { return imagesy($image->core()->native()); diff --git a/src/Drivers/Gd/Analyzers/PixelColorAnalyzer.php b/src/Drivers/Gd/Analyzers/PixelColorAnalyzer.php index 60a0f7fc..b27583a3 100644 --- a/src/Drivers/Gd/Analyzers/PixelColorAnalyzer.php +++ b/src/Drivers/Gd/Analyzers/PixelColorAnalyzer.php @@ -15,6 +15,11 @@ use Intervention\Image\Interfaces\SpecializedInterface; class PixelColorAnalyzer extends GenericPixelColorAnalyzer implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see AnalyzerInterface::analyze() + */ public function analyze(ImageInterface $image): mixed { return $this->colorAt( diff --git a/src/Drivers/Gd/Analyzers/PixelColorsAnalyzer.php b/src/Drivers/Gd/Analyzers/PixelColorsAnalyzer.php index 41d7135a..862d41e1 100644 --- a/src/Drivers/Gd/Analyzers/PixelColorsAnalyzer.php +++ b/src/Drivers/Gd/Analyzers/PixelColorsAnalyzer.php @@ -9,6 +9,11 @@ use Intervention\Image\Interfaces\ImageInterface; class PixelColorsAnalyzer extends PixelColorAnalyzer { + /** + * {@inheritdoc} + * + * @see AnalyzerInterface::analyze() + */ public function analyze(ImageInterface $image): mixed { $colors = new Collection(); diff --git a/src/Drivers/Gd/Analyzers/ResolutionAnalyzer.php b/src/Drivers/Gd/Analyzers/ResolutionAnalyzer.php index 21ed0306..93d37f24 100644 --- a/src/Drivers/Gd/Analyzers/ResolutionAnalyzer.php +++ b/src/Drivers/Gd/Analyzers/ResolutionAnalyzer.php @@ -11,6 +11,11 @@ use Intervention\Image\Resolution; class ResolutionAnalyzer extends GenericResolutionAnalyzer implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see AnalyzerInterface::analyze() + */ public function analyze(ImageInterface $image): mixed { return new Resolution(...imageresolution($image->core()->native())); diff --git a/src/Drivers/Gd/Analyzers/WidthAnalyzer.php b/src/Drivers/Gd/Analyzers/WidthAnalyzer.php index b57a7e14..9c6b793b 100644 --- a/src/Drivers/Gd/Analyzers/WidthAnalyzer.php +++ b/src/Drivers/Gd/Analyzers/WidthAnalyzer.php @@ -10,6 +10,11 @@ use Intervention\Image\Interfaces\SpecializedInterface; class WidthAnalyzer extends GenericWidthAnalyzer implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see AnalyzerInterface::analyze() + */ public function analyze(ImageInterface $image): mixed { return imagesx($image->core()->native()); diff --git a/src/Drivers/Gd/ColorProcessor.php b/src/Drivers/Gd/ColorProcessor.php index c2660340..30583739 100644 --- a/src/Drivers/Gd/ColorProcessor.php +++ b/src/Drivers/Gd/ColorProcessor.php @@ -17,10 +17,21 @@ use Intervention\Image\Interfaces\ColorspaceInterface; class ColorProcessor implements ColorProcessorInterface { + /** + * Create new color processor object + * + * @param ColorspaceInterface $colorspace + * @return void + */ public function __construct(protected ColorspaceInterface $colorspace = new Colorspace()) { } + /** + * {@inheritdoc} + * + * @see ColorProcessorInterface::colorToNative() + */ public function colorToNative(ColorInterface $color): int { // convert color to colorspace @@ -39,6 +50,11 @@ class ColorProcessor implements ColorProcessorInterface return ($a << 24) + ($r << 16) + ($g << 8) + $b; } + /** + * {@inheritdoc} + * + * @see ColorProcessorInterface::nativeToColor() + */ public function nativeToColor(mixed $value): ColorInterface { if (!is_int($value)) { diff --git a/src/Drivers/Gd/Decoders/Base64ImageDecoder.php b/src/Drivers/Gd/Decoders/Base64ImageDecoder.php index f8970b65..7b3686ad 100644 --- a/src/Drivers/Gd/Decoders/Base64ImageDecoder.php +++ b/src/Drivers/Gd/Decoders/Base64ImageDecoder.php @@ -11,6 +11,11 @@ use Intervention\Image\Interfaces\ImageInterface; class Base64ImageDecoder extends BinaryImageDecoder implements DecoderInterface { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!$this->isValidBase64($input)) { diff --git a/src/Drivers/Gd/Decoders/DataUriImageDecoder.php b/src/Drivers/Gd/Decoders/DataUriImageDecoder.php index 939b1e0e..fe3abe6f 100644 --- a/src/Drivers/Gd/Decoders/DataUriImageDecoder.php +++ b/src/Drivers/Gd/Decoders/DataUriImageDecoder.php @@ -11,6 +11,11 @@ use Intervention\Image\Interfaces\ImageInterface; class DataUriImageDecoder extends BinaryImageDecoder implements DecoderInterface { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!is_string($input)) { diff --git a/src/Drivers/Gd/Decoders/FilePathImageDecoder.php b/src/Drivers/Gd/Decoders/FilePathImageDecoder.php index 59b984f7..bb6ddd5c 100644 --- a/src/Drivers/Gd/Decoders/FilePathImageDecoder.php +++ b/src/Drivers/Gd/Decoders/FilePathImageDecoder.php @@ -13,6 +13,11 @@ use Intervention\Image\Modifiers\AlignRotationModifier; class FilePathImageDecoder extends NativeObjectDecoder implements DecoderInterface { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!$this->isFile($input)) { diff --git a/src/Drivers/Gd/Decoders/FilePointerImageDecoder.php b/src/Drivers/Gd/Decoders/FilePointerImageDecoder.php index 66a39f01..0bf649dc 100644 --- a/src/Drivers/Gd/Decoders/FilePointerImageDecoder.php +++ b/src/Drivers/Gd/Decoders/FilePointerImageDecoder.php @@ -10,6 +10,11 @@ use Intervention\Image\Interfaces\ImageInterface; class FilePointerImageDecoder extends BinaryImageDecoder { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!is_resource($input) || !in_array(get_resource_type($input), ['file', 'stream'])) { diff --git a/src/Drivers/Gd/Decoders/SplFileInfoImageDecoder.php b/src/Drivers/Gd/Decoders/SplFileInfoImageDecoder.php index 7febefb0..7aee8f58 100644 --- a/src/Drivers/Gd/Decoders/SplFileInfoImageDecoder.php +++ b/src/Drivers/Gd/Decoders/SplFileInfoImageDecoder.php @@ -12,6 +12,11 @@ use Intervention\Image\Interfaces\ImageInterface; class SplFileInfoImageDecoder extends FilePathImageDecoder implements DecoderInterface { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!is_a($input, SplFileInfo::class)) { diff --git a/src/Drivers/Gd/Encoders/AvifEncoder.php b/src/Drivers/Gd/Encoders/AvifEncoder.php index cc590873..87e5d9e4 100644 --- a/src/Drivers/Gd/Encoders/AvifEncoder.php +++ b/src/Drivers/Gd/Encoders/AvifEncoder.php @@ -11,6 +11,11 @@ use Intervention\Image\Interfaces\SpecializedInterface; class AvifEncoder extends GenericAvifEncoder implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see EncoderInterface::encode() + */ public function encode(ImageInterface $image): EncodedImage { $gd = $image->core()->native(); diff --git a/src/Drivers/Gd/Encoders/BmpEncoder.php b/src/Drivers/Gd/Encoders/BmpEncoder.php index 811cb93e..4cf0dbfa 100644 --- a/src/Drivers/Gd/Encoders/BmpEncoder.php +++ b/src/Drivers/Gd/Encoders/BmpEncoder.php @@ -11,6 +11,11 @@ use Intervention\Image\Interfaces\SpecializedInterface; class BmpEncoder extends GenericBmpEncoder implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see EncoderInterface::encode() + */ public function encode(ImageInterface $image): EncodedImage { $data = $this->buffered(function () use ($image) { diff --git a/src/Drivers/Gd/Encoders/GifEncoder.php b/src/Drivers/Gd/Encoders/GifEncoder.php index 1031a528..875df787 100644 --- a/src/Drivers/Gd/Encoders/GifEncoder.php +++ b/src/Drivers/Gd/Encoders/GifEncoder.php @@ -15,6 +15,11 @@ use Intervention\Image\Interfaces\SpecializedInterface; class GifEncoder extends GenericGifEncoder implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see EncoderInterface::encode() + */ public function encode(ImageInterface $image): EncodedImage { if ($image->isAnimated()) { diff --git a/src/Drivers/Gd/Encoders/JpegEncoder.php b/src/Drivers/Gd/Encoders/JpegEncoder.php index b408a197..268a6f4b 100644 --- a/src/Drivers/Gd/Encoders/JpegEncoder.php +++ b/src/Drivers/Gd/Encoders/JpegEncoder.php @@ -12,6 +12,11 @@ use Intervention\Image\Interfaces\SpecializedInterface; class JpegEncoder extends GenericJpegEncoder implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see EncoderInterface::encode() + */ public function encode(ImageInterface $image): EncodedImage { $blendingColor = $this->driver()->handleInput( diff --git a/src/Drivers/Gd/Encoders/WebpEncoder.php b/src/Drivers/Gd/Encoders/WebpEncoder.php index 5a838c76..5e06ab48 100644 --- a/src/Drivers/Gd/Encoders/WebpEncoder.php +++ b/src/Drivers/Gd/Encoders/WebpEncoder.php @@ -11,6 +11,11 @@ use Intervention\Image\Interfaces\SpecializedInterface; class WebpEncoder extends GenericWebpEncoder implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see EncoderInterface::encode() + */ public function encode(ImageInterface $image): EncodedImage { $quality = $this->quality === 100 ? IMG_WEBP_LOSSLESS : $this->quality; diff --git a/src/Drivers/Gd/Modifiers/AlignRotationModifier.php b/src/Drivers/Gd/Modifiers/AlignRotationModifier.php index daf152fb..791ae7db 100644 --- a/src/Drivers/Gd/Modifiers/AlignRotationModifier.php +++ b/src/Drivers/Gd/Modifiers/AlignRotationModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\AlignRotationModifier as GenericAlignRotationMo class AlignRotationModifier extends GenericAlignRotationModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $image = match ($image->exif('IFD0.Orientation')) { diff --git a/src/Drivers/Gd/Modifiers/BlendTransparencyModifier.php b/src/Drivers/Gd/Modifiers/BlendTransparencyModifier.php index c2cec921..555a163f 100644 --- a/src/Drivers/Gd/Modifiers/BlendTransparencyModifier.php +++ b/src/Drivers/Gd/Modifiers/BlendTransparencyModifier.php @@ -11,6 +11,11 @@ use Intervention\Image\Modifiers\BlendTransparencyModifier as GenericBlendTransp class BlendTransparencyModifier extends GenericBlendTransparencyModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { // decode blending color diff --git a/src/Drivers/Gd/Modifiers/BlurModifier.php b/src/Drivers/Gd/Modifiers/BlurModifier.php index 5357c40e..14fe41a4 100644 --- a/src/Drivers/Gd/Modifiers/BlurModifier.php +++ b/src/Drivers/Gd/Modifiers/BlurModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\BlurModifier as GenericBlurModifier; class BlurModifier extends GenericBlurModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { foreach ($image as $frame) { diff --git a/src/Drivers/Gd/Modifiers/BrightnessModifier.php b/src/Drivers/Gd/Modifiers/BrightnessModifier.php index 747d51d6..022c679a 100644 --- a/src/Drivers/Gd/Modifiers/BrightnessModifier.php +++ b/src/Drivers/Gd/Modifiers/BrightnessModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\BrightnessModifier as GenericBrightnessModifier class BrightnessModifier extends GenericBrightnessModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { foreach ($image as $frame) { diff --git a/src/Drivers/Gd/Modifiers/ColorizeModifier.php b/src/Drivers/Gd/Modifiers/ColorizeModifier.php index 4458a553..c753e438 100644 --- a/src/Drivers/Gd/Modifiers/ColorizeModifier.php +++ b/src/Drivers/Gd/Modifiers/ColorizeModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\ColorizeModifier as GenericColorizeModifier; class ColorizeModifier extends GenericColorizeModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { // normalize colorize levels diff --git a/src/Drivers/Gd/Modifiers/ColorspaceModifier.php b/src/Drivers/Gd/Modifiers/ColorspaceModifier.php index 748ebc7a..a94f82dd 100644 --- a/src/Drivers/Gd/Modifiers/ColorspaceModifier.php +++ b/src/Drivers/Gd/Modifiers/ColorspaceModifier.php @@ -12,6 +12,11 @@ use Intervention\Image\Modifiers\ColorspaceModifier as GenericColorspaceModifier class ColorspaceModifier extends GenericColorspaceModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { if (!is_a($this->targetColorspace(), RgbColorspace::class)) { diff --git a/src/Drivers/Gd/Modifiers/ContainModifier.php b/src/Drivers/Gd/Modifiers/ContainModifier.php index 8761111e..8462e8ef 100644 --- a/src/Drivers/Gd/Modifiers/ContainModifier.php +++ b/src/Drivers/Gd/Modifiers/ContainModifier.php @@ -18,6 +18,11 @@ use Intervention\Image\Modifiers\ContainModifier as GenericContainModifier; class ContainModifier extends GenericContainModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $crop = $this->getCropSize($image); diff --git a/src/Drivers/Gd/Modifiers/ContrastModifier.php b/src/Drivers/Gd/Modifiers/ContrastModifier.php index 8567ac35..7a0ac6b8 100644 --- a/src/Drivers/Gd/Modifiers/ContrastModifier.php +++ b/src/Drivers/Gd/Modifiers/ContrastModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\ContrastModifier as GenericContrastModifier; class ContrastModifier extends GenericContrastModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { foreach ($image as $frame) { diff --git a/src/Drivers/Gd/Modifiers/CoverModifier.php b/src/Drivers/Gd/Modifiers/CoverModifier.php index 4343d43d..e676e663 100644 --- a/src/Drivers/Gd/Modifiers/CoverModifier.php +++ b/src/Drivers/Gd/Modifiers/CoverModifier.php @@ -14,6 +14,11 @@ use Intervention\Image\Modifiers\CoverModifier as GenericCoverModifier; class CoverModifier extends GenericCoverModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $crop = $this->getCropSize($image); diff --git a/src/Drivers/Gd/Modifiers/CropModifier.php b/src/Drivers/Gd/Modifiers/CropModifier.php index 56a019fd..fabdf7f7 100644 --- a/src/Drivers/Gd/Modifiers/CropModifier.php +++ b/src/Drivers/Gd/Modifiers/CropModifier.php @@ -14,6 +14,11 @@ use Intervention\Image\Modifiers\CropModifier as GenericCropModifier; class CropModifier extends GenericCropModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $originalSize = $image->size(); diff --git a/src/Drivers/Gd/Modifiers/DrawBezierModifier.php b/src/Drivers/Gd/Modifiers/DrawBezierModifier.php index a0dfaf91..d8da4937 100644 --- a/src/Drivers/Gd/Modifiers/DrawBezierModifier.php +++ b/src/Drivers/Gd/Modifiers/DrawBezierModifier.php @@ -13,6 +13,9 @@ use Intervention\Image\Modifiers\DrawBezierModifier as ModifiersDrawBezierModifi class DrawBezierModifier extends ModifiersDrawBezierModifier implements SpecializedInterface { /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() * @throws RuntimeException * @throws GeometryException */ diff --git a/src/Drivers/Gd/Modifiers/DrawEllipseModifier.php b/src/Drivers/Gd/Modifiers/DrawEllipseModifier.php index b070349d..2a80af95 100644 --- a/src/Drivers/Gd/Modifiers/DrawEllipseModifier.php +++ b/src/Drivers/Gd/Modifiers/DrawEllipseModifier.php @@ -12,6 +12,9 @@ use Intervention\Image\Modifiers\DrawEllipseModifier as GenericDrawEllipseModifi class DrawEllipseModifier extends GenericDrawEllipseModifier implements SpecializedInterface { /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() * @throws RuntimeException */ public function apply(ImageInterface $image): ImageInterface diff --git a/src/Drivers/Gd/Modifiers/DrawPixelModifier.php b/src/Drivers/Gd/Modifiers/DrawPixelModifier.php index f626ddfb..9fc954cd 100644 --- a/src/Drivers/Gd/Modifiers/DrawPixelModifier.php +++ b/src/Drivers/Gd/Modifiers/DrawPixelModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\DrawPixelModifier as GenericDrawPixelModifier; class DrawPixelModifier extends GenericDrawPixelModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $color = $this->driver()->colorProcessor($image->colorspace())->colorToNative( diff --git a/src/Drivers/Gd/Modifiers/DrawPolygonModifier.php b/src/Drivers/Gd/Modifiers/DrawPolygonModifier.php index e09fbfc5..55e54272 100644 --- a/src/Drivers/Gd/Modifiers/DrawPolygonModifier.php +++ b/src/Drivers/Gd/Modifiers/DrawPolygonModifier.php @@ -12,6 +12,9 @@ use Intervention\Image\Modifiers\DrawPolygonModifier as ModifiersDrawPolygonModi class DrawPolygonModifier extends ModifiersDrawPolygonModifier implements SpecializedInterface { /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() * @throws RuntimeException */ public function apply(ImageInterface $image): ImageInterface diff --git a/src/Drivers/Gd/Modifiers/DrawRectangleModifier.php b/src/Drivers/Gd/Modifiers/DrawRectangleModifier.php index 9b024dbd..2b23c5ee 100644 --- a/src/Drivers/Gd/Modifiers/DrawRectangleModifier.php +++ b/src/Drivers/Gd/Modifiers/DrawRectangleModifier.php @@ -12,6 +12,9 @@ use Intervention\Image\Modifiers\DrawRectangleModifier as GenericDrawRectangleMo class DrawRectangleModifier extends GenericDrawRectangleModifier implements SpecializedInterface { /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() * @throws RuntimeException */ public function apply(ImageInterface $image): ImageInterface diff --git a/src/Drivers/Gd/Modifiers/FillModifier.php b/src/Drivers/Gd/Modifiers/FillModifier.php index 0fe860fa..412f8059 100644 --- a/src/Drivers/Gd/Modifiers/FillModifier.php +++ b/src/Drivers/Gd/Modifiers/FillModifier.php @@ -12,6 +12,11 @@ use Intervention\Image\Modifiers\FillModifier as GenericFillModifier; class FillModifier extends GenericFillModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $color = $this->color($image); diff --git a/src/Drivers/Gd/Modifiers/FlipModifier.php b/src/Drivers/Gd/Modifiers/FlipModifier.php index 8e832cce..0107200a 100644 --- a/src/Drivers/Gd/Modifiers/FlipModifier.php +++ b/src/Drivers/Gd/Modifiers/FlipModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\FlipModifier as GenericFlipModifier; class FlipModifier extends GenericFlipModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { foreach ($image as $frame) { diff --git a/src/Drivers/Gd/Modifiers/FlopModifier.php b/src/Drivers/Gd/Modifiers/FlopModifier.php index 238bc264..70331754 100644 --- a/src/Drivers/Gd/Modifiers/FlopModifier.php +++ b/src/Drivers/Gd/Modifiers/FlopModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\FlopModifier as GenericFlopModifier; class FlopModifier extends GenericFlopModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { foreach ($image as $frame) { diff --git a/src/Drivers/Gd/Modifiers/GammaModifier.php b/src/Drivers/Gd/Modifiers/GammaModifier.php index 0815a7ba..8da6499e 100644 --- a/src/Drivers/Gd/Modifiers/GammaModifier.php +++ b/src/Drivers/Gd/Modifiers/GammaModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\GammaModifier as GenericGammaModifier; class GammaModifier extends GenericGammaModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { foreach ($image as $frame) { diff --git a/src/Drivers/Gd/Modifiers/GreyscaleModifier.php b/src/Drivers/Gd/Modifiers/GreyscaleModifier.php index 2eb04c23..a1cf280a 100644 --- a/src/Drivers/Gd/Modifiers/GreyscaleModifier.php +++ b/src/Drivers/Gd/Modifiers/GreyscaleModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\GreyscaleModifier as GenericGreyscaleModifier; class GreyscaleModifier extends GenericGreyscaleModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { foreach ($image as $frame) { diff --git a/src/Drivers/Gd/Modifiers/InvertModifier.php b/src/Drivers/Gd/Modifiers/InvertModifier.php index 65d42b4e..e2c8dc67 100644 --- a/src/Drivers/Gd/Modifiers/InvertModifier.php +++ b/src/Drivers/Gd/Modifiers/InvertModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\InvertModifier as GenericInvertModifier; class InvertModifier extends GenericInvertModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { foreach ($image as $frame) { diff --git a/src/Drivers/Gd/Modifiers/PixelateModifier.php b/src/Drivers/Gd/Modifiers/PixelateModifier.php index 06ddde14..ecbe3e58 100644 --- a/src/Drivers/Gd/Modifiers/PixelateModifier.php +++ b/src/Drivers/Gd/Modifiers/PixelateModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\PixelateModifier as GenericPixelateModifier; class PixelateModifier extends GenericPixelateModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { foreach ($image as $frame) { diff --git a/src/Drivers/Gd/Modifiers/PlaceModifier.php b/src/Drivers/Gd/Modifiers/PlaceModifier.php index eaad5c2b..9bc264d0 100644 --- a/src/Drivers/Gd/Modifiers/PlaceModifier.php +++ b/src/Drivers/Gd/Modifiers/PlaceModifier.php @@ -13,6 +13,11 @@ use Intervention\Image\Modifiers\PlaceModifier as GenericPlaceModifier; class PlaceModifier extends GenericPlaceModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $watermark = $this->driver()->handleInput($this->element); diff --git a/src/Drivers/Gd/Modifiers/ProfileModifier.php b/src/Drivers/Gd/Modifiers/ProfileModifier.php index 5a5310a1..a862395b 100644 --- a/src/Drivers/Gd/Modifiers/ProfileModifier.php +++ b/src/Drivers/Gd/Modifiers/ProfileModifier.php @@ -11,6 +11,11 @@ use Intervention\Image\Modifiers\ProfileModifier as GenericProfileModifier; class ProfileModifier extends GenericProfileModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { throw new NotSupportedException( diff --git a/src/Drivers/Gd/Modifiers/ProfileRemovalModifier.php b/src/Drivers/Gd/Modifiers/ProfileRemovalModifier.php index 1121036a..2960cd5f 100644 --- a/src/Drivers/Gd/Modifiers/ProfileRemovalModifier.php +++ b/src/Drivers/Gd/Modifiers/ProfileRemovalModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\ProfileRemovalModifier as GenericProfileRemoval class ProfileRemovalModifier extends GenericProfileRemovalModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { // Color profiles are not supported by GD, so the decoded diff --git a/src/Drivers/Gd/Modifiers/QuantizeColorsModifier.php b/src/Drivers/Gd/Modifiers/QuantizeColorsModifier.php index 36e25496..60307844 100644 --- a/src/Drivers/Gd/Modifiers/QuantizeColorsModifier.php +++ b/src/Drivers/Gd/Modifiers/QuantizeColorsModifier.php @@ -12,6 +12,11 @@ use Intervention\Image\Modifiers\QuantizeColorsModifier as GenericQuantizeColors class QuantizeColorsModifier extends GenericQuantizeColorsModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { if ($this->limit <= 0) { diff --git a/src/Drivers/Gd/Modifiers/RemoveAnimationModifier.php b/src/Drivers/Gd/Modifiers/RemoveAnimationModifier.php index 345798f9..6160cab4 100644 --- a/src/Drivers/Gd/Modifiers/RemoveAnimationModifier.php +++ b/src/Drivers/Gd/Modifiers/RemoveAnimationModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\RemoveAnimationModifier as GenericRemoveAnimati class RemoveAnimationModifier extends GenericRemoveAnimationModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $image->core()->setNative( diff --git a/src/Drivers/Gd/Modifiers/ResizeCanvasModifier.php b/src/Drivers/Gd/Modifiers/ResizeCanvasModifier.php index 458a4fd0..65314783 100644 --- a/src/Drivers/Gd/Modifiers/ResizeCanvasModifier.php +++ b/src/Drivers/Gd/Modifiers/ResizeCanvasModifier.php @@ -18,6 +18,11 @@ use Intervention\Image\Modifiers\ResizeCanvasModifier as GenericResizeCanvasModi class ResizeCanvasModifier extends GenericResizeCanvasModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $resize = $this->cropSize($image); diff --git a/src/Drivers/Gd/Modifiers/ResizeModifier.php b/src/Drivers/Gd/Modifiers/ResizeModifier.php index faf67aaf..3b6663f4 100644 --- a/src/Drivers/Gd/Modifiers/ResizeModifier.php +++ b/src/Drivers/Gd/Modifiers/ResizeModifier.php @@ -6,6 +6,7 @@ namespace Intervention\Image\Drivers\Gd\Modifiers; use Intervention\Image\Drivers\Gd\Cloner; use Intervention\Image\Exceptions\ColorException; +use Intervention\Image\Exceptions\GeometryException; use Intervention\Image\Exceptions\RuntimeException; use Intervention\Image\Interfaces\FrameInterface; use Intervention\Image\Interfaces\ImageInterface; @@ -15,6 +16,11 @@ use Intervention\Image\Modifiers\ResizeModifier as GenericResizeModifier; class ResizeModifier extends GenericResizeModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $resizeTo = $this->getAdjustedSize($image); @@ -52,7 +58,12 @@ class ResizeModifier extends GenericResizeModifier implements SpecializedInterfa } /** + * Return the size the modifier will resize to + * + * @param ImageInterface $image * @throws RuntimeException + * @throws GeometryException + * @return SizeInterface */ protected function getAdjustedSize(ImageInterface $image): SizeInterface { diff --git a/src/Drivers/Gd/Modifiers/ResolutionModifier.php b/src/Drivers/Gd/Modifiers/ResolutionModifier.php index 6fcc2335..d6fd504c 100644 --- a/src/Drivers/Gd/Modifiers/ResolutionModifier.php +++ b/src/Drivers/Gd/Modifiers/ResolutionModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\ResolutionModifier as GenericResolutionModifier class ResolutionModifier extends GenericResolutionModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $x = intval(round($this->x)); diff --git a/src/Drivers/Gd/Modifiers/RotateModifier.php b/src/Drivers/Gd/Modifiers/RotateModifier.php index 86811268..2fe5e5cf 100644 --- a/src/Drivers/Gd/Modifiers/RotateModifier.php +++ b/src/Drivers/Gd/Modifiers/RotateModifier.php @@ -18,6 +18,11 @@ use Intervention\Image\Modifiers\RotateModifier as GenericRotateModifier; class RotateModifier extends GenericRotateModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $background = $this->driver()->handleInput($this->background); diff --git a/src/Drivers/Gd/Modifiers/ScaleDownModifier.php b/src/Drivers/Gd/Modifiers/ScaleDownModifier.php index 606978d4..15287e6c 100644 --- a/src/Drivers/Gd/Modifiers/ScaleDownModifier.php +++ b/src/Drivers/Gd/Modifiers/ScaleDownModifier.php @@ -9,6 +9,11 @@ use Intervention\Image\Interfaces\SizeInterface; class ScaleDownModifier extends ResizeModifier { + /** + * {@inheritdoc} + * + * @see ResizeModifier::getAdjustedSize() + */ protected function getAdjustedSize(ImageInterface $image): SizeInterface { return $image->size()->scaleDown($this->width, $this->height); diff --git a/src/Drivers/Gd/Modifiers/SharpenModifier.php b/src/Drivers/Gd/Modifiers/SharpenModifier.php index a1c59397..3943d2cb 100644 --- a/src/Drivers/Gd/Modifiers/SharpenModifier.php +++ b/src/Drivers/Gd/Modifiers/SharpenModifier.php @@ -10,6 +10,11 @@ use Intervention\Image\Modifiers\SharpenModifier as GenericSharpenModifier; class SharpenModifier extends GenericSharpenModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { $matrix = $this->matrix(); diff --git a/src/Drivers/Gd/Modifiers/SliceAnimationModifier.php b/src/Drivers/Gd/Modifiers/SliceAnimationModifier.php index 84b04c36..8986e7fe 100644 --- a/src/Drivers/Gd/Modifiers/SliceAnimationModifier.php +++ b/src/Drivers/Gd/Modifiers/SliceAnimationModifier.php @@ -11,6 +11,11 @@ use Intervention\Image\Modifiers\SliceAnimationModifier as GenericSliceAnimation class SliceAnimationModifier extends GenericSliceAnimationModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { if ($this->offset >= $image->count()) { diff --git a/src/Drivers/Gd/Modifiers/TrimModifier.php b/src/Drivers/Gd/Modifiers/TrimModifier.php index 7c011e0d..26be5d9e 100644 --- a/src/Drivers/Gd/Modifiers/TrimModifier.php +++ b/src/Drivers/Gd/Modifiers/TrimModifier.php @@ -14,6 +14,11 @@ use Intervention\Image\Modifiers\TrimModifier as GenericTrimModifier; class TrimModifier extends GenericTrimModifier implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see ModifierInterface::apply() + */ public function apply(ImageInterface $image): ImageInterface { if ($image->isAnimated()) { diff --git a/src/Drivers/Imagick/Decoders/Base64ImageDecoder.php b/src/Drivers/Imagick/Decoders/Base64ImageDecoder.php index ecddde3c..03fd07ba 100644 --- a/src/Drivers/Imagick/Decoders/Base64ImageDecoder.php +++ b/src/Drivers/Imagick/Decoders/Base64ImageDecoder.php @@ -10,6 +10,11 @@ use Intervention\Image\Interfaces\ImageInterface; class Base64ImageDecoder extends BinaryImageDecoder { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!$this->isValidBase64($input)) { diff --git a/src/Drivers/Imagick/Decoders/BinaryImageDecoder.php b/src/Drivers/Imagick/Decoders/BinaryImageDecoder.php index 25dc5ee3..96850b3c 100644 --- a/src/Drivers/Imagick/Decoders/BinaryImageDecoder.php +++ b/src/Drivers/Imagick/Decoders/BinaryImageDecoder.php @@ -13,6 +13,11 @@ use Intervention\Image\Interfaces\ImageInterface; class BinaryImageDecoder extends NativeObjectDecoder { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!is_string($input)) { diff --git a/src/Drivers/Imagick/Decoders/DataUriImageDecoder.php b/src/Drivers/Imagick/Decoders/DataUriImageDecoder.php index 82a39e68..f395cb00 100644 --- a/src/Drivers/Imagick/Decoders/DataUriImageDecoder.php +++ b/src/Drivers/Imagick/Decoders/DataUriImageDecoder.php @@ -10,6 +10,11 @@ use Intervention\Image\Interfaces\ImageInterface; class DataUriImageDecoder extends BinaryImageDecoder { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!is_string($input)) { diff --git a/src/Drivers/Imagick/Decoders/FilePathImageDecoder.php b/src/Drivers/Imagick/Decoders/FilePathImageDecoder.php index 4a8d4e11..a418099c 100644 --- a/src/Drivers/Imagick/Decoders/FilePathImageDecoder.php +++ b/src/Drivers/Imagick/Decoders/FilePathImageDecoder.php @@ -12,6 +12,11 @@ use Intervention\Image\Interfaces\ImageInterface; class FilePathImageDecoder extends NativeObjectDecoder { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!$this->isFile($input)) { diff --git a/src/Drivers/Imagick/Decoders/FilePointerImageDecoder.php b/src/Drivers/Imagick/Decoders/FilePointerImageDecoder.php index 3145a2b7..08717e09 100644 --- a/src/Drivers/Imagick/Decoders/FilePointerImageDecoder.php +++ b/src/Drivers/Imagick/Decoders/FilePointerImageDecoder.php @@ -10,6 +10,11 @@ use Intervention\Image\Interfaces\ImageInterface; class FilePointerImageDecoder extends BinaryImageDecoder { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!is_resource($input) || !in_array(get_resource_type($input), ['file', 'stream'])) { diff --git a/src/Drivers/Imagick/Decoders/NativeObjectDecoder.php b/src/Drivers/Imagick/Decoders/NativeObjectDecoder.php index 48e50b4b..dec2d8fd 100644 --- a/src/Drivers/Imagick/Decoders/NativeObjectDecoder.php +++ b/src/Drivers/Imagick/Decoders/NativeObjectDecoder.php @@ -17,6 +17,11 @@ use Intervention\Image\Modifiers\RemoveAnimationModifier; class NativeObjectDecoder extends SpecializableDecoder implements SpecializedInterface { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!is_object($input)) { diff --git a/src/Drivers/Imagick/Decoders/SplFileInfoImageDecoder.php b/src/Drivers/Imagick/Decoders/SplFileInfoImageDecoder.php index ad96b7ce..8850123e 100644 --- a/src/Drivers/Imagick/Decoders/SplFileInfoImageDecoder.php +++ b/src/Drivers/Imagick/Decoders/SplFileInfoImageDecoder.php @@ -11,6 +11,11 @@ use Intervention\Image\Interfaces\ImageInterface; class SplFileInfoImageDecoder extends FilePathImageDecoder { + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { if (!is_a($input, SplFileInfo::class)) { diff --git a/src/Drivers/Imagick/Frame.php b/src/Drivers/Imagick/Frame.php index 2439c855..354504cf 100644 --- a/src/Drivers/Imagick/Frame.php +++ b/src/Drivers/Imagick/Frame.php @@ -5,6 +5,7 @@ declare(strict_types=1); namespace Intervention\Image\Drivers\Imagick; use Imagick; +use ImagickException; use ImagickPixel; use Intervention\Image\Geometry\Rectangle; use Intervention\Image\Image; @@ -15,6 +16,13 @@ use Intervention\Image\Interfaces\SizeInterface; class Frame implements FrameInterface { + /** + * Create new frame object + * + * @param Imagick $native + * @throws ImagickException + * @return void + */ public function __construct(protected Imagick $native) { $background = new ImagickPixel('rgba(255, 255, 255, 0)'); diff --git a/src/Drivers/SpecializableDecoder.php b/src/Drivers/SpecializableDecoder.php index 8a9916f6..9b0bf8bc 100644 --- a/src/Drivers/SpecializableDecoder.php +++ b/src/Drivers/SpecializableDecoder.php @@ -14,6 +14,11 @@ abstract class SpecializableDecoder extends AbstractDecoder implements Specializ { use CanBeDriverSpecialized; + /** + * {@inheritdoc} + * + * @see DecoderInterface::decode() + */ public function decode(mixed $input): ImageInterface|ColorInterface { throw new DecoderException('Decoder must be specialized by the driver first.'); diff --git a/src/Encoders/AvifEncoder.php b/src/Encoders/AvifEncoder.php index 89c1a8b4..7799950d 100644 --- a/src/Encoders/AvifEncoder.php +++ b/src/Encoders/AvifEncoder.php @@ -8,6 +8,12 @@ use Intervention\Image\Drivers\SpecializableEncoder; class AvifEncoder extends SpecializableEncoder { + /** + * Create new encoder object + * + * @param int $quality + * @return void + */ public function __construct(public int $quality = self::DEFAULT_QUALITY) { } diff --git a/src/Encoders/GifEncoder.php b/src/Encoders/GifEncoder.php index 2f5d0744..65f0224f 100644 --- a/src/Encoders/GifEncoder.php +++ b/src/Encoders/GifEncoder.php @@ -8,6 +8,12 @@ use Intervention\Image\Drivers\SpecializableEncoder; class GifEncoder extends SpecializableEncoder { + /** + * Create new encoder object + * + * @param bool $interlaced + * @return void + */ public function __construct(public bool $interlaced = false) { } diff --git a/src/Encoders/HeicEncoder.php b/src/Encoders/HeicEncoder.php index 8c4272de..2d129a35 100644 --- a/src/Encoders/HeicEncoder.php +++ b/src/Encoders/HeicEncoder.php @@ -8,6 +8,12 @@ use Intervention\Image\Drivers\SpecializableEncoder; class HeicEncoder extends SpecializableEncoder { + /** + * Create new encoder object + * + * @param int $quality + * @return void + */ public function __construct(public int $quality = self::DEFAULT_QUALITY) { } diff --git a/src/Encoders/Jpeg2000Encoder.php b/src/Encoders/Jpeg2000Encoder.php index 67c0ff90..dea11ef2 100644 --- a/src/Encoders/Jpeg2000Encoder.php +++ b/src/Encoders/Jpeg2000Encoder.php @@ -8,6 +8,12 @@ use Intervention\Image\Drivers\SpecializableEncoder; class Jpeg2000Encoder extends SpecializableEncoder { + /** + * Create new encoder object + * + * @param int $quality + * @return void + */ public function __construct(public int $quality = self::DEFAULT_QUALITY) { } diff --git a/src/Encoders/JpegEncoder.php b/src/Encoders/JpegEncoder.php index 5753c249..eaf520e1 100644 --- a/src/Encoders/JpegEncoder.php +++ b/src/Encoders/JpegEncoder.php @@ -8,6 +8,13 @@ use Intervention\Image\Drivers\SpecializableEncoder; class JpegEncoder extends SpecializableEncoder { + /** + * Create new encoder object + * + * @param int $quality + * @param bool $progressive + * @return void + */ public function __construct( public int $quality = self::DEFAULT_QUALITY, public bool $progressive = false diff --git a/src/Encoders/PngEncoder.php b/src/Encoders/PngEncoder.php index 7b2df853..b3376e0d 100644 --- a/src/Encoders/PngEncoder.php +++ b/src/Encoders/PngEncoder.php @@ -8,6 +8,13 @@ use Intervention\Image\Drivers\SpecializableEncoder; class PngEncoder extends SpecializableEncoder { + /** + * Create new encoder object + * + * @param bool $interlaced + * @param bool $indexed + * @return void + */ public function __construct(public bool $interlaced = false, public bool $indexed = false) { } diff --git a/src/Encoders/TiffEncoder.php b/src/Encoders/TiffEncoder.php index 29621892..203baf8c 100644 --- a/src/Encoders/TiffEncoder.php +++ b/src/Encoders/TiffEncoder.php @@ -8,6 +8,12 @@ use Intervention\Image\Drivers\SpecializableEncoder; class TiffEncoder extends SpecializableEncoder { + /** + * Create new encoder object + * + * @param int $quality + * @return void + */ public function __construct(public int $quality = self::DEFAULT_QUALITY) { } diff --git a/src/Encoders/WebpEncoder.php b/src/Encoders/WebpEncoder.php index 535d6b79..5530b6e6 100644 --- a/src/Encoders/WebpEncoder.php +++ b/src/Encoders/WebpEncoder.php @@ -8,6 +8,12 @@ use Intervention\Image\Drivers\SpecializableEncoder; class WebpEncoder extends SpecializableEncoder { + /** + * Create new encoder object + * + * @param int $quality + * @return void + */ public function __construct(public int $quality = self::DEFAULT_QUALITY) { } diff --git a/src/Interfaces/ProfileInterface.php b/src/Interfaces/ProfileInterface.php index 925aae36..8453fda7 100644 --- a/src/Interfaces/ProfileInterface.php +++ b/src/Interfaces/ProfileInterface.php @@ -6,5 +6,10 @@ namespace Intervention\Image\Interfaces; interface ProfileInterface { + /** + * Cast color profile object to string + * + * @return string + */ public function __toString(): string; } diff --git a/src/Modifiers/BlendTransparencyModifier.php b/src/Modifiers/BlendTransparencyModifier.php index 6e330c44..0e8958fb 100644 --- a/src/Modifiers/BlendTransparencyModifier.php +++ b/src/Modifiers/BlendTransparencyModifier.php @@ -8,6 +8,12 @@ use Intervention\Image\Drivers\SpecializableModifier; class BlendTransparencyModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param mixed $color + * @return void + */ public function __construct(public mixed $color = null) { } diff --git a/src/Modifiers/ColorizeModifier.php b/src/Modifiers/ColorizeModifier.php index 2fe28721..b3330baf 100644 --- a/src/Modifiers/ColorizeModifier.php +++ b/src/Modifiers/ColorizeModifier.php @@ -8,6 +8,14 @@ use Intervention\Image\Drivers\SpecializableModifier; class ColorizeModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param int $red + * @param int $green + * @param int $blue + * @return void + */ public function __construct( public int $red = 0, public int $green = 0, diff --git a/src/Modifiers/ContrastModifier.php b/src/Modifiers/ContrastModifier.php index e61f5832..01f726ab 100644 --- a/src/Modifiers/ContrastModifier.php +++ b/src/Modifiers/ContrastModifier.php @@ -8,6 +8,12 @@ use Intervention\Image\Drivers\SpecializableModifier; class ContrastModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param int $level + * @return void + */ public function __construct(public int $level) { } diff --git a/src/Modifiers/CoverModifier.php b/src/Modifiers/CoverModifier.php index 61e5acc5..a49e26a2 100644 --- a/src/Modifiers/CoverModifier.php +++ b/src/Modifiers/CoverModifier.php @@ -12,6 +12,14 @@ use Intervention\Image\Interfaces\SizeInterface; class CoverModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param int $width + * @param int $height + * @param string $position + * @return void + */ public function __construct( public int $width, public int $height, diff --git a/src/Modifiers/CropModifier.php b/src/Modifiers/CropModifier.php index ffc6b499..c4c9b157 100644 --- a/src/Modifiers/CropModifier.php +++ b/src/Modifiers/CropModifier.php @@ -12,6 +12,17 @@ use Intervention\Image\Interfaces\SizeInterface; class CropModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param int $width + * @param int $height + * @param int $offset_x + * @param int $offset_y + * @param mixed $background + * @param string $position + * @return void + */ public function __construct( public int $width, public int $height, diff --git a/src/Modifiers/DrawBezierModifier.php b/src/Modifiers/DrawBezierModifier.php index 5bac23ed..f4b1555c 100644 --- a/src/Modifiers/DrawBezierModifier.php +++ b/src/Modifiers/DrawBezierModifier.php @@ -9,10 +9,21 @@ use Intervention\Image\Interfaces\DrawableInterface; class DrawBezierModifier extends AbstractDrawModifier { + /** + * Create new modifier object + * + * @param Bezier $drawable + * @return void + */ public function __construct(public Bezier $drawable) { } + /** + * Return object to be drawn + * + * @return DrawableInterface + */ public function drawable(): DrawableInterface { return $this->drawable; diff --git a/src/Modifiers/DrawLineModifier.php b/src/Modifiers/DrawLineModifier.php index 4997124b..1e881bad 100644 --- a/src/Modifiers/DrawLineModifier.php +++ b/src/Modifiers/DrawLineModifier.php @@ -9,10 +9,21 @@ use Intervention\Image\Interfaces\DrawableInterface; class DrawLineModifier extends AbstractDrawModifier { + /** + * Create new modifier object + * + * @param Line $drawable + * @return void + */ public function __construct(public Line $drawable) { } + /** + * Return object to be drawn + * + * @return DrawableInterface + */ public function drawable(): DrawableInterface { return $this->drawable; diff --git a/src/Modifiers/DrawPixelModifier.php b/src/Modifiers/DrawPixelModifier.php index 6e4d732a..43bf0e79 100644 --- a/src/Modifiers/DrawPixelModifier.php +++ b/src/Modifiers/DrawPixelModifier.php @@ -9,6 +9,13 @@ use Intervention\Image\Interfaces\PointInterface; class DrawPixelModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param PointInterface $position + * @param mixed $color + * @return void + */ public function __construct( public PointInterface $position, public mixed $color diff --git a/src/Modifiers/DrawRectangleModifier.php b/src/Modifiers/DrawRectangleModifier.php index 03d521c2..2f0e689d 100644 --- a/src/Modifiers/DrawRectangleModifier.php +++ b/src/Modifiers/DrawRectangleModifier.php @@ -9,10 +9,21 @@ use Intervention\Image\Interfaces\DrawableInterface; class DrawRectangleModifier extends AbstractDrawModifier { + /** + * + * Create new modifier object + * @param Rectangle $drawable + * @return void + */ public function __construct(public Rectangle $drawable) { } + /** + * Return object to be drawn + * + * @return DrawableInterface + */ public function drawable(): DrawableInterface { return $this->drawable; diff --git a/src/Modifiers/PlaceModifier.php b/src/Modifiers/PlaceModifier.php index 836066fa..601e7015 100644 --- a/src/Modifiers/PlaceModifier.php +++ b/src/Modifiers/PlaceModifier.php @@ -11,6 +11,16 @@ use Intervention\Image\Interfaces\PointInterface; class PlaceModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param mixed $element + * @param string $position + * @param int $offset_x + * @param int $offset_y + * @param int $opacity + * @return void + */ public function __construct( public mixed $element, public string $position = 'top-left', diff --git a/src/Modifiers/QuantizeColorsModifier.php b/src/Modifiers/QuantizeColorsModifier.php index 7845582a..226dd646 100644 --- a/src/Modifiers/QuantizeColorsModifier.php +++ b/src/Modifiers/QuantizeColorsModifier.php @@ -8,6 +8,13 @@ use Intervention\Image\Drivers\SpecializableModifier; class QuantizeColorsModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param int $limit + * @param mixed $background + * @return void + */ public function __construct( public int $limit, public mixed $background = 'ffffff' diff --git a/src/Modifiers/ResizeCanvasModifier.php b/src/Modifiers/ResizeCanvasModifier.php index 8fafbf92..67f041c9 100644 --- a/src/Modifiers/ResizeCanvasModifier.php +++ b/src/Modifiers/ResizeCanvasModifier.php @@ -12,6 +12,15 @@ use Intervention\Image\Interfaces\SizeInterface; class ResizeCanvasModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param null|int $width + * @param null|int $height + * @param mixed $background + * @param string $position + * @return void + */ public function __construct( public ?int $width = null, public ?int $height = null, diff --git a/src/Modifiers/ResizeModifier.php b/src/Modifiers/ResizeModifier.php index 51d3783c..d6ad6141 100644 --- a/src/Modifiers/ResizeModifier.php +++ b/src/Modifiers/ResizeModifier.php @@ -8,6 +8,13 @@ use Intervention\Image\Drivers\SpecializableModifier; class ResizeModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param null|int $width + * @param null|int $height + * @return void + */ public function __construct(public ?int $width = null, public ?int $height = null) { } diff --git a/src/Modifiers/ResolutionModifier.php b/src/Modifiers/ResolutionModifier.php index 49e5efd5..0eb4cc16 100644 --- a/src/Modifiers/ResolutionModifier.php +++ b/src/Modifiers/ResolutionModifier.php @@ -8,6 +8,13 @@ use Intervention\Image\Drivers\SpecializableModifier; class ResolutionModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param float $x + * @param float $y + * @return void + */ public function __construct(public float $x, public float $y) { } diff --git a/src/Modifiers/TextModifier.php b/src/Modifiers/TextModifier.php index 91a1c6b4..2c0d446b 100644 --- a/src/Modifiers/TextModifier.php +++ b/src/Modifiers/TextModifier.php @@ -14,6 +14,14 @@ use Intervention\Image\Interfaces\PointInterface; class TextModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param string $text + * @param PointInterface $position + * @param FontInterface $font + * @return void + */ public function __construct( public string $text, public PointInterface $position, diff --git a/src/Modifiers/TrimModifier.php b/src/Modifiers/TrimModifier.php index 89fa3992..18e55310 100644 --- a/src/Modifiers/TrimModifier.php +++ b/src/Modifiers/TrimModifier.php @@ -8,6 +8,12 @@ use Intervention\Image\Drivers\SpecializableModifier; class TrimModifier extends SpecializableModifier { + /** + * Create new modifier object + * + * @param int $tolerance + * @return void + */ public function __construct(public int $tolerance = 0) { } diff --git a/src/Typography/TextBlock.php b/src/Typography/TextBlock.php index d7f648dd..011b34e7 100644 --- a/src/Typography/TextBlock.php +++ b/src/Typography/TextBlock.php @@ -8,6 +8,12 @@ use Intervention\Image\Collection; class TextBlock extends Collection { + /** + * Create new text block object + * + * @param string $text + * @return void + */ public function __construct(string $text) { foreach (explode("\n", $text) as $line) {