File size: 2.62Kb
<?php
declare(strict_types=1);
namespace Intervention\Image\Interfaces;
use Intervention\Image\Exceptions\GeometryException;
interface SizeInterface
{
/**
* Get width
*/
public function width(): int;
/**
* Get height
*/
public function height(): int;
/**
* Get pivot point
*/
public function pivot(): PointInterface;
/**
* Set width
*/
public function setWidth(int $width): self;
/**
* Set height
*/
public function setHeight(int $height): self;
/**
* Set pivot point
*/
public function setPivot(PointInterface $pivot): self;
/**
* Calculate aspect ratio of the current size
*/
public function aspectRatio(): float;
/**
* Determine if current size fits into given size
*/
public function fitsInto(self $size): bool;
/**
* Determine if size is in landscape format
*/
public function isLandscape(): bool;
/**
* Determine if size is in portrait format
*/
public function isPortrait(): bool;
/**
* Move pivot to given position in size
*/
public function movePivot(string $position, int $offset_x = 0, int $offset_y = 0): self;
/**
* Align pivot of current object to given position
*/
public function alignPivotTo(self $size, string $position): self;
/**
* Calculate the relative position to another Size
* based on the pivot point settings of both sizes.
*/
public function relativePositionTo(self $size): PointInterface;
/**
* @see ImageInterface::resize()
*
* @throws GeometryException
*/
public function resize(?int $width = null, ?int $height = null): self;
/**
* @see ImageInterface::resizeDown()
*
* @throws GeometryException
*/
public function resizeDown(?int $width = null, ?int $height = null): self;
/**
* @see ImageInterface::scale()
*
* @throws GeometryException
*/
public function scale(?int $width = null, ?int $height = null): self;
/**
* @see ImageInterface::scaleDown()
*
* @throws GeometryException
*/
public function scaleDown(?int $width = null, ?int $height = null): self;
/**
* @see ImageInterface::cover()
*
* @throws GeometryException
*/
public function cover(int $width, int $height): self;
/**
* @see ImageInterface::contain()
*
* @throws GeometryException
*/
public function contain(int $width, int $height): self;
/**
* @throws GeometryException
*/
public function containMax(int $width, int $height): self;
}