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

Материал из Umicms
Перейти к:навигация, поиск
 
(не показано 8 промежуточных версий 1 участника)
Строка 6: Строка 6:
 
Исходный код класса находится в файле classes\modules\emarket\classes\order\orderItem.php
 
Исходный код класса находится в файле classes\modules\emarket\classes\order\orderItem.php
  
−
== Свойства класса ==
+
== Методы ==
 +
 
 +
=== create() ===
 +
 
 +
Экземпляр класса создается с помощью функции <span style="font-weight:bold">create()</span>
 +
 
 +
<p>'''Параметры:''' </p><br/>
 +
Integer <span style="font-weight:bold"> $elementId</span>:
 +
id страницы-объекта каталога<br/>
 +
Integer|Boolean <span style="font-weight:bold"> $storeId</span>:
 +
id склада, на котором находится товар, по умолчанию false<br/>
 +
<p>'''Результат:'''orderItem товар в заказе </p>
 +
 
 +
=== get() ===
 +
 
 +
Метод <span style="font-weight:bold">get()</span> экземпляр наименования в заказе с учетом текущих настроек интернет-магазина и типа товара.
 +
 
 +
 
 +
<p>'''Параметры:''' </p><br/>
 +
Integer <span style="font-weight:bold"> $objectId</span>:
 +
id объекта<br/>
 +
 
 +
<p>'''Результат:'''orderItem объект наименования в заказе </p>
 +
 
 +
 
 +
=== remove() ===
 +
 
 +
Метод <span style="font-weight:bold">remove()</span> удалит объект, представляющий товар в заказе
 +
 
 +
<p>'''Параметры:''' </p><br/>
 +
 
 +
 
 +
<p>'''Результат:'''</p>
 +
 
 +
 
 +
=== getName() ===
 +
 
 +
Метод <span style="font-weight:bold">getName()</span> получит название наименования
 +
 
 +
<p>'''Параметры:''' </p><br/>
 +
 
 +
 
 +
<p>'''Результат:''' String название наименования заказа</p>
 +
 
 +
 
 +
=== getAmount() ===
 +
 
 +
Метод <span style="font-weight:bold">getAmount()</span> получит количество товара, которое добавлено к заказу
 +
 
 +
<p>'''Параметры:''' </p><br/>
 +
 
 +
 
 +
<p>'''Результат:''' Integer количество товаров в заказе</p>
 +
 
 +
 
 +
=== setAmount() ===
 +
 
 +
Метод <span style="font-weight:bold">setAmount()</span> изменит количество товаров в заказе
 +
 
 +
<p>'''Параметры:''' </p><br/>
 +
Integer <span style="font-weight:bold"> $amount</span>:
 +
новое значение количества товаров в заказе<br/>
 +
 
 +
<p>'''Результат:'''</p>
 +
 
 +
=== getTotalOriginalPrice() ===
 +
 
 +
Метод <span style="font-weight:bold">getTotalOriginalPrice()</span> получит стоимость всего наименования без учета скидок
 +
 
 +
<p>'''Параметры:''' </p><br/>
 +
 
 +
 
 +
<p>'''Результат:'''Float стоимость наименования без учета скидок</p>
 +
 
 +
=== getTotalActualPrice() ===
 +
 
 +
Метод <span style="font-weight:bold">getTotalActualPrice()</span> получит стоимость всего наименования с учетом скидок
 +
 
 +
<p>'''Параметры:''' </p><br/>
 +
 
 +
 
 +
<p>'''Результат:'''Float стоимость наименования с учетом скидок</p>
 +
 
 +
=== getItemPrice() ===
 +
 
 +
Метод <span style="font-weight:bold">getItemPrice()</span> получитп стоимость одной единицы товара (без скидок)
 +
 
 +
<p>'''Параметры:''' </p><br/>
 +
 
 +
 
 +
<p>'''Результат:''' Float стоимость 1 единицы товара без скидки</p>
 +
 
 +
 
 +
=== getIsDigital() ===
 +
 
 +
Метод <span style="font-weight:bold">getIsDigital()</span> проверит, является ли товар цифровым.
  
−
$price, хранит цену на позицию в заказе
+
<p>'''Параметры:''' </p><br/>  
−
<source lang="php">
 
−
protected $price
 
−
</source>
 
  
−
$totalActualPrice хранит  актуальную цену на позицию в заказе(с учетом скидки)
 
−
<source lang="php">
 
−
protected $totalActualPrice;
 
−
</source>
 
  
−
$totalOriginalPrice хранит  первоначальную цену позиции в заказе(без учета скидки)
+
<p>'''Результат:''' Boolean true|false</p>
−
<source lang="php">
 
−
protected $originalPrice;
 
−
</source>
 
  
−
$amount хранит  количество позиции в заказе
 
−
<source lang="php">
 
−
protected $totalAmount;
 
−
</source>
 
  
 +
=== getItemElement() ===
  
 +
Метод <span style="font-weight:bold">getItemElement()</span> получит страницу-объект каталога, которая является товаром этого наименования.
  
−
$discount хранит объект "скидка на товар"
+
<p>'''Параметры:''' </p><br/>  
−
<source lang="php">
 
−
protected $discount;
 
−
</source>
 
  
  
−
$itemElement хранит страницу-объект каталога, которая является товаром этого наименования
+
<p>'''Результат:''' iUmiHierarchyElement объект в каталоге</p>
−
<source lang="php">
 
−
protected $itemElement;
 
−
</source>
 
  
  
−
$isDigital хранит true, если товар является цифровым, false(по умолчанию) в противном случае
+
=== getDiscount() ===
−
<source lang="php">
 
−
protected $isDigital;
 
−
</source>
 
  
 +
Метод <span style="font-weight:bold">getDiscount()</span>
 +
получит скидку, которая действует на наименование
 +
 +
<p>'''Параметры:''' </p><br/>
 +
 +
<p>'''Результат:'''itemDiscount скидка на наименование </p>
  
−
== Методы ==
 
  
−
=== create() ===
+
=== setDiscount() ===
  
−
Экземпляр класса создается с помощью функции <span style="font-weight:bold">create()</span>
+
Метод <span style="font-weight:bold">setDiscount()</span> установит скидку на наименование
  
 
<p>'''Параметры:''' </p><br/>  
 
<p>'''Параметры:''' </p><br/>  
−
Integer<span style="font-weight:bold"> $elementId</span>:
 
−
id страницы-объекта каталога<br/>
 
−
Integer|Boolean <span style="font-weight:bold"> $storeId</span>:
 
−
id склада, на котором находится товар, по умолчанию false<br/>
 
  
−
<p>'''Результат:'''orderItem товар в заказе </p>
+
itemDiscount<span style="font-weight:bold"> $discount</span>:
 +
объект скидка на товар<br/>
  
 +
<p>'''Результат:''' </p>
  
−
=== get() ===
 
  
−
Метод <span style="font-weight:bold">get()</span> экземпляр наименования в заказе с учетом текущих настроек интернет-магазина и типа товара.
+
=== refresh() ===
  
 +
Метод <span style="font-weight:bold">refresh()</span> пересчитает параметры наименования и обновит свойства наименования в БД
  
 
<p>'''Параметры:''' </p><br/>  
 
<p>'''Параметры:''' </p><br/>  
−
  Integer <span style="font-weight:bold"> $objectId</span>:
+
   
−
id объекта<br/>
+
 
 +
<p>'''Результат:'''вернет true в случае, если наименование существует и было обновлено, false в противном случае </p>
 +
 
 +
 
 +
== Дополнительно ==
 +
 
 +
Другие статьи по классам emarket:
  
−
<p>'''Результат:'''orderItem объект наименования в заказе </p>
+
<ul>
 +
<li>[[Класс customer модуля emarket]]</li>
 +
<li>[[Класс order модуля emarket]]</li>
 +
<li>[[Класс optionedOrderItem модуля emarket]]</li>
 +
<li>[[Класс delivery модуля emarket]]</li>
 +
<li>[[Класс discount модуля emarket]]</li>
 +
<li>[[Дочерние классы класса delivery модуля emarket]]</li>
 +
<li>[[Класс discountModificator и его дочерние классы (модуль emarket) ]]</li>
 +
<li>[[Дочерние классы класса discount модуля emarket]]</li>
 +
<li>[[Класс discountRule и его дочерние классы (модуль emarket) ]]</li>
 +
<li>[[Класс payment модуля emarket ]]</li>
 +
<li>[[Класс emarketTop модуля emarket ]]</li>
 +
<li>[[Класс currencyUpdater модуля emarket ]]</li>
 +
</ul>
 +
[[category:Модуль Интернет магазин]]

Текущая версия на 13:26, 16 июля 2018

Класс orderItem

Описание

Класс orderItem связывает объекты каталога в магазине и непосредственно заказ (корзину товаров). Исходный код класса находится в файле classes\modules\emarket\classes\order\orderItem.php

Методы

create()

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

Параметры: 


Integer  $elementId:

id страницы-объекта каталога

Integer|Boolean  $storeId:

id склада, на котором находится товар, по умолчанию false

Результат:orderItem товар в заказе

get()

Метод get() экземпляр наименования в заказе с учетом текущих настроек интернет-магазина и типа товара.


Параметры: 


Integer  $objectId:

id объекта

Результат:orderItem объект наименования в заказе


remove()

Метод remove() удалит объект, представляющий товар в заказе

Параметры:



Результат:


getName()

Метод getName() получит название наименования

Параметры:



Результат: String название наименования заказа


getAmount()

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

Параметры:



Результат: Integer количество товаров в заказе


setAmount()

Метод setAmount() изменит количество товаров в заказе

Параметры: 


Integer  $amount:

новое значение количества товаров в заказе

Результат:

getTotalOriginalPrice()

Метод getTotalOriginalPrice() получит стоимость всего наименования без учета скидок

Параметры:



Результат:Float стоимость наименования без учета скидок

getTotalActualPrice()

Метод getTotalActualPrice() получит стоимость всего наименования с учетом скидок

Параметры:



Результат:Float стоимость наименования с учетом скидок

getItemPrice()

Метод getItemPrice() получитп стоимость одной единицы товара (без скидок)

Параметры:



Результат: Float стоимость 1 единицы товара без скидки


getIsDigital()

Метод getIsDigital() проверит, является ли товар цифровым.

Параметры:



Результат: Boolean true|false


getItemElement()

Метод getItemElement() получит страницу-объект каталога, которая является товаром этого наименования.

Параметры:



Результат: iUmiHierarchyElement объект в каталоге


getDiscount()

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

Параметры:


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


setDiscount()

Метод setDiscount() установит скидку на наименование

Параметры: 


itemDiscount $discount:

объект скидка на товар

Результат:


refresh()

Метод refresh() пересчитает параметры наименования и обновит свойства наименования в БД

Параметры:



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


Дополнительно

Другие статьи по классам emarket:

Источник — «https://wiki.umisoft.ru/index.php?title=Класс_orderItem_модуля_emarket&oldid=8523»