allegroSchemaOrg

Класс для работы с разметкой schema.org для Allegro

Переменные

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

Методы

void __call ()
mixed getBreadcrumbList ({ order, [projectName], [catalogId], [brandId], [markId], [markModelId], [markModelTypeId], [offerId], [pageId], [customListItems], [showLastCatalogItemKey] }) Возвращает разметку schema.org (JSON-LD) для хлебных крошек (BreadcrumbList)
mixed getCatalog ({ catalogId, [description] }) Возвращает разметку schema.org (JSON-LD) для каталога
string getLastErrorCode () Возвращает код последней ошибки
object getNew () Возвращает новую копию объекта класса
mixed getOrganization ({ [type], [url], [name], [logo], [email], [contactPoint], [sameAs], [custom] }) Возвращает разметку schema.org (JSON-LD) для организации
mixed getProduct ({ offerId, [description] }) Возвращает разметку schema.org (JSON-LD) для товара allegro
mixed getWebSite ({ [target], [query], [custom] }) Возвращает разметку schema.org (JSON-LD) для WebSite

__call

Примеры кода




getBreadcrumbList

Синоним: breadcrumbList
Возвращает разметку schema.org (JSON-LD) для хлебных крошек (BreadcrumbList)

Параметры

order string Порядок вывода. Допустимые значения: allegroCatalog, allegroCatalogBrand, allegroCatalogMark, allegroCatalogMarkModel, allegroCatalogMarkModelType, allegroBrand, allegroMark, allegroMarkModel, allegroMarkModelType, allegroOffer, page, custom. Например: "catalog,catalogBrand,offer" - сразу выведутся ссылки на каталог потом на каталог бренда а потом на товар
[projectName] string Наименование элетента для главной страницы. По умолчанию: берется из настроек сайта.
[catalogId] int Id каталога allegro. Используется для: allegroCatalog, allegroCatalogBrand
[brandId] int Id бренда allegro. Используется для: allegroBrand, allegroCatalogBrand
[markId] int Id марки allegro. Используется для: allegroMark, allegroCatalogMark
[markModelId] int Id модели марки allegro. Используется для: allegroMarkModel, allegroCatalogMarkModel
[markModelTypeId] int Id тип модели марки allegro. Используется для: allegroMarkModelType, allegroCatalogMarkModelType
[offerId] int Id товара allegro. Используется для: allegroOffer
[pageId] int Id страницы. Используется для: page
[customListItems] array Массив элементов для индивидуального указания. Формат: [{"@id": url, "name": name}]
[showLastCatalogItemKey] int Выводить ли последний каталог. Значения: 0 - не отображать, 1 - отображать. По умолчанию: 0. Используется для: catalog

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

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

Примеры кода




getCatalog

Синоним: catalog
Возвращает разметку schema.org (JSON-LD) для каталога

Параметры

catalogId int Id каталога
[description] string Описание каталога

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

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

Примеры кода




getLastErrorCode

Синоним: lastErrorCode
Возвращает код последней ошибки

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

string Код последней ошибки

Примеры кода




getNew

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

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

object schemaOrg

Примеры кода




getOrganization

Синоним: organization
Возвращает разметку schema.org (JSON-LD) для организации

Параметры

[type] string Тип организации компании. По умолчанию: "Organization"
[url] string Url главной страницы сайта. По умолчанию: ссылка на главную страницу сайта
[name] string Название компании, кратко ее деятельность. По умолчанию: берется название магазина из настроек сайта
[logo] string Ссылка на логотип. По умолчанию: берется из настроек сайта
[email] string Email. По умолчанию: берется из настроек сайта
[contactPoint] array Массив элементов для индивидуального указания контактной точки. Формат: {"@type": "ContactPoint", "telephone": telephone}, полное описание смотри на https://schema.org/ContactPoint. По умолчанию: берется список номеров телефонов из настроек сайта
[sameAs] string Массив с ссылками на соц. сети. По умолчанию: берется из настроек
[custom] array Данные которые можно добавить или заменить в общей информации. Смотри на https://schema.org/Organization. Например: {"currenciesAccepted": "UAH"} или {"currenciesAccepted": "UAH", "openingHoursSpecification": [{"@type": "OpeningHoursSpecification", "dayOfWeek": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"], "opens": "09:00", "closes": "21:00"}]}

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

string Код разметки для организации
string E101 - Неверный формат E-mail
bool False - в случае ошибки

Примеры кода




getProduct

Синоним: product
Возвращает разметку schema.org (JSON-LD) для товара allegro

Параметры

offerId int Id товара allegro
[description] string Описание товара allegro

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

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

Примеры кода




getWebSite

Синоним: webSite
Возвращает разметку schema.org (JSON-LD) для WebSite

Параметры

[target] string Url на страницу поиска с параметром при помощи которого осуществляется поиск на сайте. По умолчанию: ссылка на страницу поиска. Например: http://yourdomain.com/search/?searchString={searchString}
[query] string Название переменной запроса. По умолчанию: searchString
[custom] array Данные которые можно добавить или заменить в общей информации. Смотри на https://schema.org/WebSite

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

string Код разметки для организации
string E101 - Неверный формат E-mail
bool False - в случае ошибки

Примеры кода