1
0
mirror of https://github.com/Intervention/image.git synced 2025-08-31 01:29:51 +02:00

Rename parameter

This commit is contained in:
Oliver Vogel
2023-09-29 16:14:11 +02:00
parent d7fd99e4ab
commit 834d5cb2ba
3 changed files with 46 additions and 5 deletions

View File

@@ -44,9 +44,9 @@ class Image extends AbstractImage implements ImageInterface, IteratorAggregate
return $this; return $this;
} }
public function getFrame(int $key = 0): ?FrameInterface public function getFrame(int $position = 0): ?FrameInterface
{ {
return $this->frames->get($key); return $this->frames->get($position);
} }
public function addFrame(FrameInterface $frame): ImageInterface public function addFrame(FrameInterface $frame): ImageInterface

View File

@@ -24,10 +24,10 @@ class Image extends AbstractImage implements ImageInterface, Iterator
return $this->imagick; return $this->imagick;
} }
public function getFrame(int $key = 0): ?FrameInterface public function getFrame(int $position = 0): ?FrameInterface
{ {
try { try {
$this->imagick->setIteratorIndex($key); $this->imagick->setIteratorIndex($position);
} catch (ImagickException $e) { } catch (ImagickException $e) {
return null; return null;
} }

View File

@@ -8,18 +8,59 @@ use Traversable;
interface ImageInterface extends Traversable, Countable interface ImageInterface extends Traversable, Countable
{ {
public function getFrame(int $key = 0): ?FrameInterface; /**
* Get frame of animation image at given position starting with zero
*
* @param int $key
* @return null|FrameInterface
*/
public function getFrame(int $position = 0): ?FrameInterface;
public function addFrame(FrameInterface $frame): ImageInterface; public function addFrame(FrameInterface $frame): ImageInterface;
public function setLoops(int $count): ImageInterface; public function setLoops(int $count): ImageInterface;
public function getLoops(): int; public function getLoops(): int;
public function getSize(): SizeInterface; public function getSize(): SizeInterface;
public function isAnimated(): bool; public function isAnimated(): bool;
public function modify(ModifierInterface $modifier): ImageInterface; public function modify(ModifierInterface $modifier): ImageInterface;
/**
* Encode image with given encoder
*
* @param EncoderInterface $encoder
* @return EncodedImage
*/
public function encode(EncoderInterface $encoder): EncodedImage; public function encode(EncoderInterface $encoder): EncodedImage;
/**
* Encode image to jpeg format
*
* @param int $quality
* @return EncodedImage
*/
public function toJpeg(int $quality = 75): EncodedImage; public function toJpeg(int $quality = 75): EncodedImage;
/**
* Encode image to webp format
*
* @param int $quality
* @return EncodedImage
*/
public function toWebp(int $quality = 75): EncodedImage; public function toWebp(int $quality = 75): EncodedImage;
/**
* Encode image to gif format
*
* @return EncodedImage
*/
public function toGif(): EncodedImage; public function toGif(): EncodedImage;
/**
* Encode image to png format
*
* @return EncodedImage
*/
public function toPng(): EncodedImage; public function toPng(): EncodedImage;
public function pickColors(int $x, int $y): CollectionInterface; public function pickColors(int $x, int $y): CollectionInterface;
public function text(string $text, int $x, int $y, ?callable $init = null): ImageInterface; public function text(string $text, int $x, int $y, ?callable $init = null): ImageInterface;
public function pickColor(int $x, int $y, int $frame_key = 0): ?ColorInterface; public function pickColor(int $x, int $y, int $frame_key = 0): ?ColorInterface;