allegroMark

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

Переменные

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

Методы

void __call ()
mixed addView ({ [id] }) Добавляет просмотр марки
void dropCache () Сбрасывает кеш информации о марках
mixed getAllegroId ({ [id] }) Возвращает ИД в системе Allegro
mixed getAlphabetList ({ [catalogId], [pageNumber], [amount], [orderType] }) Возвращает список марок для кластеризации по превым буквам наименования
mixed getId ({ [allegroId] }) Возвращает id марки
mixed getImageSrc ({ [id], [type], [resizeType], [width], [height], [quality], [watermarkKey], [watermarkMargin] }) Возвращает путь к изображению марки
mixed getList ({ [catalogId], [pageNumber], [amount], [orderType] }) Возвращает список марок
mixed getMetaDescription ({ [id] }) Возвращает metaDescription марки
mixed getMetaKeywords ({ [id] }) Возвращает metaKeywords марки
mixed getMetaTitle ({ [id] }) Возвращает metaTitle марки
object getNew () Возвращает новую копию объекта класса
mixed getPageTitle ({ [id] }) Возвращает pageTitle страницы марки
mixed getTitle ({ [id] }) Возвращает наименование марки
void getUrl ({ [id], [pageNumber], [orderType], [orderTypeDefault], [parameterValue] }) Возвращает url марки
mixed init ({ id }) Инициализация класса
mixed isExist ({ [id], [allegroId] }) Проверяет существование марки

__call

Примеры кода




addView

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

Параметры

[id] int Id марки

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

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

Примеры кода




dropCache

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

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

void

Примеры кода




getAllegroId

Синоним: allegroId
Возвращает ИД в системе Allegro

Параметры

[id] int Id марки

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

string ИД в системе Allegro
bool False - в случае ошибки

Примеры кода




getAlphabetList

Синоним: alphabetList
Возвращает список марок для кластеризации по превым буквам наименования

Параметры

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

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

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

Примеры кода




getId

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

Параметры

[allegroId] string ИД в системе Allegro

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

int Id марки
bool False - в случае ошибки или если марки Allegro не существует

Примеры кода




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

Примеры кода




getList

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

Параметры

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

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

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

Примеры кода




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 allegroMark

Примеры кода




getPageTitle

Синоним: pageTitle
Возвращает pageTitle страницы марки

Параметры

[id] int Id марки

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

string PageTitle страницы марки
bool False - в случае ошибки

Примеры кода




getTitle

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

Параметры

[id] int Id марки

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

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

Примеры кода




getUrl

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

Параметры

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

Примеры кода




init

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

Параметры

id int Id марки

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

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

Примеры кода




isExist

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

Параметры

[id] int Id марки
[allegroId] string ИД в системе Allegro

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

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

Примеры кода