Класс OrderBase

Граф наследования:OrderBase:

Открытые члены
	getInternalId ()
	isSaveRunning ()
	appendBasket (BasketBase $basket)
	getBasket ()
	setField ($name, $value)
	setFieldNoDemand ($name, $value)
	getField ($name)
	initField ($name, $value)
	getPropertyCollection ()
	onPropertyValueCollectionModify ($action, EntityPropertyValue $property, $name=null, $oldValue=null, $value=null)
	getPersonTypeId ()
	setPersonTypeId ($personTypeId)
	getPrice ()
	getBasePrice ()
	getSumPaid ()
	getDeliveryPrice ()
	getDeliveryLocation ()
	getTaxPrice ()
	getTaxValue ()
	getDiscountPrice ()
	getCurrency ()
	getUserId ()
	getSiteId ()
	isUsedVat ()
	getVatRate ()
	getVatSum ()
	isMarked ()
	refreshVat ()
	isShipped ()
	isExternal ()
	setVatSum ($price)
	setVatDelivery ($price)
	getDateInsert ()
	getCalculateType ()
	onBeforeBasketRefresh ()
	onAfterBasketRefresh ()
	getTax ()
	isNew ()
	resetTax ()
	clearChanged ()
	isClone ()
	isPaid ()
	isAllowDelivery ()
	isDeducted ()
	isCanceled ()
	getTaxLocation ()
	isMathActionOnly ()
	hasMeaningfulField ()
	clearStartField ()
	isStartField ($isMeaningfulField=false)
	setMathActionOnly ($value=false)
	getDiscount ()
	resetData ($select=array('PRICE'))
	toArray ()
Открытые члены унаследованные от Entity
	__construct ()
	fetch (Main\Text\Converter $converter=null)

Открытые статические члены
static	getAvailableFields ()
static	getRegistryEntity ()
static	create ($siteId, $userId=null, $currency=null)
static	load ($id)
static	loadByAccountNumber ($value)
static	getList (array $parameters=array())
static	getUfId ()
static	getSettableFields ()
static	getEntityEventName ()
Открытые статические члены унаследованные от Entity
static	getEntity ()
static	getRow (array $parameters)
static	clearCache ()
static	add (array $data)
static	update ($id, array $data)
static	delete ($id)
static	setCacheItem ($id, array $row)
static	getCacheItem ($id, bool $load=false)
static	clearCacheItem ($id)
static	getTabletClassName ()
static	getTabletFieldNames (int $fields=self::FIELDS_MAIN)
static	getCachedFieldList ()
static	getCallbackRestEvent ()
static	clearSettings ()

Открытые атрибуты
const	SALE_ORDER_CALC_TYPE_NEW = 'N'
const	SALE_ORDER_CALC_TYPE_CHANGE = 'C'
const	SALE_ORDER_CALC_TYPE_REFRESH = 'R'
Открытые атрибуты унаследованные от Entity
const	PREFIX_OLD = 'OLD_'
const	EVENT_ON_BUILD_CACHED_FIELD_LIST = 'OnBuildCachedFieldList'
const	FIELDS_MAIN = 0x0001
const	FIELDS_UF = 0x0002
const	FIELDS_ALL = self::FIELDS_MAIN|self::FIELDS_UF

Защищенные члены
	__construct (array $fields=array())
	checkValueBeforeSet ($name, $value)
	normalizeValue ($name, $value)
	isPriceField (string $name)
	resetVat ()
	calculateVat ()
	isCalculatedField ($field)
	onAfterSave ()
	callDelayedEvents ()
	completeSaving ($needUpdateDateInsert)
	add ()
	update ()
	callEventOnSaleOrderSaved ()
	saveEntities ()
	setAccountNumber ()
	onOrderModify ($name, $oldValue, $value)
	calculatePrice ()
	onBeforeSave ()
	addInternal (array $data)
Защищенные члены унаследованные от Entity
	getTablet ()

Защищенные статические члены
static	getCalculatedFields ()
static	getMeaningfulFields ()
static	generateXmlId ()
static	loadFromDb (array $parameters)
static	isExists ($id)
static	deleteExternalEntities ($orderId)
static	updateInternal ($primary, array $data)
static	deleteInternal ($primary)
Защищенные статические члены унаследованные от Entity
static	prepareForAdd (ORM\Data\AddResult $result, $id, array &$data)
static	prepareForUpdate (ORM\Data\UpdateResult $result, $id, array &$data)
static	deleteNoDemands ($id)
static	normalize (array &$data)
static	runAddExternalActions ($id, array $data)
static	runUpdateExternalActions ($id, array $data)
static	runDeleteExternalActions ($id)
static	getDefaultCachedFieldList ()
static	prepareFloatValue ($value)
static	prepareIntValue ($value)
static	prepareStringValue ($value)

Защищенные данные
	$calculatedFields = null
	$basketCollection
	$propertyCollection
	$discount = null
	$tax = null
	$internalId = 0
	$isNew = true
	$isSaveExecuting = false
	$isClone = false
	$isOnlyMathAction = null
	$isMeaningfulField = false
	$isStartField = null
	$calculateType = null

Подробное описание

См. определение в файле orderbase.php строка 23

Конструктор(ы)

__construct()

__construct ( array $fields = array() )

protected

OrderBase constructor.

Аргументы

array

$fields

Исключения

Main

ArgumentNullException

См. определение в файле orderbase.php строка 74

Методы

add()

add ( )

protected

Возвращает

Result

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotImplementedException

Исключения

Main

SystemException

См. определение в файле orderbase.php строка 1272

addInternal()

addInternal ( array $data )

abstractprotected

Аргументы

array

$data

Исключения

Main

NotImplementedException

Возвращает

Main\Entity\AddResult

Переопределяется в Order.

appendBasket()

appendBasket

(

BasketBase

$basket

)

Append basket to order

Аргументы

BasketBase

$basket

Возвращает

Result

Исключения

Main

NotSupportedException

См. определение в файле orderbase.php строка 397

calculatePrice()

calculatePrice ( )

protected

Возвращает

float

Переопределяется в Order.

См. определение в файле orderbase.php строка 2419

calculateVat()

calculateVat ( )

protected

Calculate VAT

Возвращает

array

См. определение в файле orderbase.php строка 964

callDelayedEvents()

callDelayedEvents ( )

protected

Исключения

Main

ArgumentException

Исключения

Main

NotImplementedException

Возвращает

void

См. определение в файле orderbase.php строка 1203

callEventOnSaleOrderSaved()

callEventOnSaleOrderSaved ( )

protected

Возвращает

void

См. определение в файле orderbase.php строка 1392

checkValueBeforeSet()

checkValueBeforeSet ( $name, $value )

protected

Аргументы

$name
$value

Возвращает

Result

Исключения

Main

NotImplementedException

См. определение в файле orderbase.php строка 473

clearChanged()

clearChanged

(

)

Переопределяется в Order.

См. определение в файле orderbase.php строка 1907

clearStartField()

clearStartField

(

)

Reset order flags: \Bitrix\Sale\OrderBase::$isStartField, \Bitrix\Sale\OrderBase::$isMeaningfulField

Возвращает

void

См. определение в файле orderbase.php строка 2091

completeSaving()

completeSaving ( $needUpdateDateInsert )

protected

Аргументы

$needUpdateDateInsert

Возвращает

Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotImplementedException

См. определение в файле orderbase.php строка 1231

create()

static create ( $siteId, $userId = null, $currency = null )

static

Create \Bitrix\Sale\OrderBase object

Аргументы

	$siteId
null	$userId
null	$currency

Возвращает

static

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotImplementedException

Исключения

Main

ObjectException

См. определение в файле orderbase.php строка 195

deleteExternalEntities()

static deleteExternalEntities ( $orderId )

staticprotected

Аргументы

$orderId

См. определение в файле orderbase.php строка 2329

deleteInternal()

static deleteInternal ( $primary )

staticprotected

Аргументы

$primary

Исключения

Main

NotImplementedException

Возвращает

Main\Entity\DeleteResult

Переопределяется в Order.

См. определение в файле orderbase.php строка 2812

generateXmlId()

static generateXmlId ( )

staticprotected

Возвращает

string

См. определение в файле orderbase.php строка 233

getAvailableFields()

static getAvailableFields ( )

static

Return field names that can set in \Bitrix\Sale\OrderBase::setField

Возвращает

array

См. определение в файле orderbase.php строка 103

getBasePrice()

getBasePrice

(

)

Returns order price without discounts.

Возвращает

float

Переопределяется в Order.

См. определение в файле orderbase.php строка 732

getBasket()

getBasket

(

)

Return order basket.

Возвращает

BasketBase

См. определение в файле orderbase.php строка 415

getCalculatedFields()

static getCalculatedFields ( )

staticprotected

Return virtual field names

Возвращает

array

См. определение в файле orderbase.php строка 125

getCalculateType()

getCalculateType

(

)

Return value: OrderBase::SALE_ORDER_CALC_TYPE_REFRESH, OrderBase::SALE_ORDER_CALC_TYPE_CHANGE, OrderBase::SALE_ORDER_CALC_TYPE_NEW

Возвращает

null|string

См. определение в файле orderbase.php строка 1541

getCurrency()

getCurrency

(

)

Return currency

Возвращает

string

См. определение в файле orderbase.php строка 797

getDateInsert()

getDateInsert

(

)

Return date order insert

Возвращает

mixed

См. определение в файле orderbase.php строка 1531

getDeliveryLocation()

getDeliveryLocation

(

)

Возвращает

float

См. определение в файле orderbase.php строка 761

getDeliveryPrice()

getDeliveryPrice

(

)

Возвращает

float

См. определение в файле orderbase.php строка 753

getDiscount()

getDiscount

(

)

Return discount object

Возвращает

Discount

См. определение в файле orderbase.php строка 2370

getDiscountPrice()

getDiscountPrice

(

)

Return discount price

Возвращает

float

См. определение в файле orderbase.php строка 787

getEntityEventName()

static getEntityEventName ( )

static

См. определение в файле orderbase.php строка 2842

getField()

getField

(

$name

)

Return field value

Аргументы

$name

Возвращает

null|string

См. определение в файле orderbase.php строка 547

getInternalId()

getInternalId

(

)

Return internal index of order

Возвращает

int

См. определение в файле orderbase.php строка 86

getList()

static getList ( array $parameters = array() )

static

Get order information

Аргументы

array

$parameters

Исключения

Main

NotImplementedException

Возвращает

Main\DB\Result

Переопределяет метод предка Entity.

Переопределяется в Order.

См. определение в файле orderbase.php строка 2042

getMeaningfulFields()

static getMeaningfulFields ( )

staticprotected

Возвращает

array

См. определение в файле orderbase.php строка 157

getPersonTypeId()

getPersonTypeId

(

)

Return person type id of order

Возвращает

int

См. определение в файле orderbase.php строка 700

getPrice()

getPrice

(

)

Return order price

Возвращает

float

См. определение в файле orderbase.php строка 722

getPropertyCollection()

getPropertyCollection

(

)

Возвращает

PropertyValueCollectionBase

Исключения

Main

ArgumentException

Исключения

Main

NotImplementedException

Исключения

Main

ObjectPropertyException

Исключения

Main

SystemException

См. определение в файле orderbase.php строка 589

getRegistryEntity()

static getRegistryEntity ( )

static

Возвращает

string

См. определение в файле orderbase.php строка 179

getSettableFields()

static getSettableFields ( )

static

Возвращает

array

См. определение в файле orderbase.php строка 2832

getSiteId()

getSiteId

(

)

Return site id

Возвращает

null|string

См. определение в файле orderbase.php строка 855

getSumPaid()

getSumPaid

(

)

Return paid sum

Возвращает

float

См. определение в файле orderbase.php строка 745

getTax()

getTax

(

)

Get the entity of taxes

Возвращает

Tax

См. определение в файле orderbase.php строка 1836

getTaxLocation()

getTaxLocation

(

)

Return tax location

Возвращает

null|string

См. определение в файле orderbase.php строка 2052

getTaxPrice()

getTaxPrice

(

)

Возвращает

float

См. определение в файле orderbase.php строка 769

getTaxValue()

getTaxValue

(

)

Возвращает

float

См. определение в файле orderbase.php строка 777

getUfId()

static getUfId ( )

static

Return user field id

Возвращает

null

Переопределяется в Order.

См. определение в файле orderbase.php строка 2822

getUserId()

getUserId

(

)

Return user id

Возвращает

int

См. определение в файле orderbase.php строка 845

getVatRate()

getVatRate

(

)

Return order vat rate

Возвращает

mixed|null

См. определение в файле orderbase.php строка 881

getVatSum()

getVatSum

(

)

Return order vat sum

Возвращает

float

См. определение в файле orderbase.php строка 897

hasMeaningfulField()

hasMeaningfulField

(

)

Возвращает

bool

См. определение в файле orderbase.php строка 2081

initField()

initField	(		$name,
			$value )

См. определение в файле orderbase.php строка 567

isAllowDelivery()

isAllowDelivery

(

)

Return TRUE, if order is allowed delivery. Else return FALSE

Возвращает

bool

См. определение в файле orderbase.php строка 1948

isCalculatedField()

isCalculatedField ( $field )

protected

Аргументы

$field

Возвращает

bool

См. определение в файле orderbase.php строка 1034

isCanceled()

isCanceled

(

)

Return TRUE, if order is canceled. Else return FALSE

Возвращает

bool

См. определение в файле orderbase.php строка 1968

isClone()

isClone

(

)

Return TRUE, if this order is cloned. Else return FALSE

Возвращает

bool

См. определение в файле orderbase.php строка 1928

isDeducted()

isDeducted

(

)

Return TRUE, if order is deducted. Else return FALSE

Возвращает

bool

См. определение в файле orderbase.php строка 1958

isExists()

static isExists ( $id )

staticprotected

Аргументы

$id

Возвращает

bool

Исключения

Main

NotImplementedException

См. определение в файле orderbase.php строка 2299

isExternal()

isExternal

(

)

Return TRUE if order is external. Else return FALSE

Возвращает

bool

См. определение в файле orderbase.php строка 1025

isMarked()

isMarked

(

)

Return TRUE if order has problems. Else return FALSE

Возвращает

null|string

См. определение в файле orderbase.php строка 912

isMathActionOnly()

isMathActionOnly

(

)

Return TRUE if calculations are based on current values. Data from the provider is not requested. Else return false

Возвращает

bool

См. определение в файле orderbase.php строка 2073

isNew()

isNew

(

)

См. определение в файле orderbase.php строка 1852

isPaid()

isPaid

(

)

Return TRUE, if order is payed. Else return FALSE

Возвращает

bool

См. определение в файле orderbase.php строка 1938

isPriceField()

isPriceField ( string $name )

protected

См. определение в файле orderbase.php строка 917

isSaveRunning()

isSaveRunning

(

)

Возвращает

bool

См. определение в файле orderbase.php строка 149

isShipped()

isShipped

(

)

Return TRUE if order is deducted. Else return FALSE

Возвращает

string

Переопределяется в Order.

См. определение в файле orderbase.php строка 1015

isStartField()

isStartField

(

$isMeaningfulField = false

)

Аргументы

bool

$isMeaningfulField

Возвращает

bool

См. определение в файле orderbase.php строка 2101

isUsedVat()

isUsedVat

(

)

Return TRUE if VAT is used. Else return FALSE

Возвращает

bool

См. определение в файле orderbase.php строка 865

load()

static load ( $id )

static

Load order object by id

Аргументы

int

$id

Возвращает

null|static

Исключения

Main

ArgumentNullException

См. определение в файле orderbase.php строка 245

loadByAccountNumber()

static loadByAccountNumber ( $value )

static

Load object order by account number

Аргументы

$value

Возвращает

mixed|null

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

NotImplementedException

См. определение в файле orderbase.php строка 337

loadFromDb()

static loadFromDb ( array $parameters )

staticprotected

Аргументы

array

$parameters

Возвращает

Main\DB\Result

Исключения

Main

NotImplementedException

См. определение в файле orderbase.php строка 359

normalizeValue()

normalizeValue ( $name, $value )

protected

См. определение в файле orderbase.php строка 497

onAfterBasketRefresh()

onAfterBasketRefresh

(

)

См. определение в файле orderbase.php строка 1826

onAfterSave()

onAfterSave ( )

protected

Возвращает

Result

Переопределяется в Order.

См. определение в файле orderbase.php строка 1193

onBeforeBasketRefresh()

onBeforeBasketRefresh

(

)

Переопределяется в Order.

См. определение в файле orderbase.php строка 1817

onBeforeSave()

onBeforeSave ( )

protected

Возвращает

Result

См. определение в файле orderbase.php строка 2430

onOrderModify()

onOrderModify ( $name, $oldValue, $value )

protected

Аргументы

$name
$oldValue
$value

Возвращает

Result

Переопределяется в Order.

См. определение в файле orderbase.php строка 1742

onPropertyValueCollectionModify()

onPropertyValueCollectionModify	(		$action,
		EntityPropertyValue	$property,
			$name = null,
			$oldValue = null,
			$value = null )

См. определение в файле orderbase.php строка 625

refreshVat()

refreshVat

(

)

См. определение в файле orderbase.php строка 946

resetData()

resetData

(

$select = array('PRICE')

)

Reset the value of the order and delivery

Переопределяется в Order.

См. определение в файле orderbase.php строка 2675

resetTax()

resetTax

(

)

Reset the value of taxes

См. определение в файле orderbase.php строка 1862

resetVat()

resetVat ( )

protected

Clear VAT info

Исключения

Main

ArgumentOutOfRangeException

См. определение в файле orderbase.php строка 932

saveEntities()

saveEntities ( )

protected

Возвращает

Result

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

NotImplementedException

Исключения

Main

ObjectNotFoundException

Исключения

Main

ObjectPropertyException

Исключения

Main

SystemException

См. определение в файле orderbase.php строка 1462

setAccountNumber()

setAccountNumber ( )

protected

Set account number.

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotImplementedException

Исключения

Main

SystemException

См. определение в файле orderbase.php строка 1495

setField()

setField	(		$name,
			$value )

Set value with call events on field modify

Аргументы

$name
$value

Возвращает

Result

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotImplementedException

См. определение в файле orderbase.php строка 456

setFieldNoDemand()

setFieldNoDemand	(		$name,
			$value )

См. определение в файле orderbase.php строка 517

setMathActionOnly()

setMathActionOnly

(

$value = false

)

См. определение в файле orderbase.php строка 2127

setPersonTypeId()

setPersonTypeId

(

$personTypeId

)

Set person type id of order

Аргументы

$personTypeId

Возвращает

Result

См. определение в файле orderbase.php строка 712

setVatDelivery()

setVatDelivery

(

$price

)

Set VAT delivery sum

Аргументы

$price

См. определение в файле orderbase.php строка 1521

setVatSum()

setVatSum

(

$price

)

Set VAT sum

Аргументы

$price

См. определение в файле orderbase.php строка 1511

toArray()

toArray

(

)

Переопределяется в Order.

См. определение в файле orderbase.php строка 2847

update()

update ( )

protected

Возвращает

Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotImplementedException

См. определение в файле orderbase.php строка 1330

updateInternal()

static updateInternal ( $primary, array $data )

staticprotected

Аргументы

	$primary
array	$data

Исключения

Main

NotImplementedException

Возвращает

Main\Entity\UpdateResult

Переопределяется в Order.

См. определение в файле orderbase.php строка 2802

Данные класса

$basketCollection

BasketBase $basketCollection

protected

См. определение в файле orderbase.php строка 29

$calculatedFields

$calculatedFields = null

protected

См. определение в файле orderbase.php строка 26

$calculateType

null string $calculateType = null

protected

См. определение в файле orderbase.php строка 63

$discount

Discount $discount = null

protected

См. определение в файле orderbase.php строка 35

$internalId

$internalId = 0

protected

См. определение в файле orderbase.php строка 41

$isClone

bool $isClone = false

protected

См. определение в файле orderbase.php строка 50

$isMeaningfulField

bool $isMeaningfulField = false

protected

См. определение в файле orderbase.php строка 56

$isNew

bool $isNew = true

protected

См. определение в файле orderbase.php строка 44

$isOnlyMathAction

bool $isOnlyMathAction = null

protected

См. определение в файле orderbase.php строка 53

$isSaveExecuting

$isSaveExecuting = false

protected

См. определение в файле orderbase.php строка 47

$isStartField

bool $isStartField = null

protected

См. определение в файле orderbase.php строка 59

$propertyCollection

PropertyValueCollectionBase $propertyCollection

protected

См. определение в файле orderbase.php строка 32

$tax

Tax $tax = null

protected

См. определение в файле orderbase.php строка 38

SALE_ORDER_CALC_TYPE_CHANGE

const SALE_ORDER_CALC_TYPE_CHANGE = 'C'

См. определение в файле orderbase.php строка 66

SALE_ORDER_CALC_TYPE_NEW

const SALE_ORDER_CALC_TYPE_NEW = 'N'

См. определение в файле orderbase.php строка 65

SALE_ORDER_CALC_TYPE_REFRESH

const SALE_ORDER_CALC_TYPE_REFRESH = 'R'

См. определение в файле orderbase.php строка 67