order

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

Переменные

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

Методы

void __call ()
mixed add ({ [cartOfferModList], [countryId], [deliveryTypeId], [payTypeId], sum, [discount], [userId], [priceTypeId], [emailCurrencyId], [noticeCurrencyId], [noticeLangId], [orderStatusId], [orderDeliveryStatusId], [orderPayStatusId], [sessionCode], [telephone], [email], [firstName], [middleName], [lastName], [postIndex], [region], [district], [city], [storeAddress], [street], [building], [bulk], [apartment], [userComment], [operatorComment] }) Добавляет новый заказ из сессии корзины
mixed addMark ({ [id], orderMarkId }) Добавляет новую метку к заказу
void dropCache () Сбрасывает кеш информации о заказах
mixed getAdditionalReceiver ({ [id] }) Возвращает дополнительного получателя в заказе
mixed getAmount ({ userId, [orderStatus], [orderPayStatus], [orderDeliveryStatus] }) Возвращает количество заказов пользователя.
mixed getApartment ({ [id] }) Возвращает квартиру в заказе
mixed getBuilding ({ [id] }) Возвращает дом в заказе
mixed getBulk ({ [id] }) Возвращает корпус в заказе
mixed getCity ({ [id] }) Возвращает название города в заказе
mixed getCode ({ [id] }) Возвращает код заказа
mixed getCountry ({ [id] }) Возвращает название страны в заказе
mixed getCouponCode ({ [id] }) Возвращает код купона в заказе
mixed getCustomCity ({ [id] }) Возвращает название другого "Нас. пункта" в заказе
mixed getDeliveryServiceCode ({ [id] }) Возвращает код заказа в системе службы доставки
mixed getDeliveryStatusId () Возвращает id статуса доставки
mixed getDiscount ({ [id], [numAmountAfterPoint], [currencyId] }) Возвращает скидку на заказ
mixed getDistrict ({ [id] }) Возвращает район в заказе
mixed getEmail ({ [id] }) Возвращает E-mail пользователя в заказе
mixed getFirstName ({ [id] }) Возвращает имя пользователя в заказе
mixed getId ({ [code] }) Возвращает id заказа
mixed getLastName ({ [id] }) Возвращает фамилию пользователя в заказе
mixed getList ({ userId, [orderStatus], [orderPayStatus], [orderDeliveryStatus], [pageNumber], [amount], [af] }) Возвращает список Id заказов пользователя.
mixed getMiddleName ({ [id] }) Возвращает отчество пользователя в заказе
object getNew () Возвращает новую копию объекта класса
mixed getOfferModAmount ({ [id] }) Возвращает количество модификаций товара в заказе
mixed getOrderDeliveryPrice ({ [id], [currencyId] }) Возвращает стоимость доставки заказа
mixed getOrderDeliveryStatus ({ [id] }) Возвращает наименование статуса доставки в заказе (deprecated)
mixed getOrderDeliveryStatusCssStyle ({ [id] }) Возвращает CSS стиль статуса доставки в заказе (deprecated)
mixed getOrderDeliveryStatusId ({ [id] }) Возвращает id статуса доставки в заказе
mixed getOrderDeliveryType ({ [id] }) Возвращает наименование типа доставки заказа
mixed getOrderPayStatus ({ [id] }) Возвращает наименование статуса оплаты заказа (deprecated)
mixed getOrderPayStatusCssStyle ({ [id] }) Возвращает CSS стиль статуса оплаты в заказе (deprecated)
mixed getOrderPayStatusId ({ [id] }) Возвращает id статуса оплаты в заказе
mixed getOrderPayType ({ [id] }) Возвращает ниименование типа оплаты заказа
mixed getOrderPrice ({ [id], [currencyId] }) Возвращает стоимость заказа без учета скидки (без стоимости доставки)
mixed getOrderPriceAll ({ [id], [currencyId] }) Возвращает стоимость заказа с учетом скидки + стоимость доставки заказа
mixed getOrderPriceResult ({ [id], [currencyId] }) Возвращает стоимость заказа с учетом скидки (без стоимости доставки)
mixed getOrderStatus ({ [id] }) Возвращает наименование статуса заказа (deprecated)
mixed getOrderStatusCssStyle ({ [id] }) Возвращает CSS стиль статуса заказа (deprecated)
mixed getOrderStatusId ({ [id] }) Возвращает id статуса заказа
mixed getPayStatusId () Возвращает id статуса оплаты
mixed getPostIndex ({ [id] }) Возвращает почтовый индекс в заказе
mixed getRegion ({ [id] }) Возвращает область/регион в заказе
mixed getStatusId () Возвращает id статуса заказа
mixed getStoreAddress ({ [id] }) Возвращает адрес склада в заказе
mixed getStreet ({ [id] }) Возвращает улицу в заказе
mixed getTelephone ({ [id] }) Возвращает телефон пользователя в заказе
mixed getTime ({ [id] }) Возвращает время создания заказа товара в Unix формате
mixed getUserComment ({ [id] }) Возвращает комментарий пользователя к заказу
mixed getUserId ({ [id] }) Возвращает id пользователя
mixed hasCouponCode ({ [id] }) Проверяет применялся ли купон к заказу
mixed init ({ id }) Инициализация класса
mixed isExist ({ [id], [code], [userId] }) Проверяет существование заказа
mixed set ({ id, name, value }) Устанавливает значение

__call

Примеры кода




add

Добавляет новый заказ из сессии корзины
В случае успеха, если при оформлении заказа был указан $email, отправляется email пользователю

Параметры

[cartOfferModList] array Массив модификаций в формате array id модификации => кол-во модификаций. По умолчанию: список товаров в корзине
[countryId] int Id страны
[deliveryTypeId] int Id типа доставки
[payTypeId] int Id типа оплаты
sum float Сумма на основании которой расчитываеться стоимость доставки
[discount] float Скидка
[userId] int Id пользователя. По умолчанию: ИД авторизованного пользователя
[priceTypeId] int Id типа цены. По умолчанию: 0 или тип цены авторизированного пользователя
[emailCurrencyId] int Id валюты в которой необходимо отсылать уведомления пользователю. По умолчанию: id выбранной валюты (deprecated)
[noticeCurrencyId] int Id валюты в которой необходимо отсылать уведомления пользователю. По умолчанию: id выбранной валюты
[noticeLangId] int Id языка на котором необходимо отсылать уведомления пользователю. По умолчанию: id выбранного языка
[orderStatusId] int Id статуса заказа. По умолчанию: id статуса заказа "по умолчанию"
[orderDeliveryStatusId] int Id статуса доставки заказа. По умолчанию: id статуса доставки заказа "по умолчанию"
[orderPayStatusId] int Id статуса оплаты заказа. По умолчанию: id статуса оплаты заказа "по умолчанию"
[sessionCode] string Код сессии
[telephone] string Телефон пользователя
[email] string Email пользователя
[firstName] string Имя пользователя
[middleName] string Отчество пользователя
[lastName] string Фамилия пользователя
[postIndex] string Почтовый индекс пользователя
[region] string Регион проживания пользователя
[district] string Район проживания пользователя
[city] string Город проживания пользователя
[storeAddress] string Адрес склада
[street] string Улица проживания пользователя
[building] string Номер дома проживания пользователя
[bulk] string Номер корпуса в доме проживания пользователя
[apartment] string Номер квартиры в доме проживания пользователя
[userComment] string Комментарий пользователя к заказу
[operatorComment] string Комментарий оператора к заказу

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

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

Примеры кода




addMark

Добавляет новую метку к заказу

Параметры

[id] int Id заказа
orderMarkId int Id метки заказа

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

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

Примеры кода




dropCache

Сбрасывает кеш информации о заказах
Сбрасывается кеш классов: @see order и @see orderOffer

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

void

Примеры кода




getAdditionalReceiver

Синоним: additionalReceiver
Возвращает дополнительного получателя в заказе

Параметры

[id] int Id заказа

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

string Дополнительный получатель
bool False - в случае ошибки

Примеры кода




getAmount

Синоним: amount
Возвращает количество заказов пользователя.

Параметры

userId int Id пользователя
[orderStatus] array Массив id статусов заказа
[orderPayStatus] array Массив id статусов оплаты заказа
[orderDeliveryStatus] array Массив id статусов доставки заказа

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

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

Примеры кода




getApartment

Синоним: apartment
Возвращает квартиру в заказе

Параметры

[id] int Id заказа

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

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

Примеры кода




getBuilding

Синоним: building
Возвращает дом в заказе

Параметры

[id] int Id заказа

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

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

Примеры кода




getBulk

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

Параметры

[id] int Id заказа

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

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

Примеры кода




getCity

Синоним: city
Возвращает название города в заказе

Параметры

[id] int Id заказа

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

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

Примеры кода




getCode

Синоним: code
Возвращает код заказа

Параметры

[id] int Id заказа

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

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

Примеры кода




getCountry

Синоним: country
Возвращает название страны в заказе

Параметры

[id] int Id заказа

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

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

Примеры кода




getCouponCode

Синоним: couponCode
Возвращает код купона в заказе

Параметры

[id] int Id заказа

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

string Код купона в заказе
bool False - в случае ошибки

Примеры кода




getCustomCity

Синоним: customCity
Возвращает название другого "Нас. пункта" в заказе

Параметры

[id] int Id заказа

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

string Название другого "Нас. пункта"
bool False - в случае ошибки

Примеры кода




getDeliveryServiceCode

Синоним: deliveryServiceCode
Возвращает код заказа в системе службы доставки

Параметры

[id] int Id заказа

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

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

Примеры кода




getDeliveryStatusId

Синоним: deliveryStatusId
Возвращает id статуса доставки

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

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

Примеры кода




getDiscount

Синоним: discount
Возвращает скидку на заказ

Параметры

[id] int Id заказа
[numAmountAfterPoint] int Количество символов после точки. По умолчанию: 2
[currencyId] int Id валюты. По умолчанию: id выбранной валюты

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

float Скидку на заказ
bool False - в случае ошибки

Примеры кода




getDistrict

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

Параметры

[id] int Id заказа

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

string Район
bool False - в случае ошибки

Примеры кода




getEmail

Синоним: email
Возвращает E-mail пользователя в заказе

Параметры

[id] int Id заказа

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

string E-mail пользователя
bool False - в случае ошибки

Примеры кода




getFirstName

Синоним: firstName
Возвращает имя пользователя в заказе

Параметры

[id] int Id заказа

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

string Имя пользователя
bool False - в случае ошибки

Примеры кода




getId

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

Параметры

[code] string Code заказа

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

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

Примеры кода




getLastName

Синоним: lastName
Возвращает фамилию пользователя в заказе

Параметры

[id] int Id заказа

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

string Фамилия пользователя
bool False - в случае ошибки

Примеры кода




getList

Синоним: list
Возвращает список Id заказов пользователя.

Параметры

userId int Id пользователя
[orderStatus] array Массив id статусов заказа
[orderPayStatus] array Массив id статусов оплаты заказа
[orderDeliveryStatus] array Массив id статусов доставки заказа
[pageNumber] int Номер страницы. По умолчанию: 1
[amount] int Количество заказов на странице. По умолчанию: 0 (все заказы)
[af] string Список доп. полей которые нужно достать. Пример: "af_field1, af_field2"

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

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

Примеры кода




getMiddleName

Синоним: middleName
Возвращает отчество пользователя в заказе

Параметры

[id] int Id заказа

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

string Отчество пользователя
bool False - в случае ошибки

Примеры кода




getNew

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

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

object order

Примеры кода




getOfferModAmount

Синоним: offerModAmount
Возвращает количество модификаций товара в заказе

Параметры

[id] int Id заказа

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

int Количество модификаций товара
bool False - в случае ошибки

Примеры кода




getOrderDeliveryPrice

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

Параметры

[id] int Id заказа
[currencyId] int Id валюты. По умолчанию: id выбранной валюты

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

float Стоимость доставки
bool False - в случае ошибки

Примеры кода




getOrderDeliveryStatus

Синоним: orderDeliveryStatus
Возвращает наименование статуса доставки в заказе (deprecated)

Параметры

[id] int Id заказа

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

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

Примеры кода




getOrderDeliveryStatusCssStyle

Синоним: orderDeliveryStatusCssStyle
Возвращает CSS стиль статуса доставки в заказе (deprecated)

Параметры

[id] int Id заказа

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

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

Примеры кода




getOrderDeliveryStatusId

Синоним: orderDeliveryStatusId
Возвращает id статуса доставки в заказе

Параметры

[id] int Id заказа

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

int Id статуса доставки в заказе
bool False - в случае ошибки

Примеры кода




getOrderDeliveryType

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

Параметры

[id] int Id заказа

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

string Название типа доставки
bool False - в случае ошибки

Примеры кода




getOrderPayStatus

Синоним: orderPayStatus
Возвращает наименование статуса оплаты заказа (deprecated)

Параметры

[id] int Id заказа

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

string Статус оплаты в заказе
bool False - в случае ошибки

Примеры кода




getOrderPayStatusCssStyle

Синоним: orderPayStatusCssStyle
Возвращает CSS стиль статуса оплаты в заказе (deprecated)

Параметры

[id] int Id заказа

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

string CSS стиль статуса оплаты в заказе
bool False - в случае ошибки

Примеры кода




getOrderPayStatusId

Синоним: orderPayStatusId
Возвращает id статуса оплаты в заказе

Параметры

[id] int Id заказа

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

int Id статуса оплаты в заказе
bool False - в случае ошибки

Примеры кода




getOrderPayType

Синоним: orderPayType
Возвращает ниименование типа оплаты заказа

Параметры

[id] int Id заказа

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

string Название типа оплаты
bool False - в случае ошибки

Примеры кода




getOrderPrice

Синоним: orderPrice
Возвращает стоимость заказа без учета скидки (без стоимости доставки)

Параметры

[id] int Id заказа
[currencyId] int Id валюты. По умолчанию: id выбранной валюты

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

float Стоимость заказа
bool False - в случае ошибки

Примеры кода




getOrderPriceAll

Синоним: orderPriceAll
Возвращает стоимость заказа с учетом скидки + стоимость доставки заказа

Параметры

[id] int Id заказа
[currencyId] int Id валюты. По умолчанию: id выбранной валюты

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

float Стоимость заказа
bool False - в случае ошибки

Примеры кода




getOrderPriceResult

Синоним: orderPriceResult
Возвращает стоимость заказа с учетом скидки (без стоимости доставки)

Параметры

[id] int Id заказа
[currencyId] int Id валюты. По умолчанию: id выбранной валюты

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

float Стоимость заказа
bool False - в случае ошибки

Примеры кода




getOrderStatus

Синоним: orderStatus
Возвращает наименование статуса заказа (deprecated)

Параметры

[id] int Id заказа

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

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

Примеры кода




getOrderStatusCssStyle

Синоним: orderStatusCssStyle
Возвращает CSS стиль статуса заказа (deprecated)

Параметры

[id] int Id заказа

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

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

Примеры кода




getOrderStatusId

Синоним: orderStatusId
Возвращает id статуса заказа

Параметры

[id] int Id заказа

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

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

Примеры кода




getPayStatusId

Синоним: payStatusId
Возвращает id статуса оплаты

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

int Id статуса оплаты
bool False - в случае ошибки

Примеры кода




getPostIndex

Синоним: postIndex
Возвращает почтовый индекс в заказе

Параметры

[id] int Id заказа

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

string Почтовый индекс
bool False - в случае ошибки

Примеры кода




getRegion

Синоним: region
Возвращает область/регион в заказе

Параметры

[id] int Id заказа

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

string Область/регион
bool False - в случае ошибки

Примеры кода




getStatusId

Синоним: statusId
Возвращает id статуса заказа

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

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

Примеры кода




getStoreAddress

Синоним: storeAddress
Возвращает адрес склада в заказе

Параметры

[id] int Id заказа

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

string Адрес склада
bool False - в случае ошибки

Примеры кода




getStreet

Синоним: street
Возвращает улицу в заказе

Параметры

[id] int Id заказа

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

string Улицу
bool False - в случае ошибки

Примеры кода




getTelephone

Синоним: telephone
Возвращает телефон пользователя в заказе

Параметры

[id] int Id заказа

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

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

Примеры кода




getTime

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

Параметры

[id] int Id заказа

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

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

Примеры кода




getUserComment

Синоним: userComment
Возвращает комментарий пользователя к заказу

Параметры

[id] int Id заказа

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

string Комментарий пользователя
bool False - в случае ошибки

Примеры кода




getUserId

Синоним: userId
Возвращает id пользователя

Параметры

[id] int Id заказа

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

int Id пользователя
bool False - в случае ошибки

Примеры кода




hasCouponCode

Проверяет применялся ли купон к заказу

Параметры

[id] int Id заказа

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

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

Примеры кода




init

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

Параметры

id int Id заказа

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

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

Примеры кода




isExist

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

Параметры

[id] int Id заказа
[code] string Code заказа
[userId] int Id пользователя. Используется как дополнительное условие проверки

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

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

Примеры кода




set

Устанавливает значение

Параметры

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

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

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

Примеры кода