Статические методы - Линейка решений INTEC: Universe

Метод Add(integer $iItemID, float $fQuantity = 0, string $sPriceCode = false, boolean $bCheckUserGroup = true, string $sSiteID = SITE_ID)

Описание: Добавляет товар в корзину пользователя.

Параметры:

• integer $iItemID — целое число. Индекс товара, добавляемого в корзину.

• float $fQuantity — дробное число. Количество товара, добавляемого в корзину.

• string $sPriceCode — строка или false. Код типа цены. Если false то возьмется базовый тип цены.

• boolean $bCheckUserGroup — логическое значение. Проверять группы пользователя на доступность указанного типа цены.

• string $sSiteID — строка. Индекс сайта, на котором происходит добавление в корзину.

Возвращает: integer|boolean. Если добавление прошло успешно, то возвращает количество добавленного товара иначе возвращает false.

Метод Delete(integer $iItemID, string $sSiteID = SITE_ID)

Описание: Удаляет товар из корзины.

Параметры:

• integer $iItemID — целое число. Индекс товара, удаляемого из корзины.

• string $sSiteID — строка. Индекс сайта, на котором происходит удаление из корзины.

Метод SetPriceType(integer $iItemID, string $sPriceCode = false, boolean $bCheckUserGroup = true, string $sSiteID = SITE_ID)

Описание: Изменяет тип цены товара в корзине.

Параметры:

• integer $iItemID — целое число. Индекс товара.

• string $sPriceCode — строка или false. Код типа цены. Если false то возьмется базовый тип цены.

• boolean $bCheckUserGroup — логическое значение. Проверять группы пользователя на доступность указанного типа цены.

• string $sSiteID — строка. Индекс сайта.

Возвращает: boolean. Если тип цены изменен, то true, иначе false.

Метод SetQuantity(integer $iItemID, float $fQuantity, string $sSiteID = SITE_ID)

Описание: Изменяет количество товара в корзине.

Параметры:

• integer $iItemID — целое число. Индекс товара, добавляемого в корзину.

• float $fQuantity — дробное число. Количество товара.

• string $sSiteID — строка. Индекс сайта, на котором происходит добавление в корзину.

Возвращает: integer. Новое количество товара.

Метод GetItemPriceType(integer $iItemID, string $sSiteID = SITE_ID)

Описание: Возвращает тип цены для товара в корзине.

Параметры:

• integer $iItemID — целое число. Индекс товара.

• string $sSiteID — строка. Индекс сайта.

Возвращает: null или array. Если тип цены корректный, то возвращает массив с полями типа цены иначе null.

Метод GetItemsCount(string $sSiteID = SITE_ID)

Описание: Количество товаров в корзине.

Параметры:

• string $sSiteID — строка. Индекс сайта.

Возвращает: integer. Количество товаров в корзине.

Метод GetItemsAmount(string $sSiteID = SITE_ID, string|false $sCurrency = false, string $sLanguageID = LANGUAGE_ID)

Описание: Стоймость товаров в корзине.

Параметры:

• string $sSiteID — строка. Индекс сайта.

• string|false$sCurrency — строка или false.Код валюты для конвертации. Если false или не найдена валюта, то возьмется базовая валюта.

• string $sLanguageID — строка. Код языка. Влияет на форматирование валюты. По умолчанию текущий язык.

Возвращает: array. Массив в виде отформатированной валюты.

Метод Recount(string $sSiteID = SITE_ID)

Описание: Пересчитывает всю корзину.

Параметры:

• string $sSiteID — строка. Индекс сайта.

Метод InBasket(integer $iItemID, string $sSiteID = SITE_ID)

Описание: Проверяет, находится ли товар в корзине.

Параметры:

• integer$iItemID — целое число. Индекс товара.

• string $sSiteID — строка. Индекс сайта.

Возвращает: boolean. Возвращает true, если товар в корзине, иначе false.

Метод GetQuantity(integer $iItemID, string $sSiteID = SITE_ID)

Описание: Количество товара в корзине.

Параметры:

• integer$iItemID — целое число. Индекс товара.

• string $sSiteID — строка. Индекс сайта.

Возвращает: float.

Метод GetList(array $arSort = array(), array $arFilter = array(), array $arOffersSort = array(), array $arOffersFilter = array(), string|false $sCurrencyCode = false, string $sSiteID)

Описание: Получает отсортированный и отфильтрованный список товаров в корзине.

Параметры:

• array $arSort — массив, содержащий поля для сортировки вида array(„Поле 1“ => „ASC|DESC“, „Поле 2“ => „ASC|DESC“, … , „Поле N“ => „ASC|DESC“), где ASC|DESC порядок сортировки по возрастанию и убыванию соответственно.

• array $arFilter — массив, содержащий условия фильтрации, поддерживает сложные условия.

• array $arOffersSort — массив, содержащий поля для сортировки торговых предложений вида array(„Поле 1“ => „ASC|DESC“, „Поле 2“ => „ASC|DESC“, … , „Поле N“ => „ASC|DESC“), где ASC|DESC порядок сортировки по возрастанию и убыванию соответственно.

• array $arOffersFilter — массив, содержащий условия фильтрации торговых предложений, поддерживает сложные условия.

• string $sCurrencyCode — строка. Код валюты, в которой конвертировать цены.

• string $sSiteID — строка. Индекс сайта.

Возвращает: Экземпляр класса CDBResult.

Метод Clear(string $sSiteID = SITE_ID)

Описание: Очищает всю корзину.

Параметры:

• string $sSiteID — строка. Индекс сайта.

Метод HandleRequestActions(string $sAction, integer $iItem, float $fQuantity, string|false $sPriceCode = false, $sSiteID = SITE_ID, $arActions = array('Add' =>'Add', 'Delete' =>'Delete', 'SetQuantity' =>'SetQuantity', 'Clear' =>'Clear'))

Описание: Используется и вызывается в компонентах, которые работают с корзиной.

Параметры:

• string $sAction — строка. Действие с корзиной.

• integer$iItem — целое число. Товар.

• float$fQuantity — дробное число. Количество.

• string|false$sPriceCode — строка или false. Код цены.

• string $sSiteID — строка. Индекс сайта.

• array $arActions — массив. Сопоставление действий параметра $sAction.

Возвращает: данные, зависящие от действия.