imagecropauto

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

imagecropauto — Обрезает изображение автоматически на основе заданного режима

Описание

imagecropauto(
    GdImage $image,
    int $mode = IMG_CROP_DEFAULT,
    float $threshold = 0.5,
    int $color = -1
): GdImage|false

Автоматически обрезает изображение на основе заданного режима (mode).

Список параметров

image

Объект GdImage, который возвращает одна из функций, создающих изображения, например, imagecreatetruecolor().

mode

Одна из следующих констант:

IMG_CROP_DEFAULT: То же, что и IMG_CROP_TRANSPARENT. До PHP 7.4.0 встроенный модуль libgd выбирал режим IMG_CROP_SIDES, если у изображения не было прозрачного цвета.
IMG_CROP_TRANSPARENT: Обрезает прозрачный фон.
IMG_CROP_BLACK: Обрезает чёрный фон.
IMG_CROP_WHITE: Обрезает белый фон.
IMG_CROP_SIDES: Анализирует 4 угла изображения, чтобы попытаться обнаружить фон для обрезки.
IMG_CROP_THRESHOLD: Обрезает изображение, используя заданные threshold и color.

threshold

Определяет допуск в процентах, который будет использован при сравнении цвета изображения и цвета обрезки. Метод расчёта цветовой разницы основан на цветовом расстоянии в кубе RGB(a).

Учитывается только в режиме IMG_CROP_THRESHOLD.

Замечание: До PHP 7.4.0 в модуле libgd работал немного иной алгоритм, поэтому один и тот же порог threshold давал разные результаты для системного и встроенного модуля libgd.

color

Либо значение цвета RGB, либо индекс палитры.

Учитывается только в режиме IMG_CROP_THRESHOLD.

Возвращаемые значения

Возвращает объект обрезанного изображения в случае успешного выполнения или false в случае возникновения ошибки. Возвращает false также и тогда, когда всё изображение было обрезано.

Список изменений

Версия	Описание
8.0.0	`image` теперь ожидает экземпляр GdImage; ранее ожидался корректный `gd` ресурс (resource).
8.0.0	В случае успешного выполнения функция теперь возвращает объект GDImage; ранее возвращался ресурс (resource).
7.4.0	Поведение imagecropauto() в комплекте libgd синхронизировано с системным libgd: `IMG_CROP_DEFAULT` больше не использует `IMG_CROP_SIDES`, и для обрезки порога теперь используется тот же алгоритм, что и системным libgd.
7.4.0	Значение режима (`mode`) по умолчанию было изменено на `IMG_CROP_AUTO`. Ранее значением по умолчанию было `-1`, что соответствует `IMG_CROP_DEFAULT`, но передача `-1` теперь устарела.

Примеры

Пример #1 Правильная обработка автообрезки

Как отмечено в разделе возвращаемого значения, функция imagecropauto() возвращает false, если всё изображение было обрезано. В этом примере есть ресурс изображения $im, который должен быть автоматически обрезан, только если есть, что обрезать; иначе нужно перейти к исходному изображению.

<?php

$cropped = imagecropauto($im, IMG_CROP_DEFAULT);
if ($cropped !== false) { // в случае возврата нового объекта изображения
    imagedestroy($im);    // мы уничтожаем исходное изображение
    $im = $cropped;       // и назначаем обрезанное изображение в $im
}

?>

Смотрите также

imagecrop() - Обрезать изображение до заданного прямоугольника

add a note

User Contributed Notes 2 notes

down

raphael.deiana ¶

8 years ago


In some cases the use of the IMG_CROP_WHITE or IMG_CROP_BLACK does not work. The function returns FALSE. It is best to use the IMG_CROP_THRESHOLD mode and specify the color in fourth argument as in the example below :

<?php

$original_img = imagecreatefromjpeg($image_path);

// Use this :
$cropped_img_white = imagecropauto($original_img , IMG_CROP_THRESHOLD, null, 16777215);
// Rather than :
$cropped_img_white = imagecropauto($original_img , IMG_CROP_WHITE);

// AND

// Use this :
$cropped_img_black = imagecropauto($original_img , IMG_CROP_THRESHOLD, null, 0);
// Rather than :
$cropped_img_black = imagecropauto($original_img , IMG_CROP_BLACK);

?>

down

pj dot mueller at protonmail dot ch ¶

2 years ago


I don’t know why you can’t set the threshold for the four sides filter (IMG_CROP_SIDES) so here’s how to do it manually using the IMG_CROP_THRESHOLD filter instead.

$threshold = .5;

$im = imagecreatefromjpeg('somefile.jpg');

$width = imagesx($im);
$height = imagesy($im);

$arr = [
    [0,0],
    [$width-1,0],
    [0,$height-1],
    [$width-1,$height-1],
];

$red = 0;
$green = 0;
$blue = 0;

// grab the colours from all four corners
foreach( $arr as $arr2 ) {
    $thisColor = imagecolorat($im, $arr2[0], $arr2[1]); 

    $rgb = imagecolorsforindex($im, $thisColor); 
    $red += round(round(($rgb['red'] / 0x33)) * 0x33); 
    $green += round(round(($rgb['green'] / 0x33)) * 0x33); 
    $blue += round(round(($rgb['blue'] / 0x33)) * 0x33); 
}

// and average them
$red /= 4;
$green /= 4;
$blue /= 4;

$newColor = imagecolorallocate($im, $red, $green, $blue);            

$cropped = imagecropauto($im, IMG_CROP_THRESHOLD, $threshold, $newColor);

imagejpg($cropped, 'somefile.cropped.jpg');

imagedestroy($im);
imagedestroy($cropped);

add a note