Фильтры и функции
Фильтры Функции
Классы
actionCouponactionallegroBrandallegroBrandSeriesallegroCartallegroCatalogBrandallegroCatalogBrandSeriesallegroCatalogMarkModelallegroCatalogMarkModelTypeallegroCatalogMarkallegroCatalogallegroISearchallegroMarkModelallegroMarkModelTypeallegroMarkallegroOfferCompatibilityallegroOfferCompatibilityValueallegroOfferImageallegroOfferParamallegroOfferParamValueallegroOfferallegroOrderDeliveryPriceallegroOrderallegroSchemaOrgarticleCatalogarticleCommentarticleOfferGrouparticlebannerbannerPlacebonusbrandbrandSeriescartcatalogBrandcatalogcitycontactCenterMessagecontactCenterMessageTypecountrycsscurrencydeliveryServiceCitydeliveryServicedeliveryServiceWarehouseemailfileCachefilefrontMenuGroupfrontMenufrontSettingshelperjavaScriptlangmailingmetaTagsmoduleofferCommentofferCommentStorageFileofferFilterofferImageofferMarkofferModKeyofferModofferModStatusofferOfferGroupofferonlinePayTransactionopenGraphorderDeliveryPriceorderDeliveryStatusorderDeliveryTypeorderDoHistoryorderMarkorderOfferorderPayStatusorderPayTypeorderorderStatuspageparameterparameterValuepayChastPrivatbankpriceTypeproppropValueresponseschemaOrgsearchHistoryseoFooterseoQuerysessionsettingsDesignsettingssiteCommentsiteContactsmartFiltersmssocialNetworksomeElementGroupsomeElementstorageCatalogstorageFilestorageFileUploadFilesubscribeGroupsubscribeurluserwobblerCSSwobbler

banner

Класс для работы с баннерами

Переменные

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

Методы

mixed getBgColor ({ [id] }) Возвращает hex код цвета бэкграунда баннера
mixed getButtonText ({ [id] }) Возвращает текст кнопки баннера
mixed getDescription ({ [id] }) Возвращает описание баннера
mixed getId () Возвращает id баннера
mixed getImage ({ [id] }) Возвращает путь к изображению баннера
mixed getImageSrc ({ [id], [type], [resizeType], [width], [height], [quality], [watermarkKey], [watermarkMargin] }) Возвращает путь к изображению баннера
mixed getLink ({ [id] }) Возвращает ссылку баннера
mixed getList ({ bannerPlaceId, [catalogId], [brandId], [pageId], [articleCatalogId] }) Возвращает список баннеров
mixed getName ({ [id] }) Возвращает наименование баннера
object getNew () Возвращает новую копию объекта класса
mixed getTitle ({ [id] }) Возвращает первую строку заголовка баннера
mixed getTitle2 ({ [id] }) Возвращает вторую строку заголовка баннера
mixed getType ({ [id] }) Возвращает тип баннера
mixed init ({ id }) Инициализация класса
mixed isTypeImage ({ [id] }) Проверяет является ли тип баннер "изображение"
mixed isTypeImageAndText ({ [id] }) Проверяет является ли тип баннера "текст и изображение"

getBgColor

Синоним: bgColor
Возвращает hex код цвета бэкграунда баннера

Параметры

[id] int Id баннера

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

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

Примеры кода




getButtonText

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

Параметры

[id] int Id баннера

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

string Текст кнопки баннера
bool False - в случае ошибки

Примеры кода




getDescription

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

Параметры

[id] int Id баннера

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

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

Примеры кода




getId

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

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

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

Примеры кода




getImage

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

Параметры

[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 Ширина изображзения в пикселях. По умолчанию: 1170
[height] int Высота изображзения в пикселях. По умолчанию: 540
[quality] int Качество изображения. 1 - 9 - качество изображения. 0 - Качество не изменять. По умолчанию: 0
[watermarkKey] int Ключ, указывает что необходимо наложить водяной знак. 0 - неналаживать, 1 - налаживать. По умолчанию: 0
[watermarkMargin] int Отступ водяного знака от нижней границы изображения в процентах. По умолчанию: 30

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

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

Примеры кода




getList

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

Параметры

bannerPlaceId int Id места размещения баннера
[catalogId] int Id каталога
[brandId] int Id бренда
[pageId] int Id страницы
[articleCatalogId] int Id каталога статей

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

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

Примеры кода




getName

Синоним: name
Возвращает наименование баннера

Параметры

[id] int Id баннера

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

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

Примеры кода




getNew

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

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

object banner

Примеры кода




getTitle

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

Параметры

[id] int Id баннера

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

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

Примеры кода




getTitle2

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

Параметры

[id] int Id баннера

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

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

Примеры кода




getType

Синоним: type
Возвращает тип баннера

Параметры

[id] int Id баннера

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

int BANNER_TYPE_IMAGE или BANNER_TYPE_IMAGE_AND_TEXT
bool False - в случае ошибки

Примеры кода




init

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

Параметры

id int Id баннера

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

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

Примеры кода




isTypeImage

Проверяет является ли тип баннер "изображение"

Параметры

[id] int Id баннера

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

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

Примеры кода




isTypeImageAndText

Проверяет является ли тип баннера "текст и изображение"

Параметры

[id] int Id баннера

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

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

Примеры кода




Методы класса
getBgColorgetButtonTextgetDescriptiongetIdgetImagegetImageSrcgetLinkgetListgetNamegetNewgetTitlegetTitle2getTypeinitisTypeImageisTypeImageAndText
∧