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

Открытые члены
	getShipmentCode ()
	setDeliveryService (Delivery\Services\Base $service)
	needReservation ()
	onShipmentItemCollectionModify ($action, ShipmentItem $shipmentItem, $name=null, $oldValue=null, $value=null)
	delete ()
	setField ($name, $value)
	setFieldNoDemand ($name, $value)
	getParentOrderId ()
	getOrder ()
	getPrice ()
	isCustomPrice ()
	getCurrency ()
	getDeliveryId ()
	getDeliveryName ()
	setOrderId ($orderId)
	getDelivery ()
	isSystem ()
	isCanceled ()
	isShipped ()
	getShippedDate ()
	getShippedUserId ()
	getUnshipReason ()
	isMarked ()
	isAllowDelivery ()
	isEmpty ()
	getAllowDeliveryDate ()
	getAllowDeliveryUserId ()
	getCompanyId ()
	tryReserve ()
	tryUnreserve ()
	tryUnship ()
	needShip ()
	deliver ()
	allowDelivery ()
	disallowDelivery ()
	onBeforeBasketItemDelete (BasketItem $basketItem)
	getServiceParams ()
	setServiceParams (array $serviceParams)
	getExtraServices ()
	setExtraServices (array $extraServices)
	getExtraServicesObjects ()
	getStoreId ()
	setStoreId (int $storeId)
	getWeight ()
	setWeight (float $weight)
	calculateDelivery ()
	resetData ()
	getBusinessValueProviderInstance ($mapping)
	getPersonTypeId ()
	getAutoFixErrorsList ()
	tryFixError ($code)
	canMarked ()
	getMarkField ()
	isChanged ()
	getVatRate ()
	getVatSum ()
	setBasePriceDelivery ($value, $custom=false)
	toArray ()
	getPropertyCollection ()
	getParentOrder ()
Открытые члены унаследованные от CollectableEntity
	setCollection (EntityCollection $collection)
	getCollection ()
	setInternalIndex ($index)
	getInternalIndex ()
	isStartField ($isMeaningfulField=false)
	clearStartField ()
	hasMeaningfulField ()
	doFinalAction ($hasMeaningfulField=false)
	setMathActionOnly ($value=false)
	isMathActionOnly ()
	isClone ()
Открытые члены унаследованные от Entity
	__construct ()
	fetch (Main\Text\Converter $converter=null)
Открытые члены унаследованные от IEntityMarker
	getErrorEntity ($value)
	canAutoFixError ($value)

Открытые статические члены
static	getRegistryEntity ()
static	getAvailableFields ()
static	getCustomizableFields ()
static	getRegistryType ()
static	deleteNoDemand ($orderId)
static	loadForOrder ($id)
static	createSystem (ShipmentCollection $collection, Delivery\Services\Base $deliveryService=null)
static	getList (array $parameters)
static	fixReserveErrors (Shipment $entity)
static	fixShipErrors (Shipment $entity)
static	getUfId ()
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 ()

Защищенные члены
	onBeforeSetFields (array $values)
	deleteDeliveryRequest ()
	normalizeValue ($name, $value)
	checkValueBeforeSet ($name, $value)
	setDeliveryRequestMarker ()
	onAfterSave ($isNew)
	markSystem ()
	isPriceField (string $name)
	loadDeliveryService ()
	saveExtraServices ()
	saveStoreId ()
	addInternal (array $data)
	updateInternal ($primary, array $data)
Защищенные члены унаследованные от CollectableEntity
	onFieldModify ($name, $oldValue, $value)
Защищенные члены унаследованные от Entity
	getTablet ()

Защищенные статические члены
static	getMeaningfulFields ()
static	generateXmlId ()
static	getParametersForLoad ($id)
static	getFixMethod ($code)
static	getAutoFixRules ()
static	deleteInternal ($primary)
static	getFieldsMap ()
Защищенные статические члены унаследованные от 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)

Защищенные данные
	$shipmentItemCollection
	$service = null
	$extraServices = null
bool	$areExtraServicesChanged = false
	$storeId = null
bool	$isStoreIdChanged = false
	$internalId = 0
	$propertyCollection
	$isNew = true
Защищенные данные унаследованные от CollectableEntity
	$collection
	$internalIndex = null
	$isClone = false

Статические защищенные данные
static	$idShipment = 0

Дополнительные унаследованные члены
Поля данных унаследованные от 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

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

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

Методы

◆ addInternal()

addInternal ( array $data )

protected

Аргументы

array $data

Возвращает: Entity\AddResult

Исключения

Exception

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

◆ allowDelivery()

allowDelivery ( )

Возвращает: Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

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

◆ calculateDelivery()

calculateDelivery ( )

Возвращает: Delivery\CalculationResult

Исключения

Main

NotSupportedException

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

◆ canMarked()

canMarked ( )

Возвращает: bool

Замещает IEntityMarker.

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

◆ checkValueBeforeSet()

checkValueBeforeSet	(		$name,
			$value )

protected

Аргументы

$name
$value

Возвращает: Result

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ createSystem()

createSystem	(	ShipmentCollection	$collection,
		Delivery\Services\Base	$deliveryService = null )

static

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

◆ delete()

delete ( )

Deletes shipment

Возвращает: Result

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Main

ObjectNotFoundException

Исключения

Exception

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

◆ deleteDeliveryRequest()

deleteDeliveryRequest ( )

protected

Возвращает: void

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

◆ deleteInternal()

deleteInternal ( $primary )

staticprotected

Аргументы

$primary

Возвращает: Entity\DeleteResult

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

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

◆ deleteNoDemand()

deleteNoDemand ( $orderId )

static

Аргументы

$orderId

Возвращает: Result

Исключения

Main

ArgumentException

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

◆ deliver()

deliver ( )

Возвращает: Result

Исключения

Main

ObjectNotFoundException

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

◆ disallowDelivery()

disallowDelivery ( )

Возвращает: Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

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

◆ fixReserveErrors()

fixReserveErrors ( Shipment $entity )

static

Аргументы

Shipment $entity

Возвращает: Result

Исключения

Main

ObjectNotFoundException

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

◆ fixShipErrors()

fixShipErrors ( Shipment $entity )

static

Аргументы

Shipment $entity

Возвращает: Result

Исключения

Main

ObjectNotFoundException

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

◆ generateXmlId()

generateXmlId ( )

staticprotected

Возвращает: string

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

◆ getAllowDeliveryDate()

getAllowDeliveryDate ( )

Возвращает: Main\Type\DateTime

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

◆ getAllowDeliveryUserId()

getAllowDeliveryUserId ( )

Возвращает: int

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

◆ getAutoFixErrorsList()

getAutoFixErrorsList ( )

Возвращает: array

Замещает IEntityMarker.

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

◆ getAutoFixRules()

getAutoFixRules ( )

staticprotected

Возвращает: array

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

◆ getAvailableFields()

getAvailableFields ( )

static

Возвращает: array

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

◆ getBusinessValueProviderInstance()

getBusinessValueProviderInstance ( $mapping )

Аргументы

$mapping

Возвращает: Shipment|null|string

Замещает IBusinessValueProvider.

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

◆ getCompanyId()

getCompanyId ( )

Возвращает: int

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

◆ getCurrency()

getCurrency ( )

Возвращает: string

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

◆ getCustomizableFields()

getCustomizableFields ( )

static

Возвращает: array

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

◆ getDelivery()

getDelivery ( )

Возвращает: Delivery\Services\Base

Исключения

Main

ArgumentNullException

Исключения

Main

SystemException

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

◆ getDeliveryId()

getDeliveryId ( )

Возвращает: int

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

◆ getDeliveryName()

getDeliveryName ( )

Возвращает: string

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

◆ getEntityEventName()

getEntityEventName ( )

static

Возвращает: null|string

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

◆ getExtraServices()

getExtraServices ( )

Возвращает: array

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

◆ getExtraServicesObjects()

getExtraServicesObjects ( )

Возвращает: Delivery\ExtraServices\Base[]

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

◆ getFieldsMap()

getFieldsMap ( )

staticprotected

Возвращает: array

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

◆ getFixMethod()

getFixMethod ( $code )

staticprotected

Аргументы

$code

Возвращает: mixed|null

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

◆ getList()

getList ( array $parameters )

static

Аргументы

array $parameters

Возвращает: Main\ORM\Query\Result

Исключения

Main

ArgumentException

Исключения

Main

ObjectPropertyException

Исключения

Main

SystemException

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

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

◆ getMarkField()

getMarkField ( )

Возвращает: string

Замещает IEntityMarker.

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

◆ getMeaningfulFields()

getMeaningfulFields ( )

staticprotected

Возвращает: array

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

◆ getOrder()

getOrder ( )

Возвращает: Order|null

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

◆ getParametersForLoad()

getParametersForLoad ( $id )

staticprotected

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

◆ getParentOrder()

getParentOrder ( )

Возвращает: Order|null

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

◆ getParentOrderId()

getParentOrderId ( )

Возвращает: bool|int

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

◆ getPersonTypeId()

getPersonTypeId ( )

Возвращает: int|null

Замещает IBusinessValueProvider.

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

◆ getPrice()

getPrice ( )

Возвращает: float

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

◆ getPropertyCollection()

getPropertyCollection ( )

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

◆ getRegistryEntity()

getRegistryEntity ( )

static

Возвращает: string|void

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

◆ getRegistryType()

getRegistryType ( )

static

Возвращает: string

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

◆ getServiceParams()

getServiceParams ( )

Возвращает: array

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

◆ getShipmentCode()

getShipmentCode ( )

Возвращает: int

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

◆ getShippedDate()

getShippedDate ( )

Возвращает: Main\Type\DateTime

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

◆ getShippedUserId()

getShippedUserId ( )

Возвращает: int

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

◆ getStoreId()

getStoreId ( )

Возвращает: int

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

◆ getUfId()

getUfId ( )

static

Возвращает: null

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

◆ getUnshipReason()

getUnshipReason ( )

Возвращает: string

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

◆ getVatRate()

getVatRate ( )

Возвращает: float|int

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

LoaderException

Исключения

Main

ObjectPropertyException

Исключения

Main

SystemException

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

◆ getVatSum()

getVatSum ( )

Возвращает: float

Исключения

Main

ArgumentNullException

Исключения

Main

LoaderException

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

◆ getWeight()

getWeight ( )

Возвращает: float

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

◆ isAllowDelivery()

isAllowDelivery ( )

Возвращает: bool

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

◆ isCanceled()

isCanceled ( )

Возвращает: bool

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

◆ isChanged()

isChanged ( )

Возвращает: bool

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

◆ isCustomPrice()

isCustomPrice ( )

Возвращает: bool

Исключения

Main

ArgumentOutOfRangeException

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

◆ isEmpty()

isEmpty ( )

Возвращает: bool

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

◆ isMarked()

isMarked ( )

Возвращает: bool

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

◆ isPriceField()

isPriceField ( string $name )

protected

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

◆ isShipped()

isShipped ( )

Возвращает: bool

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

◆ isSystem()

isSystem ( )

Возвращает: bool

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

◆ loadDeliveryService()

loadDeliveryService ( )

protected

Возвращает: Delivery\Services\Base

Исключения

Main

ArgumentNullException

Исключения

Main

SystemException

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

◆ loadForOrder()

loadForOrder ( $id )

static

Аргументы

$id

Возвращает: array

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

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

◆ markSystem()

markSystem ( )

protected

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

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

◆ needReservation()

needReservation ( )

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

◆ needShip()

needShip ( )

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

◆ normalizeValue()

normalizeValue	(		$name,
			$value )

protected

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

◆ onAfterSave()

onAfterSave ( $isNew )

protected

Аргументы

$isNew

Возвращает: void

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

◆ onBeforeBasketItemDelete()

onBeforeBasketItemDelete ( BasketItem $basketItem )

Аргументы

BasketItem $basketItem

Возвращает: Result

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Main

ObjectNotFoundException

Исключения

Main

SystemException

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

◆ onBeforeSetFields()

onBeforeSetFields ( array $values )

protected

Аргументы

array $values

Возвращает: array

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

◆ onShipmentItemCollectionModify()

onShipmentItemCollectionModify	(		$action,
		ShipmentItem	$shipmentItem,
			$name = null,
			$oldValue = null,
			$value = null )

Аргументы

	$action
ShipmentItem	$shipmentItem
null	$name
null	$oldValue
null	$value

Возвращает: Result

Исключения

Main

NotSupportedException

Исключения

Main

SystemException

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

◆ resetData()

resetData ( )

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

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

◆ saveExtraServices()

saveExtraServices ( )

protected

Возвращает: Result

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

◆ saveStoreId()

saveStoreId ( )

protected

Возвращает: Result

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

◆ setBasePriceDelivery()

setBasePriceDelivery	(		$value,
			$custom = false )

Аргументы

	$value
bool	$custom

Возвращает: Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

◆ setDeliveryRequestMarker()

setDeliveryRequestMarker ( )

protected

Возвращает: void

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

◆ setDeliveryService()

setDeliveryService ( Delivery\Services\Base $service )

Аргументы

Delivery\Services\Base $service

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

◆ setExtraServices()

setExtraServices ( array $extraServices )

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

◆ setField()

setField	(		$name,
			$value )

Sets new value to specified field of shipment item

Аргументы

string	$name
mixed	$value

Возвращает: Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

◆ setFieldNoDemand()

setFieldNoDemand	(		$name,
			$value )

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

◆ setOrderId()

setOrderId ( $orderId )

Аргументы

$orderId

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

◆ setServiceParams()

setServiceParams ( array $serviceParams )

Аргументы

array $serviceParams

Исключения

Main

NotSupportedException

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

◆ setStoreId()

setStoreId ( int $storeId )

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

◆ setWeight()

setWeight ( float $weight )

Аргументы

float $weight

Возвращает: string|null

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

◆ toArray()

toArray ( )

Возвращает: array

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

◆ tryFixError()

tryFixError ( $code )

Аргументы

$code

Возвращает: Result

Замещает IEntityMarker.

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

◆ tryReserve()

tryReserve ( )

Исключения

Main

ArgumentException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

◆ tryUnreserve()

tryUnreserve ( )

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

◆ tryUnship()

tryUnship ( )

Возвращает: Result

Исключения

Main

NotSupportedException

Исключения

Main

ObjectNotFoundException

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

◆ updateInternal()

updateInternal	(		$primary,
		array	$data )

protected

Аргументы

	$primary
array	$data

Возвращает: Entity\UpdateResult

Исключения

Exception

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

Поля

◆ $areExtraServicesChanged

bool $areExtraServicesChanged = false

protected

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

◆ $extraServices

$extraServices = null

protected

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

◆ $idShipment

$idShipment = 0

staticprotected

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

◆ $internalId

$internalId = 0

protected

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

◆ $isNew

$isNew = true

protected

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

◆ $isStoreIdChanged

bool $isStoreIdChanged = false

protected

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

◆ $propertyCollection

$propertyCollection

protected

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

◆ $service

$service = null

protected

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

◆ $shipmentItemCollection

$shipmentItemCollection

protected

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

◆ $storeId

$storeId = null

protected

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

Объявления и описания членов класса находятся в файле:

C:/bitrix/modules/sale/lib/shipment.php

Открытые члены

Открытые статические члены

Защищенные члены

Защищенные статические члены

Защищенные данные

Статические защищенные данные

Дополнительные унаследованные члены

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

Методы

◆ addInternal()

◆ allowDelivery()

◆ calculateDelivery()

◆ canMarked()

◆ checkValueBeforeSet()

◆ createSystem()

◆ delete()

◆ deleteDeliveryRequest()

◆ deleteInternal()

◆ deleteNoDemand()

◆ deliver()

◆ disallowDelivery()

◆ fixReserveErrors()

◆ fixShipErrors()

◆ generateXmlId()

◆ getAllowDeliveryDate()

◆ getAllowDeliveryUserId()

◆ getAutoFixErrorsList()

◆ getAutoFixRules()

◆ getAvailableFields()

◆ getBusinessValueProviderInstance()

◆ getCompanyId()

◆ getCurrency()

◆ getCustomizableFields()

◆ getDelivery()

◆ getDeliveryId()

◆ getDeliveryName()

◆ getEntityEventName()

◆ getExtraServices()

◆ getExtraServicesObjects()

◆ getFieldsMap()

◆ getFixMethod()

◆ getList()

◆ getMarkField()

◆ getMeaningfulFields()

◆ getOrder()

◆ getParametersForLoad()

◆ getParentOrder()

◆ getParentOrderId()

◆ getPersonTypeId()

◆ getPrice()

◆ getPropertyCollection()

◆ getRegistryEntity()

◆ getRegistryType()

◆ getServiceParams()

◆ getShipmentCode()

◆ getShippedDate()

◆ getShippedUserId()

◆ getStoreId()

◆ getUfId()

◆ getUnshipReason()

◆ getVatRate()

◆ getVatSum()

◆ getWeight()

◆ isAllowDelivery()

◆ isCanceled()

◆ isChanged()

◆ isCustomPrice()

◆ isEmpty()

◆ isMarked()

◆ isPriceField()

◆ isShipped()

◆ isSystem()

◆ loadDeliveryService()

◆ loadForOrder()

◆ markSystem()

◆ needReservation()

◆ needShip()

◆ normalizeValue()

◆ onAfterSave()

◆ onBeforeBasketItemDelete()