Класс обработки изображений

Класс обработки изображений CodeIgniter позволяет выполнять следующие действия:

• Изменение размера изображения
• Создание миниатюр
• Обрезка изображения
• Поворот изображения
• Наложение водяного знака на изображение

Поддерживаются все три основные библиотеки обработки изображений: GD/GD2, NetPBM и ImageMagick

• Инициализация класса
  • Обработка изображения
  • Методы обработки
  • Параметры
  • Установка параметров в файле конфигурации
• Наложение водяного знака на изображение
  • Два типа водяных знаков
  • Наложение водяного знака на изображение
  • Параметры водяного знака
    • Параметры текста
    • Параметры наложения
• Справочник по классу

Инициализация класса

Как и большинство других классов в CodeIgniter, класс обработки изображений инициализируется в вашем контроллере с помощью функции $this->load->library:

$this->load->library('image_lib');

После загрузки библиотеки она будет готова к использованию. Объект библиотеки обработки изображений, который вы будете использовать для вызова всех функций: $this->image_lib

Обработка изображения

Независимо от типа обработки, которую вы хотите выполнить (изменение размера, обрезка, поворот или наложение водяного знака), общий процесс идентичен. Вы зададите некоторые параметры, соответствующие выполняемому действию, затем вызовете одну из четырех доступных функций обработки. Например, чтобы создать миниатюру изображения, сделайте следующее:

$config['image_library'] = 'gd2';
$config['source_image'] = '/path/to/image/mypic.jpg';
$config['create_thumb'] = TRUE;
$config['maintain_ratio'] = TRUE;
$config['width']         = 75;
$config['height']       = 50;

$this->load->library('image_lib', $config);

$this->image_lib->resize();

Вышеприведенный код сообщает функции image_resize, что нужно найти изображение под названием mypic.jpg, расположенное в папке source_image, затем создать миниатюру размером 75 x 50 пикселей с использованием библиотеки изображений GD2. Поскольку параметр maintain_ratio включён, миниатюра будет как можно ближе к целевым ширине и высоте, сохраняя при этом исходное соотношение сторон. Миниатюра будет называться mypic_thumb.jpg и будет расположена на том же уровне, что и source_image.

Методы обработки

Доступны четыре метода обработки:

• $this->image_lib->resize()
• $this->image_lib->crop()
• $this->image_lib->rotate()
• $this->image_lib->watermark()

Эти методы возвращают булево значение TRUE при успехе и FALSE при ошибке. Если произошла ошибка, вы можете получить сообщение об ошибке с помощью этой функции:

echo $this->image_lib->display_errors();

Хорошей практикой является использование условной функции обработки, отображающей ошибку при возникновении ошибки, как это показано ниже:

if ( ! $this->image_lib->resize())
{
        echo $this->image_lib->display_errors();
}

$this->image_lib->display_errors('<p>', '</p>');

Параметры обработки

Ниже описаны параметры, которые позволяют настроить обработку изображений в соответствии с вашими потребностями.

Обратите внимание, что не все параметры доступны для каждой функции. Например, параметры оси X/Y доступны только для обрезки изображения. Аналогично, параметры ширины и высоты не влияют на обрезку. Столбец «Доступность» указывает, какие функции поддерживают данный параметр.

Легенда доступности:

• R — Изменение размера изображения
• C — Обрезка изображения
• X — Поворот изображения
• W — Наложение водяного знака

Установка параметров в файле конфигурации

Если вы предпочитаете не устанавливать параметры вышеописанным способом, вы можете вместо этого поместить их в файл конфигурации. Просто создайте новый файл с именем image_lib.php, добавьте массив $config в этот файл. Затем сохраните файл в config/image_lib.php, и он будет использоваться автоматически. Вам НЕ нужно будет использовать метод $this->image_lib->initialize() если вы сохраните свои параметры в файле конфигурации.

Наложение водяного знака на изображение

Функция наложения водяного знака требует библиотеки GD/GD2.

Два типа водяных знаков

Существует два типа водяных знаков, которые вы можете использовать:

• Текст: сообщение водяного знака будет сгенерировано с помощью текста, либо с помощью шрифта True Type, который вы указываете, либо с помощью родной функции вывода текста, поддерживаемой библиотекой GD. Если вы используете версию True Type, ваша установка GD должна быть скомпилирована с поддержкой True Type (у большинства так, но не у всех).
• Наложение: сообщение водяного знака будет сгенерировано путём наложения изображения (обычно прозрачного PNG или GIF), содержащего ваш водяной знак, на исходное изображение.

Наложение водяного знака на изображение

Как и в других методах (изменение размера, обрезка и поворот), общий процесс наложения водяного знака включает в себя установку параметров, соответствующих выполняемому действию, затем вызов функции watermark. Вот пример:

$config['source_image'] = '/path/to/image/mypic.jpg';
$config['wm_text'] = 'Copyright 2006 - John Doe';
$config['wm_type'] = 'text';
$config['wm_font_path'] = './system/fonts/texb.ttf';
$config['wm_font_size'] = '16';
$config['wm_font_color'] = 'ffffff';
$config['wm_vrt_alignment'] = 'bottom';
$config['wm_hor_alignment'] = 'center';
$config['wm_padding'] = '20';

$this->image_lib->initialize($config);

$this->image_lib->watermark();

В приведенном выше примере будет использоваться шрифт True Type размером 16 пикселей для создания текста «Copyright 2006 — John Doe». Водяной знак будет расположен в нижней центральной части изображения, на расстоянии 20 пикселей от нижней границы изображения.

Параметры водяного знака

В этой таблице показаны параметры, доступные для обоих типов водяных знаков (текст или наложение)

Настройки текста

В этой таблице показаны доступные настройки для водяного знака типа текст.

Настройки наложения

В этой таблице показаны доступные настройки для наложения водяного знака.

Справочник по классам

class CI_Image_lib

initialize([$props = array()])

Параметры:	$props (array) – Предпочтения обработки изображений
Возвращаемое значение:	TRUE при успехе, FALSE в случае некорректных настроек
Тип возвращаемого значения:	bool

Инициализирует класс для обработки изображения.

resize()

Возвращаемое значение:	TRUE при успехе, FALSE при ошибке
Тип возвращаемого значения:	bool

Метод изменения размера позволяет изменить размер исходного изображения, создать копию (с изменением размера или без него) или создать миниатюру.

Практически нет разницы между созданием копии и созданием миниатюры, за исключением того, что миниатюра будет иметь маркер миниатюры в имени (например, mypic_thumb.jpg).

Все предпочтения, перечисленные в таблице Настройки, доступны для этого метода, за исключением следующих трех: rotation_angle, x_axis и y_axis.

Создание миниатюры

Метод изменения размера создаст файл миниатюры (и сохранит оригинал), если вы установите это значение в TRUE:

$config['create_thumb'] = TRUE;

Это единственное предпочтение, определяющее, создаётся ли миниатюра или нет.

Создание копии

Метод изменения размера создаст копию файла изображения (и сохранит оригинал), если вы установите путь и/или новое имя файла с помощью этого предпочтения:

$config['new_image'] = '/path/to/new_image.jpg';

Примечания по этому предпочтению:

• Если указано только новое имя изображения, оно будет размещено в той же папке, что и оригинал.
• Если указан только путь, новое изображение будет размещено в указанном месте с тем же именем, что и оригинал.
• Если указаны и путь, и имя изображения, оно будет размещено в собственном месте назначения и получит новое имя.

Изменение размера исходного изображения

Если ни одно из двух перечисленных выше предпочтений (create_thumb и new_image) не используется, метод изменения размера вместо этого обработает исходное изображение.

crop()

Возвращаемое значение:	TRUE при успехе, FALSE при ошибке
Тип возвращаемого значения:	bool

Метод обрезки работает почти так же, как функция изменения размера, за исключением того, что требует установки настроек для осей X и Y (в пикселях), определяющих, где обрезать изображение, например так:

$config['x_axis'] = 100;
$config['y_axis'] = 40;

Все предпочтения, перечисленные в таблице Настройки, доступны для этого метода, за исключением этих: rotation_angle, create_thumb и new_image.

Вот пример того, как можно обрезать изображение:

$config['image_library'] = 'imagemagick';
$config['library_path'] = '/usr/X11R6/bin/';
$config['source_image'] = '/path/to/image/mypic.jpg';
$config['x_axis'] = 100;
$config['y_axis'] = 60;

$this->image_lib->initialize($config);

if ( ! $this->image_lib->crop())
{
        echo $this->image_lib->display_errors();
}

Примечание

Без визуального интерфейса трудно обрезать изображения, поэтому этот метод не очень полезен, если вы не собираетесь создавать такой интерфейс. Именно это мы и сделали, используя модуль галереи фотографий в ExpressionEngine, CMS, который мы разрабатываем. Мы добавили JavaScript-интерфейс, который позволяет выбирать область обрезки.

rotate()

Возвращаемое значение:	TRUE при успехе, FALSE при ошибке
Тип возвращаемого значения:	bool

Метод поворота изображения требует, чтобы угол поворота был задан через своё предпочтение:

$config['rotation_angle'] = '90';

Есть 5 вариантов поворота:

1. 90 - поворот против часовой стрелки на 90 градусов.
2. 180 - поворот против часовой стрелки на 180 градусов.
3. 270 - поворот против часовой стрелки на 270 градусов.
4. hor - горизонтальное отражение изображения.
5. vrt - вертикальное отражение изображения.

Вот пример того, как можно повернуть изображение:

$config['image_library'] = 'netpbm';
$config['library_path'] = '/usr/bin/';
$config['source_image'] = '/path/to/image/mypic.jpg';
$config['rotation_angle'] = 'hor';

$this->image_lib->initialize($config);

if ( ! $this->image_lib->rotate())
{
        echo $this->image_lib->display_errors();
}

watermark()

Возвращаемое значение:	TRUE при успехе, FALSE при ошибке
Тип возвращаемого значения:	bool

Создаёт водяной знак на изображении, для получения более подробной информации см. раздел Добавление водяного знака на изображение.

clear()

Тип возвращаемого значения:	void

Метод clear сбрасывает все значения, используемые при обработке изображения. Его необходимо вызывать, если вы обрабатываете изображения в цикле.

$this->image_lib->clear();

display_errors([$open = '<p>[, $close = '</p>']])

Параметры:	$open (string) – Открывающий тег сообщения об ошибке $close (string) – Закрывающий тег сообщения об ошибке
Возвращаемое значение:	Сообщения об ошибках
Тип возвращаемого значения:	string

Возвращает все обнаруженные ошибки, отформатированные как строка.

echo $this->image_lib->display_errors();