Opt

class View.Representation.Attributes.Attribute.Opt

Группа дополнительных свойств.

Added in version 1.29.0-ms1: Добавлены свойства Opt.hrefFieldName, Opt.nvlBlobName и Opt.brokenLinkEqNull, задающие вывод изображений из файлового хранилища сервера

Атрибуты:

attr helpText → String

Текст справки

attr attrType → View.Representation.Attributes.Attribute.Opt.AttributeTypes

Тип атрибута.

attr hrefFieldName → String

Имя атрибута выборки, в котором лежит путь к изображению из файлового хранилища сервера.

Правила:

  • Указываемый атрибут должен существовать в выборке. Пример: Opt.hrefFieldName:photo_path, если есть атрибут с именем photo_path.

  • Свойство Opt.addAttrType указываемого атрибута должно иметь значение AttributeTypes.Standard.

  • Самоссылка запрещена. Пример запрещённой настройки: атрибут с именем image в свойстве Opt.hrefFieldName указывает на атрибут с именем image.

  • Регистр имени атрибута не важен.

Правила значения, которое хранится в указываемом атрибуте:

  • Пустое значение (null или пустая строка) означает отсутствие пути.

  • Запрещаются значения заглушки вроде "-".

  • Непустое значение должно быть абсолютным путём относительно файлового хранилища сервера:

    • Пример для Linux - /mnt/share/images/*.png.

    • Пример для Windows - C:/Global3/images/*.png, C:\\Global3\\images\\*.png.

  • Позволяется использовать UNC-пути (//SharedPC/images/*.png) для доступа к файлам, если сервер располагается в Windows.

  • Путь должен быть записан в формате файловой системы сервера: /mnt/share/images/*.png для сервера на Linux; C:/Global3/images/*.png или //SharedPC/images/*.png (UNC-путь) для сервера на Windows.

  • Расширение конечного файла должно быть поддерживаемым.

  • Путь к конечному файлу должен попадать в Whitelist.

  • Конечный файл должен существовать, быть обычным файлом и не проходить через symbolic link, reparse-point, FIFO, device или другой нестандартный объект файловой системы.

  • Содержимое файла должно соответствовать расширению по сигнатуре: например, файл не-изображение с расширением .png будет отклонён.

  • На Windows двоеточие допускается только после буквы диска. Пример: C:/Global3/images/1.png.

Added in version 1.29.0-ms1.

attr nvlBlobName → String

Имя атрибута выборки с типом AttributeTypes.HrefBlob, который ссылается на запасное изображение.

Запасное изображение используется, если изображение из атрибута Opt.hrefFieldName отсутствует. Также оно используется, если изображение не удалось загрузить, но только когда Opt.brokenLinkEqNull равен true.

Данное свойство можно не задавать: это означает, что текущий атрибут является последним звеном цепочки изображений.

Правила:

  • Указываемый атрибут должен существовать в выборке. Пример: Opt.nvlBlobName:alt_image, если есть атрибут с именем alt_image.

  • Свойство Opt.addAttrType указываемого атрибута должно иметь значение AttributeTypes.HrefBlob.

  • Цепочка не должна содержать циклов. Пример цикла: атрибут с именем image указывает на alt_image, а alt_image указывает на image.

  • Регистр имени атрибута не важен.

Added in version 1.29.0-ms1.

attr brokenLinkEqNull → Boolean

Признак того, что “битую” ссылку, взятую из значения атрибута, указанного в Opt.hrefFieldName, нужно считать пустым значением.

“Битой” считается ссылка, у которой значение атрибута Opt.hrefFieldName непустое, но изображение не загрузилось.

Поведение:

  • Opt.brokenLinkEqNull:false предотвращает попытку загрузки изображения из атрибута, указанного в Opt.nvlBlobName (если есть), и показывает ошибку.

  • Opt.brokenLinkEqNull:true приравнивает битую ссылку к пустому значению, пытается загрузить изображение из атрибута, указанного в Opt.nvlBlobName; если в Opt.nvlBlobName не указано никакого атрибута, то не будет выводиться ничего.

Значение по умолчанию: false

Added in version 1.29.0-ms1.