Логотип

Документация по макросам и шаблонам UMI.CMS

system makeThumbnailFull()

Название

%system makeThumbnailFull()% — Создает и выводит уменьшенное изображение (миниатюру) указанной картинки с возможностью обрезки.

Параметры: system makeThumbnailFull(path, width, height [, template = 'default', returnArrayOnly = '0', crop = '1', cropside = '5', isLogo = 0, quality = '80'])

path

Путь к изображению-оригиналу.

width

Ширина миниатюры в пикселях (можно указать значение «auto»).

height

Высота миниатюры в пикселях (можно указать значение «auto»).

template

Имя шаблона, по которому следует выводить миниатюру.В XSLT-шаблонизаторе игнорируется.

returnArrayOnly

Используется для внутренних целей.

crop

Обрезать или не обрезать миниатюру.

cropside

Указывает положение рамки обрезания.

isLogo

Указывает необходимость наложения водяного знака на изображение.

quality

Указывает степень сжатия (качество) изображения.

Описание

Макрос выводит миниатюру изображения, путь к которому указывается в параметре path.

С версии 2.12 макрос умеет генерировать миниатюры с помощью библиотеки ImageMagick, если она установлена на сервер. При использовании ImageMagick макрос становится более производительным.

Размер миниатюры можно задать, используя параметры width и height. Размеры задаются в пикселях, любой из этих параметров может принимать значение «auto», в этом случае высота или ширина миниатюры устанавливается пропорционально другому параметру.

Если параметр crop = '1', то изображение не будет искажено, а произойдет обрезка по соответствующим краям, определямым параметром cropside и ориентацией изображения (горизонтальные или вертикальные).

Таблица 1. Возможные значения cropside

1 — верхний левый угол: миниатюра может быть обрезана справа и снизу;

2 — верхний край посередине: миниатюра может быть обрезана справа, слева и снизу;

3 — верхний правый угол: миниатюра может быть обрезана слева и снизу;

и так далее.

Значение по умолчанию (5) отмечено серым цветом.

Необходимость наложения водяного знака можно задать через параметр isLogo. Параметры наложения задаются в модуле "Конфигурация".

Качество сжатия миниатюры можно задать через параметр quality. Рекомендуется передавать ему значение от 1 до 100 (чем большее значение передано - тем выше качество изображения).

$image = $this->macros('system', 'makeThumbnailFull', array('path' => '.' . $variables['src'], 'width' => $variables['width'], 'height' => $variables['height']))

Пример вызова

udata://system/makeThumbnailFull/(./images/item1.jpg)/100/100/notemplate/0/1

XML-ответ UData

<udata module="system" method="makeThumbnailFull" generation-time="0.072575">
  <size>3348</size>
  <filename>59d7162eb99be87b9227e881bfb950eb.jpg</filename>
  <filepath>
   ./images/cms/thumbs/59d7162eb99be87b9227e881bfb950eb.jpg
  </filepath>
  <src>
   /images/cms/thumbs/59d7162eb99be87b9227e881bfb950eb.jpg
  </src>
  <ext>jpg</ext>
  <width>100</width>
  <height>100</height>
</udata>

Элементы и атрибуты

<size>

Размер миниатюры в байтах.

<filename>

Имя файла.

<filepath>

Путь к файлу в файловой системе (относительно DOCUMENT_ROOT).

<src>

Путь к файлу относительно корня сайта.

<ext>

Расширение полученного файла миниатюры.

<width>

Ширина полученной миниатюры в пикселях.

<height>

Высота полученной миниатюры в пикселях.

Вывод изображения осуществляется по шаблону, указанному в параметре template. Вы можете не указывать этот параметр, в этом случае для вывода свойства будет использован шаблон по умолчанию — default.tpl.

Используемые шаблоны

Макрос оперирует шаблонами, находящимися в каталоге /tpls/thumbs/.

Используемые блоки шаблона

image

Выводит миниатюру.

%size%

Вес картинки (в байтах).

%filename%

Имя файла миниатюры.

%filepath%

Серверный путь к файлу миниатюры.

%src%

Http — путь к файлу миниатюры.

%ext%

Расширение файла миниатюры.

%width%

Ширина миниатюры (px).

%height%

Высота миниатюры (px).

%template%

Имя шаблона вывода миниатюры.

Примеры использования

См. %system makeThumbnail()%