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 |
| 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-2024, «1С-Битрикс», 2024
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.