imgs

Small image scaler and cropper with simple caching for PHP

Setup

Copy src/imgs.php a static location on your webserver and include the file. Use the namespace semmelsamu:

include("imgs.php");
use \semmelsamu\Imgs;

Imgs

new Imgs($auto, $cache, $cache_expires, $max_size) : void

Create a new Imagescaler.

Parameters

• $auto
  • States if the scaler yould automatically scale and output your image with arguments passed via GET in the URL see here and deletes expired cached images.
  • Type: bool
  • Default: true
• $cache
  • The folder where already scaled images should be cached. If set to false, scaled images will not be cached.
  • Type: bool|string
  • Default: cache/
• $cache_expires
  • The expiration time for every cached element.
  • Type: int
  • Default: 86400 (= 1 day)
• $max_size
  • The maximum size of an image's edge. If set to false, images don't have a maximum size (not recommended).
  • Type: bool|int
  • Default: 2000

image

Imgs::image($path, $top, $right, $bottom, $left, $size, $width, $height, $format, $quality) : bool

Output an image. Every parameter is optional.

Parameters

• $path
  • The path/filename of the image, e.g. path/to/your/image.jpg. If set to true, the path will be taken from the request uri.
  • Type: string|bool
• $top, $right, $bottom and $left
  • The amount of pixels cropped into the image from the top, right, bottom and left before the image is scaled.
  • Type: int
  • Default: 0
• $min_size
  • The size of the smallest side of the image. If specified, $width and $height will be ignored.
  • Type: int
• $width and $height
  • The width and height of the scaled image. If source and destination aspect ratios don't match, the image will be cropped. If only one is given, the other will be automatically calculated.
  • Type: int
• $format
  • The image type.
  • Type: "jpg"|"png"|"webp"
• $quality
  • The quality of the image. For more information, see in the PHP manual for JPGs, PNGs and WEBPs respectively.
  • Type: int
  • Default: -1

empty_cache

Imgs::empty_cache() : void

Deletes every cached element older than $cache_expires seconds. By default the expiration time is set to 1 day.

Auto scaling

If $auto is set to true, images will be automatically scaled via GET-parameters in the URL:

www.url.to/your/image.jpg?w=500

will produce an image with a width of 500 pixels.

Parameter	Abbreviation in GET
$top	t
$right	r
$bottom	b
$left	l
$width	w
$height	h
$format	f
$quality	q