Класс order модуля emarket

Класс order

Описание

Данный класс предоставляет доступ к заказу интернет-магазина либо к текущей корзине. Исходный код класса находится в файле classes\modules\emarket\classes\order\order.php

Свойства класса

$items, хранит информацию о предметах в заказе или корзине

protected $items = Array();

$actualPrice хранит актуальную цену на товар(с учетом скидки)

protected $actualPrice;

$originalPrice хранит первоначальную цену товара

protected $originalPrice;

$totalAmount хранит общее количество предметов в заказе или корзине товаров

protected $totalAmount;

$discount хранит объект "скидка на заказ"

protected $totalAmount;

$domain хранит объект "текущий домен"

protected $totalAmount;

Методы

create()

Экземпляр класса создается с помощью функции create()

Параметры:

boolean $useDummyOrder:

по умолчанию false

Результат:Int $orderId - id нового заказа

get()

Метод get() получит экземпляр заказа по его id. Если id заказа false, то метод вернет текущий объект со статусом "в корзине". Если такого объекта еще нет, то он его создаст

Параметры:

Integer  $orderId:

по умолчанию false

Результат:iUmiObject $order - новый объект заказ

getStatusByCode()

Метод getStatusByCode() получит id объекта статуса заказа.

Параметры:

String  $codename:

код статуса заказа

String  $statusClass = 'order_status':

группа статуса

Результат:Integer id объекта статуса заказа

getCodeByStatus()

Метод getCodeByStatus() получит код статуса заказа.

Параметры:

Integer  $id:

идентификатор объекта статуса заказа

Результат:String codename код статуса заказа

getItems()

Метод getItems() получит список наименований в заказе.

Параметры:

Результат:Array массив, состоящий из экземпляров класса orderItem

appendItem()

Метод appendItem() добавит наименование в заказ.

Параметры:

orderItem  $orderItem:

наименование заказа

Результат: вернет false, если наименование с таким id уже есть в заказе

removeItem()

Метод removeItem() удалит наименование из заказа.После удаления из заказа объект orderItem будет уничтожен

Параметры:

orderItem  $orderItem:

наименование в заказе

Результат: вернет true, если наименование было удалено, false в противном случае

getItem()

Метод getItem() получит экземпляр наименования заказа по id

Параметры:

Integer  $itemId:

id наименования

Результат: orderItem, если наименование получить не удалось - false

isEmpty()

Метод isEmpty() проверяет есть ли наименования в заказе

Параметры:

Результат: bool true, если заказ пустой, иначе false

earse()

Метод earse() очистит список товаров в заказе. При этом будут уничтожены все orderItem'ы

Параметры:

Результат:

getOrderStatus()

Метод getOrderStatus() получит текущий статус заказа

Параметры:

Результат: Integer id объекта статуса заказа

setOrderStatus()

Метод setOrderStatus() изменит текущий статус заказа

Параметры:

Integer  $newStatusId:

id объекта-статуса заказа

Результат:

getPaymentStatus()

Метод getPaymentStatus() получит текущий статус оплаты заказа

Параметры:

Результат: Integer id объекта-статуса оплаты

setPaymentStatus()

Метод getItem() изменит текущий статус оплаты заказа

Параметры:

Integer  $statusId:

id объекта-статуса оплаты

Результат:

getDeliveryStatus()

Метод getDeliveryStatus() Получить текущий статус доставки заказа

Параметры:

Результат: Integerid объекта-статуса доставки

setDeliveryStatus()

Метод setDeliveryStatus() изменит текущий статус доставки заказа

Параметры:

Integer  $statusId:

id объекта-статуса доставки

Результат:

getActualPrice()

Метод getActualPrice() Получит цену всего заказа с учетом скидки на этот заказ

Параметры:

Результат: Float actualPrice - цена с учетом скидки на заказ

getOriginalPrice()

Метод getOriginalPrice() Получит цену всего заказа без учета скидки на этот заказ

Параметры:

Результат: Float originalPrice - цена без учета скидки на заказ

getTotalAmount()

Метод getTotalAmount() получит количество наименований в заказе

Параметры:

Результат: Integer totalAmount - количество наименований в заказе

getDeliveryPrice()

Метод getDeliveryPrice() получит стоимость доставки

Параметры:

Результат: Integer delivery_price стоимость доставки

refresh()

Метод refresh() пересчитает содержимое корзины

Параметры:

Результат:

getCustomerId()

Метод getCustomerId() получит id клиента. Это может быть как id пользователя, так и id объекта временного покупателя

Параметры:

Результат: Integer id объекта-клиента

getDomain()

Метод getDomain() получит домен, в котором производится заказ

Параметры:

Результат: $domain

setDomainId()

Метод setDomainId() изменит домен, в котором производится заказ

Параметры:

domain   $domain:

Результат:

getDiscount()

Метод getDiscount() получит текущую скидку на этот заказ

Параметры:

Результат: discount скидка на заказ

setDiscount()

Метод setDiscount() Назначит скидку на заказ

Параметры:

discount $discount:

скидка на заказ, по умолчанию null

Результат:

getBonusDiscount()

Метод getBonusDiscount() получит размер оплаты бонусами.

Параметры:

Результат: float размер оплаты

setBonusDiscount()

Метод setBonusDiscount() установит оплату бонусом.

Параметры:

Integer  $id:

идентификатор объекта статуса заказа

Результат:String codename код статуса заказа

getCodeByStatus()

Метод getCodeByStatus() получит код статуса заказа.

Параметры:

float  $bonus:

сумма списываемых баллов

Результат:

generateNumber()

Метод generateNumber() сгенерирует номер заказа.

Параметры:

Результат:

order()

Метод order() сохранит заказ в базе со статусом "в обработке(waiting)", т.е. этот заказ уже не будет являтсья "текущей корзиной товаров"

Параметры:

Результат:true в случае сохранения заказа, false в противном случае

readItems()

Метод readItems() запишет в массив items[] список наименований в заказе из объекта заказа

Параметры:

Результат:

applyItems()

Метод applyItems() сохранить данные о наименованиях заказа в объект заказа

Параметры:

Результат:

searchDiscount()

Метод searchDiscount() определит скидку для заказа.

Параметры:

Результат: orderDiscount $discount - скидка заказа

reserve()

Метод reserve() зарезервирует наименования в заказе

Параметры:

Результат:

unreserve()

Метод unreserve() отменить резервирование наименований в заказе.

Параметры:

Результат:

writeOff()

Метод writeOff() спишет из магазина зарезервированные наименования

Параметры:

Результат: true, если наименования списаны, false в противном случае

getPrimaryStore()

Метод getPrimaryStore() получит основной склад.

Параметры:

Результат:first - основной склад

getAdvParamFromUrl()

Метод getAdvParamFromUrl() получит параметры рекламной компании.

Параметры:

$url: адрес на который пришёл пользователь

$refer: адрес с которого пришёл пользователь, по умолчанию null

Результат: array $params

parseUrlReferer()

Метод parseUrlReferer() найдет в URL ключевые слова и источник перехода

Параметры:

$url: адрес с которого пришёл пользователь (referer)

Результат: array $query