someElement

Класс для работы с произвольными элементами

Переменные

Переменные отсутсвуют

Методы

void __call ()
void dropCache () Сбрасывает кеш информации о произвольных элементах
mixed getAfTitle ({ afName }) Возвращает наименование доп. поля произвольного элемента по его имени
int getAmount ({ someElementGroupId }) Возвращает кол-во произвольных элементов
mixed getDevName ({ [id] }) Возвращает имя для разработчика
mixed getId ({ [devName] }) Возвращает id произвольного элемента
mixed getImageSrc ({ [id], [type], [resizeType], [width], [height], [quality], [watermarkKey], [watermarkMargin] }) Возвращает путь к изображению произвольного элемента
mixed getList ({ someElementGroupId, [pageNumber], [amount], [orderType] }) Возвращает список произвольных элементов
object getNew () Возвращает новую копию обьекта
mixed getSomeElementGroupId ({ id }) Возвращает id группы произвольного элемента
mixed getTitle ({ [id] }) Возвращает наименование произвольного элемента
mixed init ({ id }) Инициализация класса
mixed isExist ({ [id], [devName] }) Проверяет существование произвольного элемента
mixed isExistAF ({ [fieldName] }) Проверяет существование дополнительного поля в произвольного элемента
mixed set ({ id, name, value }) Устанавливает значение

__call

Примеры кода




dropCache

Сбрасывает кеш информации о произвольных элементах

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

void

Примеры кода




getAfTitle

Синоним: afTitle
Возвращает наименование доп. поля произвольного элемента по его имени

Параметры

afName string Имя доп. поля произвольного элемента

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

string Наименование доп. поля произвольного элемента
bool False - в случае ошибки или если доп. поля произвольного элемента не существует

Примеры кода




getAmount

Синоним: amount
Возвращает кол-во произвольных элементов

Параметры

someElementGroupId int Id группы произвольных элементов

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

int Количество произвольных элементов в группе

Примеры кода




getDevName

Синоним: devName
Возвращает имя для разработчика

Параметры

[id] int Id произвольного элемента

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

string Имя для разработчика
bool False - в случае ошибки

Примеры кода




getId

Синоним: id
Возвращает id произвольного элемента

Параметры

[devName] string Имя для разработчика

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

int Id произвольного элемента
bool False - в случае ошибки

Примеры кода




getImageSrc

Синоним: imageSrc
Возвращает путь к изображению произвольного элемента

Параметры

[id] int Id произвольного элемента
[type] int Тип изображения. 0 - не изменять, 1 - gif, 2 - jpeg, 3 - png. По умолчанию: 0
[resizeType] int Тип изминения размера изображения. 0 - оригинальное изображение, 1 - умное кадирование, 2 - уменьшение с имзинением пропорций. По умолчанию: 2
[width] int Ширина изображзения в пикселях. По умолчанию: 400
[height] int Высота изображзения в пикселях. По умолчанию: 400
[quality] int Качество изображения. 1 - 9 - качество изображения. 0 - Качество не изменять. По умолчанию: 0
[watermarkKey] int Ключ, указывает что необходимо наложить водяной знак. 0 - неналаживать, 1 - налаживать. По умолчанию: 0
[watermarkMargin] int Отступ водяного знака от нижней границы изображения в процентах. По умолчанию: 30

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

string Путь к изображению произвольного элемента
bool False - в случае ошибки

Примеры кода




getList

Синоним: list
Возвращает список произвольных элементов

Параметры

someElementGroupId int Id группы произвольных элементов
[pageNumber] int Номер страницы. По умолчанию: 1
[amount] int Кол-во произвольных элементов на странице. По умолчанию: 0 (все произвольные элементы)
[orderType] string Метод сортировки. position, position desc, title, title desc. По умолчанию: position

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

array Массив обьектов someElement
bool False - в случае ошибки

Примеры кода




getNew

Синоним: new
Возвращает новую копию обьекта

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

object someElement

Примеры кода




getSomeElementGroupId

Синоним: someElementGroupId
Возвращает id группы произвольного элемента

Параметры

id int Id произвольного элемента

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

int Id группы произвольного элемента
bool False - в случае ошибки или

Примеры кода




getTitle

Синоним: title
Возвращает наименование произвольного элемента

Параметры

[id] int Id произвольного элемента

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

string Наименование произвольного элемента
bool False - в случае ошибки

Примеры кода




init

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

Параметры

id int Id произвольного элемента

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

bool True - обьект инициализирован
bool False - в случае ошибки

Примеры кода




isExist

Проверяет существование произвольного элемента

Параметры

[id] int Id произвольного элемента
[devName] string Имя для разработчика

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

bool True - если существует
bool False - если не существует или в случае ошибки

Примеры кода




isExistAF

Проверяет существование дополнительного поля в произвольного элемента

Параметры

[fieldName] string Наименование дополнительного поля в произвольного элемента

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

bool True - существует
bool False - не существует или в случае ошибки

Примеры кода




set

Устанавливает значение

Параметры

id int Id произвольного элемента
name string Имя дополнительного поля
value string Значение дополнительного поля

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

bool True - значение установленно
bool False - в случае ошибки

Примеры кода