- Notifications
You must be signed in to change notification settings - Fork3
An image tile generator for PHP 7.4+
License
NotificationsYou must be signed in to change notification settings
chillerlan/php-imagetiler
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A script for PHP 7.4+ to cut images (maps) into pieces (tiles). Based on themap tiler script by Fedik.This script will keep the proportions of the input image and generate only necessary tiles - no need for square input files!
- PHP 7.4+
- theImageMagick extension
- a crapload of RAM, CPU power and free disk space
- image optimization utilities (optional), seepsliwa/image-optimizer
requirescomposer
composer.json (note: replacedev-main with a version boundary)
{"require": {"php":"^7.4 || ^8.0","ext-imagick":"*","chillerlan/php-imagetiler":"dev-main"}}Profit!
Use theexample for live testing.
// invoke an options instance$options =newImagetilerOptions(['zoom_min' =>0,'zoom_max' =>8,'zoom_normalize' =>6,'fill_color' =>'transparent','fast_resize' =>true,'optimize_output' =>true,// ... whatever you need]);// see https://github.com/psliwa/image-optimizer#configuration$optimizer = (newOptimizerFactory([]))->get();// invoke and run the tiler$tiler =newImagetiler($options,$optimizer);$tiler->process('/path/to/image.png','/path/to/output/');
That's it!
If you're running into issues with ImageMagick complaining about not enough space on the cache path, you might want to check thepolicy.xml in the ImageMagick installation path (on Windows).For your consideration: an image of 49152x49152 will generate a cache file of ~28.5GB,
| method | return | description |
|---|---|---|
__construct(ContainerInterface $options = null, LoggerInterface $logger = null) | - | seeSettingsContainerInterface andLoggerInterface. Invokes an emptyImagetilerOptions object and aPsr\NullLogger if the respective parameters aren't set. |
setOptions(ContainerInterface $options) | Imagetiler | set options on-the-fly, called internally by the constructor |
setOptimizer(Optimizer $optimizer) | Imagetiler | set an optimizer instance on-the-fly, called internally by the constructor |
process(string $image_path, string $out_path) | Imagetiler | processes the given image from$image_path and dumps the output to$out_path |
| property | type | default | allowed | description |
|---|---|---|---|---|
$tile_size | int | 256 | positive int | width/height of a single tile |
$zoom_min | int | 0 | positive int | minimum zoom level |
$zoom_max | int | 8 | positive int | maximum zoom level |
$zoom_normalize | int | null | positive int | this zoom level represents the size of the original image. zoom levels higher than this will be upscaled, which may take some time and resources depending on the size of the input image. |
$tms | bool | false | * | if set to true - the origin will be set to bottom left, +y upwards, according toTile Map Service Specification, otherwise the origin is on the top left, +y downwards, like described by theGoogle Maps specification |
$fill_color | string | '#000000' | * | the fill color for leftover space, can be transparent for png |
$memory_limit | string | '-1' | * | seephp.ini settings |
$store_structure | string | '%1$d/%2$d/%3$d' | * | storage structure - can be anything. %1$d = zoom, %2$d = x, %3$d = y. seesprintf() |
$fast_resize_upsample | bool | false | * | determines whether to use fastImagick::scaleImage() (true) or slowImagick::resizeImage() (false) |
$resize_filter_upsample | int | Imagick::FILTER_ROBIDOUXSHARP | Imagick::FILTER_* | seeImagick::resizeImage() andImagick filter constants |
$resize_blur_upsample | float | 1.0 | positive float | seeImagick::resizeImage() |
$fast_resize_downsample | bool | false | * | see$fast_resize_upsample |
$resize_filter_downsample | int | Imagick::FILTER_LANCZOSRADIUS | Imagick::FILTER_* | see$resize_filter_upsample |
$resize_blur_downsample | float | 1.0 | positive float | see$resize_blur_upsample |
$tile_format | string | 'png' | png, jpg | seeImagick formats |
$tile_ext | string | null | * | tile image extension - autodetected from format if none given. |
$quality_jpeg | int | 80 | 0-100 | quality of the saved image in jpeg format |
$imagick_tmp | string | null | * | ImageMagick tmp folder |
$overwrite_base_image | bool | false | * | |
$overwrite_tile_image | bool | false | * | |
$clean_up | bool | true | * | whether or not to delete temp images |
$optimize_output | bool | false | * | enable image optimization (requiresOptimizer instance) |
$no_temp_baseimages | bool | false | * | whether or not to create and save temporary base images (may save resources) |
About
An image tile generator for PHP 7.4+
