Модуль images
Документация TextCMS » API ядра TextCMS и вызываемых модулей » Модуль images
Функции | |
images_load ($filename) | |
images_resize ($imgdata, $newx, $newy) | |
images_fit_to ($imgdata, $newx, $newy) | |
images_save ($image, $filename=false, $options=NULL) | |
images_save_fit_to ($imgdata, $width, $height, $filename, $type, $options=NULL) | |
images_get_extension ($type) | |
Функции
images_fit_to | ( | $imgdata, | |
$newx, | |||
$newy | |||
) |
Пропорциональное уменьшение размеров изображения для того, чтобы вписать его в прямоугольник заданных размеров (то есть размеры изображения будут меньше или равны указанным)
- Аргументы
$imgdata array Хеш-массив с данными изображения, полученный с помощью функции images_load. $newx integer Максимальная ширина нового изображения. Если равна false, то считается, что ограничений по ширине нет, и ширина подбирается так, чтобы обеспечить пропорциональное изменение размеров изображения до необходимой высоты. $newy integer Максимальная высота нового изображения. Если равна false, то считается, что ограничений по высоте нет, и высота подбирается так, чтобы обеспечить пропорциональное изменение размеров изображения до необходимой ширины. Параметры $newx и $newy не могут быть равны false одновременно.
- Возвращает
- array Хеш-массив с данными нового изображения, формат аналогичен тому, который получается с помощью функции images_load.
- См. также
- images_load
images_get_extension | ( | $type | ) |
Получение расширения файла по его типу.
- Аргументы
$type ineger Код типа файла (одна из констант: IMAGETYPE_JPEG, IMAGETYPE_PNG, IMAGETYPE_GIF, IMAGETYPE_BMP)
- Возвращает
- string Расширение для файла (без точки), строчными буквами.
images_load | ( | $filename | ) |
Загрузка изображения в память. Поддерживаются форматы JPEG, PNG, GIF, BMP. Определяются его тип и размеры, затем создается ресурс с самим изображением.
- Аргументы
string $filename Имя файла с изображением (абсолютное или относительно текущего каталога).
- Возвращает
- array Хеш-массив с данными об изображении. Содержит следующие ключи:
- width – ширина изображения в пикселях
- height – высота изображения в пикселях
- type – код типа изображения (может быть одной из констант: IMAGETYPE_JPEG, IMAGETYPE_PNG, IMAGETYPE_GIF, IMAGETYPE_BMP)
- filename – имя файла, из которого было загружено изображение (используется функцией save)
- resource – ресурс для работы с изображением с помощью функций модуля GD. Если файл не является изображением, функция возвращает false.
images_resize | ( | $imgdata, | |
$newx, | |||
$newy | |||
) |
Копирование текущего изображения в новое с изменением размеров.
- Аргументы
$imgdata array Хеш-массив с данными изображения, полученный с помощью функции images_load. $newx integer Ширина нового изображения $newy integer Высота нового изображения
- Возвращает
- array Хеш-массив с данными нового изображения, формат аналогичен тому, который получается с помощью функции images_load.
- См. также
- images_load
images_save | ( | $image, | |
$filename = false , | |||
$options = NULL | |||
) |
Сохранение изображения в файл.
- Аргументы
$image array. Хеш-массив с данными изображения. Формат сохраняемого файла определяется значением, указанным в ключе type. $filename string. Имя файла, в который нужно сохранить изображение. Если равно false, то имя берется из ключа filename в хеш-массиве с данными изображения. $options mixed. Опции для сохранения файла. Зависят от формата: для JPEG указывается качество (от 0 до 100), для PNG – степень сжатия (от 1 до 9).
- Возвращает
- boolean Результат сохранения: true – сохранение успешно, false – возникли ошибки.
images_save_fit_to | ( | $imgdata, | |
$width, | |||
$height, | |||
$filename, | |||
$type, | |||
$options = NULL | |||
) |
Сохраняет изображение с вписыванием в заданные размеры, если это необходимо. Если изображение изначально меньше заданных размеров, то оно просто копируется выполнения каких-либо преобразований.
- Аргументы
array $imgdata Данные об изображении, полученные с помощью load integer $width Максимальная ширина изображения. Если false – нет ограничений. integer $height Максимальная высота изображения. Если false – нет ограничений. string $filename Имя файла, в который следует сохранить изображение. Можно передавать временное имя загруженного через форму файла, в этом случае он будет перенесен с помощью функции move_uploaded_file. integer $type Тип изображения в виде констант IMAGETYPE_*. mixed $options Опции для сохранения (для JPEG – качество, для PNG – уровень компрессии).
- Возвращает
- boolean Результат операции (true – файл сохранен).
Документация TextCMS » API ядра TextCMS и вызываемых модулей » Модуль images