Документация для разработчиков

OrderBase

\Bitrix\Sale\OrderBase - базовый класс заказа. Работает только с корзиной, свойствами, скидками и налогами.


Цепочка наследования

\Bitrix\Sale\OrderBase > \Bitrix\Sale\Internals\Entity

Методы класса

МетодОписание С версии
appendBasketПрикрепляет корзину к новому заказу. 17.5.0
applyDiscountПрименяет рассчитанные скидки к заказу. 18.0.0
createСоздает объект заказа. 15.5.0
deleteУдаляет заказ, предварительно отменяя заказ. 18.0.0
deleteNoDemandУдаляет заказ напрямую из базы. 18.0.0
doFinalActionВыполняет расчет скидок, налогов и применяет их к заказу. 18.0.0
getAvailableFieldsВозвращает массив полей, которые могут быть установлены через методы setField() и setFields(). 15.5.5
getBasketВозвращает объект корзины, прикрепленной к заказу. 15.5.0
getCurrencyВозвращает валюту заказа. 15.5.0
getDateInsertВозвращает дату создания заказа. 15.5.0
getDeliveryLocationВозвращает стоимость доставок для всех заказов. 15.5.0
getDeliveryPriceВозвращает стоимость доставок для всех заказов. 15.5.0
getDiscountВозвращает объект класса \Bitrix\Sale\DiscountBase. 18.0.0
getDiscountPriceВозвращает величину скидки/наценки на заказ. 15.5.0
getHashВозвращает хеш заказа. 18.0.0
getIdВозвращает ID заказа. 15.5.0
getPersonTypeIdВозвращает ID типа плательщика заказа, к которому привязан заказ. 15.5.0
getPriceВозвращает стоимость заказа с учетом скидок/наценок. 15.5.0
getPropertyCollectionВозвращает коллекцию значений свойств, привязанных к заказу 15.5.0
getRegistryTypeВозвращает тип реестра, которому относится объект. 18.0.0
getSiteIdВозвращает ID сайта, на котором оформлялся заказ. 15.5.0
getSumPaidВозвращает стоимость заказа, которую уже оплатили. 15.5.0
getTaxВозвращает объект класса \Bitrix\Sale\Tax. 17.5.0
getTaxLocationВозвращает ID местоположения которое используется для расчета налогов. 18.0.0
getTaxPriceВозвращает величину налога на заказ. 15.5.0
getTaxValueВозвращает ставку налога на заказ. 15.5.0
getUfIdВозвращает ID пользовательских полей. По умолчанию null. 18.0.0
getUserIdВозвращает ID покупателя. 15.5.0
getVatRateВозвращает ставку НДС, которая была применена. 15.5.0
getVatSumВозвращает общую величину НДС. 15.5.0
isAllowDeliveryВозвращает значение true, если для заказа разрешена доставка (иначе возвращает false). 18.0.0
isCanceledВозвращает значение true, если заказ отменен (иначе возвращает false). 18.0.0
isChangedВозвращает значение true, если заказ изменен (иначе возвращает false). 18.0.0
isExternalВозвращает true, если заказ пришел извне (например, из 1С). Иначе возвращает false. 15.5.2
isMarkedВозвращает true, если заказ промаркирован (иначе возвращается false). Заказы маркируются только в случае каких-либо ошибок. 16.0.22
isNotEmptyBasketВозвращает true, если корзина не пуста. В противном случае - false. 15.5.0
isPaidВозвращает значение true, если заказ оплачен (иначе возвращает false). 18.0.0
isShippedВозвращает true, если заказ отгружен (иначе возвращает false). 15.5.0
isUsedVatВозвращает true, если используется НДС (иначе возвращает false). 15.5.0
loadЗагружает заказ по ID и возвращает объект (либо null). 15.5.0
loadByAccountNumberЗагружает заказ по его номеру и возвращает объект (либо null). 18.0.0
loadByFilterВозвращает массив объектов заказа (либо null). 18.0.0
loadPropertyCollectionЗагружает коллекцию значений свойств, привязанных к заказу из базы данных. 15.5.0
refreshDataВыполняет пересчет заказа. 17.5.0
refreshVatВыполняет пересчет налогов. 15.5.0
resetDataСбрасывает информацию по заказу. 18.5.3
resetTaxСбрасывает информацию по налогам. 18.0.0
saveСохраняет заказ. 15.5.0
setBasketПрикрепляет корзину к новому заказу и актуализирует ее. При попытке прикрепить корзину к существующему заказу будет выброшено исключение: \Bitrix\Main\NotSupportedException. 18.0.0
setPersonTypeIdУстанавливает ID типа плательщика для заказа. 15.5.0
verifyПроверяет заказ и связанные с ним сущности на корректность. 18.0.0

Методы родительского класса \Bitrix\Sale\Internals\Entity

МетодОписание С версии
doFinalActionАбстрактный метод, предназначенный для реализации логики "конечных" расчетов. 15.5.0
getAvailableFieldsВозвращает массив полей, которые могут быть установлены через методы setField() и setFields(). 15.5.0
getAvailableFieldsMapВозвращает массив полей, которые могут быть установлены через методы setField() и setFields(). В качестве ключей массива выступают значения getAvailableFields. 17.5.0
getFieldВозвращает значение поля $name. 18.0.3
getFieldValuesВозвращает массив полей со значениями. 15.5.0
getIdВозвращает идентификатор сущности. 15.5.0
initFieldИнициализирует поле значением. При этом объект не считается измененным. 15.5.0
initFieldsИнициализирует поля значениями. При этом объект не считается измененным. 15.5.0
isChangedПроверяет, была ли изменена сущность. Если да, то возвращает true, иначе false. 15.5.2
isMathActionOnlyПроверяет, идет ли расчет на текущих данных (данные из провайдера не запрашиваются). Если да, то возвращает true, иначе false. 15.5.0
setFieldУстанавливает значение поля $name. 15.5.0
setFieldsИнициализирует поля значениями. При этом объект не считается измененным. 15.5.0
setMathActionOnlyОтключает запросы к провайдеру при выполнении расчетов. 15.5.0
verifyПроверяет, корректен ли объект. Возвращает объект \Bitrix\Sale\Result. 16.0.0


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх