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

 Methods

CAprofShopOrder:Add

Add(array $arFields) : int

Создает заказ

Параметр Описание
arFields Массив с параметрами заказа
  • QUICK_BUY - флаг быстрого заказа
  • STATUS - код статуса заказа
  • TOTAL_PRICE - общая стоимость заказа
  • DELIVERY_ID - ID способа доставки
  • PAY_SYSTEM_ID - ID платежной ситемы
  • DELIVERY_PRICE - Стоимость доставки
  • DISCOUNT - Скидка
  • ORDER_DESCRIPTION - Комментарий к заказу
  • CANCEL_REASON - причина отмены заказа
  • Данные покупателя. (если не вводить будут взяты из профиля пользователя)
  • NAME - Имя
  • LAST_NAME - Фамилия
  • EMAIL - Email
  • PHONE - Телефон
  • CITY - Город
  • ADRESS - Адрес

Если какие то данные не введены, то они будут взяты из сл. свойств профиля пользователя:

Параметр в заказе Параметр в профиле пользователя
NAME NAME
LAST_NAME LAST_NAME
EMAIL EMAIL
PHONE PERSONAL_PHONE
CITY PERSONAL_CITY
ADRESS PERSONAL_STREET

Фукнция вернет номер заказа

Parameters

$arFields

array

Returns

int

CAprofShopOrder::AddProperty

AddProperty(array $arFields) : int

Добавляет свойства заказа

Параметр Описание
arFields Массив параметров свойства:
  • PROPERTY_TYPE - тип свойства (может принимать значения: TEXT - текст, LOCATION - привязка к местоположению, CHECKBOX
  • SORT - индекс сортировки
  • NAME - Название свойства
  • ACTIVE - Активность свойства
  • CODE - Код свойства

Вернет ID добавленного свойства

Parameters

$arFields

array

Returns

int

CAprofShopOrder::DeleteProperty

DeleteProperty(int $ID) : boolean

Удаляет свойство заказа

Parameters

$ID

int

Returns

boolean

CAprofShopOrder::GetByID

GetByID(int $ID) : mixed

Возвращает параметры заказа с номером $ID

Вернет массив:

array(
"ID",
"CREATE_DATE",
"STATUS"=>array(
    "NAME",
    "ID"
),
"DELIVERY_ID",
"PAY_SYSTEM_ID",
"TOTAL_PRICE",
"DELIVERY_PRICE",
"DISCOUNT_VALUE",
"USER_ID",
"USER_DESCRIPTION"
);

Parameters

$ID

int

Returns

mixed

CAprofShopOrder::GetList

GetList(array $arOrder, array $arFilter) : mixed

Возвращает список заказов

Параметр Описание
arOrder Массив вида Array(by1=>order1[, by2=>order2 [, ..]]), где by - поле для сортировки, может принимать значения:
  • CREATE_DATE - Дата создания заказа
  • QUICK_BUY - флаг быстрого заказа
  • STATUS - код статуса заказа
  • TOTAL_PRICE - общая стоимость заказа
  • DELIVERY_ID - ID способа доставки
  • PAY_SYSTEM_ID - ID платежной ситемы
  • DELIVERY_PRICE - Стоимость доставки
  • DISCOUNT - Скидка
  • USER - ID покупателя
  • ORDER_DESCRIPTION - Комментарий к заказу
  • CANCEL_REASON - причина отмены заказа
arFilter Массив вида array("фильтруемое поле"=>"значения фильтра" [, ...]). "фильтруемое поле" может принимать значения:
  • CREATE_DATE - Дата создания заказа
  • QUICK_BUY - флаг быстрого заказа
  • STATUS - код статуса заказа
  • TOTAL_PRICE - общая стоимость заказа
  • DELIVERY_ID - ID способа доставки
  • PAY_SYSTEM_ID - ID платежной ситемы
  • DELIVERY_PRICE - Стоимость доставки
  • DISCOUNT - Скидка
  • USER - ID покупателя
  • ORDER_DESCRIPTION - Комментарий к заказу
  • CANCEL_REASON - причина отмены заказа

Вернет массив:

array(
"ID",
"CREATE_DATE",
"STATUS"=>array(
    "NAME",
    "ID"
),
"DELIVERY_ID",
"PAY_SYSTEM_ID",
"TOTAL_PRICE",
"DELIVERY_PRICE",
"DISCOUNT_VALUE",
"USER_ID",
"USER_DESCRIPTION"
);

Parameters

$arOrder

array

$arFilter

array

Returns

mixed

CAprofShopOrder::GetOrderProperties

GetOrderProperties(int $ID, array $arOrder, array $arFilter) : boolean

Возвращает список свойств заказа с номером $ID

Параметр Описание
arOrder Массив вида Array(by1=>order1[, by2=>order2 [, ..]]), где by - поле для сортировки, может принимать значения:
  • ID - ID свойства
  • SORT - индекс сортировки
  • NAME - Название свойства
  • ACTIVE - Активность свойства
arFilter Массив вида array("фильтруемое поле"=>"значения фильтра" [, ...]). "фильтруемое поле" может принимать значения:
  • ID - ID свойства
  • SORT - индекс сортировки
  • NAME - Название свойства
  • ACTIVE - Активность свойства
  • PROPERTY_TYPE - Тип свойства
  • CODE - Символьный код свойства

Вернет массив:

array(
"ID",
"CODE",
"NAME",
"VALUE",
"DISPLAY_VALUE"
);

Parameters

$ID

int

$arOrder

array

$arFilter

array

Returns

boolean

CAprofShopOrder::GetPropByID

GetPropByID(int $ID) : array

Возвращает свойство заказа с кодом $ID

Вернет массив:

array(
"ID",
"NAME",
"CODE",
"ACTIVE",
"PROPERTY_TYPE",
"IS_REQUIRED",
"SORT"
);

Parameters

$ID

int

Returns

array

CAprofShopOrder::GetRealID

GetRealID(int $ID) : boolean

Возвращает ID заказа в базе, по его номеру

Parameters

$ID

int

Returns

boolean

CAprofShopOrder::OrderBasket

OrderBasket(int $ORDER_ID) 

Привязывает товары из корзины, к заказу $ORDER_ID

Parameters

$ORDER_ID

int

CAprofShopOrder::OrderProduct

OrderProduct(int $ORDER_ID, int $PRODUCT_ID) : boolean

Привязывает товар с ID $PRODUCT_ID к заказу $ORDER_ID

Parameters

$ORDER_ID

int

$PRODUCT_ID

int

Returns

boolean

CAprofShopOrder::Update

Update(int $ORDER_ID, array $arFields) : boolean

Обновляет заказ

Параметр Описание
arFields Массив с параметрами заказа
  • CREATE_DATE - Дата создания заказа
  • QUICK_BUY - флаг быстрого заказа
  • STATUS - код статуса заказа
  • TOTAL_PRICE - общая стоимость заказа
  • DELIVERY_ID - ID способа доставки
  • PAY_SYSTEM_ID - ID платежной ситемы
  • DELIVERY_PRICE - Стоимость доставки
  • DISCOUNT - Скидка
  • ORDER_DESCRIPTION - Комментарий к заказу
  • CANCEL_REASON - причина отмены заказа
  • Данные покупателя. (если не вводить будут взяты из профиля пользователя)
  • NAME - Имя
  • LAST_NAME - Фамилия
  • EMAIL - Email
  • PHONE - Телефон
  • CITY - Город
  • ADRESS - Адрес

Parameters

$ORDER_ID

int

$arFields

array

Returns

boolean

CAprofShopOrder::UpdateProperty

UpdateProperty(int $ID, array $arFields) : int

Обновляет свойство заказа

Параметр Описание
arFields Массив параметров свойства:
  • PROPERTY_TYPE - тип свойства (может принимать значения: TEXT - текст, LOCATION - привязка к местоположению, CHECKBOX
  • SORT - индекс сортировки
  • NAME - Название свойства
  • ACTIVE - Активность свойства
  • CODE - Код свойства

Parameters

$ID

int

$arFields

array

Returns

int