Класс order модуля emarket — различия между версиями

Материал из Umicms
Перейти к:навигация, поиск
Строка 81: Строка 81:
 
   
 
   
 
<p>'''Результат:'''String codename код статуса заказа </p>
 
<p>'''Результат:'''String codename код статуса заказа </p>
br/
+
 
br/
+
=== getItems() ===
 +
 
 +
Метод <span style="font-weight:bold">getItems()</span> получит список наименований в заказе.
 +
 
 +
<p>'''Параметры:''' </p><br/>
 +
 
 +
<p>'''Результат:'''Array массив, состоящий из экземпляров класса orderItem </p>
 +
 
 +
=== appendItem() ===
 +
 
 +
Метод <span style="font-weight:bold">appendItem()</span> добавит наименование в заказ.
 +
<p>'''Параметры:''' </p><br/>
 +
orderItem <span style="font-weight:bold"> $orderItem</span>:
 +
 
 +
наименование заказа<br/>
 +
 +
<p>'''Результат:''' вернет false, если наименование с таким id уже есть в заказе</p>
 +
 
 +
 
 +
=== removeItem() ===
 +
 
 +
Метод <span style="font-weight:bold">removeItem()</span> удалит наименование из заказа.После удаления из заказа объект orderItem будет уничтожен
 +
<p>'''Параметры:''' </p><br/>
 +
orderItem <span style="font-weight:bold"> $orderItem</span>:
 +
 
 +
наименование в заказе<br/>
 +
 +
<p>'''Результат:''' вернет true, если наименование было удалено, false в противном случае</p>
 +
 
 +
=== getItem() ===
 +
 
 +
Метод <span style="font-weight:bold">getItem()</span> получит
 +
экземпляр наименования заказа по id
 +
<p>'''Параметры:''' </p><br/>
 +
Integer <span style="font-weight:bold"> $itemId</span>:
 +
 
 +
id наименования<br/>
 +
 +
<p>'''Результат:''' orderItem, если наименование получить не удалось - false</p>

Версия 08:41, 22 марта 2014

Класс 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