catalog

Класс для работы с каталогами товаров

Переменные

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

Методы

void __call ()
mixed addView ({ [id] }) Добавляет просмотр каталога товаров
void dropCache () Сбрасывает кеш информации о каталогах
mixed getAfTitle ({ afName }) Возвращает наименование доп. поля каталога по его имени
mixed getAltTitle ({ [id] }) Возвращает aльтернативное имя каталога товаров
int getAmount ({ [id], [brandId], [brandSeriesId], [searchStringInter], [searchStringUnion] }) Возвращает количество каталогов товаров
mixed getAsId ({ [id] }) Возвращает ИД в системе бухгалтерского учета
mixed getIcoImageSrc ({ [id], [type], [resizeType], [width], [height], [quality], [watermarkKey], [watermarkMargin] }) Возвращает путь к изображению иконки каталога товаров
mixed getId () Возвращает id каталога товаров
mixed getImage ({ [id] }) Возвращает путь к изображению каталога товаров (deprecated)
mixed getImageSrc ({ [id], [type], [resizeType], [width], [height], [quality], [watermarkKey], [watermarkMargin] }) Возвращает путь к изображению каталога товаров
mixed getLevel ({ [id] }) Возвращает уровень вложенности каталога товаров
array getList ({ [id], [brandId], [brandSeriesId], [searchStringInter], [searchStringUnion], [pageNumber], [amount], [orderType] }) Возвращает список каталогов товаров
mixed getMetaDescription ({ [id] }) Возвращает metaDescription каталога товаров
mixed getMetaKeywords ({ [id] }) Возвращает metaKeywords каталога товаров
mixed getMetaTitle ({ [id] }) Возвращает metaTitle каталога товаров
object getNew () Возвращает новую копию класса
mixed getPageTitle ({ [id] }) Возвращает pageTitle каталога товаров
mixed getParentId ({ [id] }) Возвращает id родительского каталога товаров
mixed getParents ({ id }) Возвращает инфомрацию о всех родителях каталога товаров
mixed getTitle ({ [id] }) Возвращает наименование каталога товаров
mixed getTitle2 ({ [id] }) Возвращает наименование 2 каталога товаров
mixed getTitle3 ({ [id] }) Возвращает наименование 3 каталога товаров
mixed getTitle4 ({ [id] }) Возвращает наименование 4 каталога товаров
mixed getTitle5 ({ [id] }) Возвращает наименование 5 каталога товаров
mixed getTitle6 ({ [id] }) Возвращает наименование 6 каталога товаров
mixed getTitle7 ({ [id] }) Возвращает наименование 7 каталога товаров
mixed getTitle8 ({ [id] }) Возвращает наименование 8 каталога товаров
void getUrl ({ [id], [pageNumber], [orderType], [orderTypeDefault], [brand], [parameterValue], [condition] }) Возвращает url каталога товаров
mixed hasChild ({ [id] }) Проверяет наличие дочерних каталогов в каталоге товаров
mixed hasOffer ({ [id] }) Проверяет наличие товаров в каталоге товаров (включая вложенные) (deprecated)
mixed init ({ id }) Инициализация класса
mixed isExist ({ [id] }) Проверяет существование каталога товаров
mixed isExistAF ({ [fieldName] }) Проверяет существование дополнительного поля в каталоге товаров
mixed isVirtual ({ [id] }) Проверяет виртуальный ли каталог товаров
mixed set ({ id, name, value }) Устанавливает значение

__call

Примеры кода




addView

Добавляет просмотр каталога товаров

Параметры

[id] int Id каталога товаров

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

bool True - просмотр успешно добавлен
bool False - в случае ошибки

Примеры кода




dropCache

Сбрасывает кеш информации о каталогах

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

void

Примеры кода




getAfTitle

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

Параметры

afName string Имя доп. поля каталога

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

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

Примеры кода




getAltTitle

Синоним: altTitle
Возвращает aльтернативное имя каталога товаров

Параметры

[id] int Id каталога товаров

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

string Aльтернативное имя каталога товаров
bool False - в случае ошибки

Примеры кода




getAmount

Синоним: amount
Возвращает количество каталогов товаров

Параметры

[id] int Id каталога товаров. Значения: id каталога, 0 - все каталоги товаров первого уровня, -1 - все каталоги товаров. По умолчанию: 0
[brandId] int Id бренда
[brandSeriesId] int Id серии бренда
[searchStringInter] string|array Поисковая фраза. Формат массива: ["Поисковая строка", true]. Если второй аргумент в true то будет происходить поиск с учетом морфологии.
[searchStringUnion] string|array Поисковая фраза. Формат массива: ["Поисковая строка", true]. Если второй аргумент в true то будет происходить поиск с учетом морфологии.

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

int Количество каталогов

Примеры кода




getAsId

Синоним: asId
Возвращает ИД в системе бухгалтерского учета

Параметры

[id] int Id каталога товаров

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

int ИД в системе бухгалтерского учета
bool False - в случае ошибки

Примеры кода




getIcoImageSrc

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

Параметры

[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 - в случае ошибки

Примеры кода




getId

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

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

int Id каталога товаров
bool False - в случае ошибки

Примеры кода




getImage

Синоним: image
Возвращает путь к изображению каталога товаров (deprecated)

Параметры

[id] int Id каталога товаров

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

string Путь к изображению каталога товаров
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 - в случае ошибки

Примеры кода




getLevel

Синоним: level
Возвращает уровень вложенности каталога товаров

Параметры

[id] int Id каталога товаров

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

int Уровень вложенности каталога товаров
bool False - в случае ошибки или если каталога не существует

Примеры кода




getList

Синоним: list
Возвращает список каталогов товаров

Параметры

[id] int Id каталога товаров. Значения: id каталога, 0 - все каталоги товаров первого уровня, -1 - все каталоги товаров. По умолчанию: 0
[brandId] int Id бренда
[brandSeriesId] int Id серии бренда
[searchStringInter] string|array Поисковая фраза. Формат массива: ["Поисковая строка", true]. Если второй аргумент в true то будет происходить поиск с учетом морфологии.
[searchStringUnion] string|array Поисковая фраза. Формат массива: ["Поисковая строка", true]. Если второй аргумент в true то будет происходить поиск с учетом морфологии.
[pageNumber] int Номер страницы. По умолчанию: 1
[amount] int Количество каталогов на странице. По умолчанию: 0 (все каталоги)
[orderType] string Метод сортировки. title, position. По умолчанию: position

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

array Массив обьектов catalog

Примеры кода




getMetaDescription

Синоним: metaDescription
Возвращает metaDescription каталога товаров

Параметры

[id] int Id каталога товаров

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

string MetaDescription каталога товаров
bool False - в случае ошибки

Примеры кода




getMetaKeywords

Синоним: metaKeywords
Возвращает metaKeywords каталога товаров

Параметры

[id] int Id каталога товаров

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

string MetaKeywords каталога товаров
bool False - в случае ошибки

Примеры кода




getMetaTitle

Синоним: metaTitle
Возвращает metaTitle каталога товаров

Параметры

[id] int Id каталога товаров

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

string MetaTitle каталога товаров
bool False - в случае ошибки

Примеры кода




getNew

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

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

object catalog

Примеры кода




getPageTitle

Синоним: pageTitle
Возвращает pageTitle каталога товаров

Параметры

[id] int Id каталога товаров

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

string PageTitle каталога товаров
bool False - в случае ошибки

Примеры кода




getParentId

Синоним: parentId
Возвращает id родительского каталога товаров

Параметры

[id] int Id каталога товаров

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

int Id родительского каталога товаров
bool False - в случае ошибки

Примеры кода




getParents

Синоним: parents
Возвращает инфомрацию о всех родителях каталога товаров

Параметры

id int Id каталога товаров

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

array Массив обьектов catalog
bool False - в случае ошибки или если каталога не существует

Примеры кода




getTitle

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

Параметры

[id] int Id каталога товаров

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

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

Примеры кода




getTitle2

Синоним: title2
Возвращает наименование 2 каталога товаров

Параметры

[id] int Id каталога товаров

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

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

Примеры кода




getTitle3

Синоним: title3
Возвращает наименование 3 каталога товаров

Параметры

[id] int Id каталога товаров

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

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

Примеры кода




getTitle4

Синоним: title4
Возвращает наименование 4 каталога товаров

Параметры

[id] int Id каталога товаров

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

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

Примеры кода




getTitle5

Синоним: title5
Возвращает наименование 5 каталога товаров

Параметры

[id] int Id каталога товаров

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

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

Примеры кода




getTitle6

Синоним: title6
Возвращает наименование 6 каталога товаров

Параметры

[id] int Id каталога товаров

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

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

Примеры кода




getTitle7

Синоним: title7
Возвращает наименование 7 каталога товаров

Параметры

[id] int Id каталога товаров

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

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

Примеры кода




getTitle8

Синоним: title8
Возвращает наименование 8 каталога товаров

Параметры

[id] int Id каталога товаров

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

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

Примеры кода




getUrl

Синоним: url
Возвращает url каталога товаров
Тоже самое, что @url.get с параметрами urlType, id, pageNumber, orderType, orderTypeDefault, brand, parameterValue, condition

Параметры

[id] int Id каталога товаров
[pageNumber] int Номер страницы. По умолчанию: 1
[orderType] string Тип сортировки.
[orderTypeDefault] string Тип сортировки по умолчанию.
[brand] array Массив id брендов
[parameterValue] array Массив id значений параметров
[condition] array Массив id значений состояний модификаций товара

Примеры кода




hasChild

Проверяет наличие дочерних каталогов в каталоге товаров

Параметры

[id] int Id каталога товаров

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

bool True - если дочерние каталоги существуют
bool False - если дочерних каталогов не существует или в случае ошибки

Примеры кода




hasOffer

Проверяет наличие товаров в каталоге товаров (включая вложенные) (deprecated)

Параметры

[id] int Id каталога

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

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

Примеры кода




init

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

Параметры

id int Id каталога

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

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

Примеры кода




isExist

Проверяет существование каталога товаров

Параметры

[id] int Id каталога

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

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

Примеры кода




isExistAF

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

Параметры

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

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

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

Примеры кода




isVirtual

Проверяет виртуальный ли каталог товаров

Параметры

[id] int Id каталога

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

bool True - если каталог товаров виртуальный
bool False - если каталог товаров не существует или в случае ошибки

Примеры кода




set

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

Параметры

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

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

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

Примеры кода