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

article

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

Переменные

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

Методы

void __call ()
void dropCache () Сбрасывает кеш информации о статьях
mixed getAfTitle ({ afName }) Возвращает наименование доп. поля статьи по его имени
int getAmount ({ articleCatalogId }) Возвращает кол-во статей
mixed getArticleCatalogId ({ id }) Возвращает id каталога статьи.
mixed getId () Возвращает id статьи
mixed getImage ({ [id] }) Возвращает путь к изображению статьи
mixed getImageSrc ({ [id], [type], [resizeType], [width], [height], [quality], [watermarkKey], [watermarkMargin] }) Возвращает путь к изображению статьи
mixed getList ({ articleCatalogId, [timeFrom], [timeTo], [pageNumber], [amount], [af], [orderType] }) Возвращает список статей
mixed getMetaDescription ({ [id] }) Возвращает metaDescription статьи
mixed getMetaKeywords ({ [id] }) Возвращает metaKeywords статьи
mixed getMetaTitle ({ [id] }) Возвращает metaTitle статьи
object getNew () Возвращает новую копию обьекта
mixed getPageTitle ({ [id] }) Возвращает pageTitle статьи
mixed getTime ({ [id] }) Возвращает время создания статьи в Unix формате
mixed getTitle ({ [id] }) Возвращает наименование статьи
void getUrl ({ [id] }) Возвращает url стати
mixed init ({ id, [articleCatalogId] }) Инициализация класса
mixed isExist ({ [id] }) Проверяет существованеие статьи
mixed isExistAF ({ [fieldName] }) Проверяет существование дополнительного поля в статьи
mixed set ({ id, name, value }) Устанавливает значение дополнительного поля

__call

Примеры кода




dropCache

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

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

void

Примеры кода




getAfTitle

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

Параметры

afName string Имя доп. поля статьи

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

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

Примеры кода




getAmount

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

Параметры

articleCatalogId int Id каталога статьи

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

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

Примеры кода




getArticleCatalogId

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

Параметры

id int Id статьи

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

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

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

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

Примеры кода




getList

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

Параметры

articleCatalogId int Id каталога статьи
[timeFrom] int Время с которого создана стаья. По умолчанию: не указано
[timeTo] int Время до которого создана стаья. По умолчанию: не указано
[pageNumber] int Номер страницы. По умолчанию: 1
[amount] int Кол-во статей на странице. По умолчанию: 0 (все статьи)
[af] string Список доп. полей которые нужно достать. Пример: "af_field1, af_field2" (deprecated)
[orderType] string Метод сортировки. position, time, time desc, title, title desc. По умолчанию: time desc

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

array Массив обьектов article
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 article

Примеры кода




getPageTitle

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

Параметры

[id] int Id статьи

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

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

Примеры кода




getTime

Синоним: time
Возвращает время создания статьи в Unix формате

Параметры

[id] int Id статьи

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

int Время создания статьи в Unix формате
bool False - в случае ошибки

Примеры кода




getTitle

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

Параметры

[id] int Id статьи

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

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

Примеры кода




getUrl

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

Параметры

[id] int Id стати

Примеры кода




init

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

Параметры

id int Id статьи
[articleCatalogId] int Id каталога статьи

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

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

Примеры кода




isExist

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

Параметры

[id] int Id статьи

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

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

Примеры кода




isExistAF

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

Параметры

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

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

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

Примеры кода




set

Устанавливает значение дополнительного поля

Параметры

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

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

bool True - в случае успеха
bool False - в случае ошибки

Примеры кода




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