Класс Shipment

Граф наследования: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 ($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
	$storeId = null
	$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 строка 2752

allowDelivery()

allowDelivery

(

)

Возвращает

Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

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

calculateDelivery()

calculateDelivery

(

)

Возвращает

Delivery\CalculationResult

Исключения

Main

NotSupportedException

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

canMarked()

canMarked

(

)

Возвращает

bool

Замещает IEntityMarker.

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

checkValueBeforeSet()

checkValueBeforeSet ( $name, $value )

protected

Аргументы

$name
$value

Возвращает

Result

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

createSystem()

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

static

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

delete()

delete

(

)

Deletes shipment

Возвращает

Result

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Main

ObjectNotFoundException

Исключения

Exception

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

deleteDeliveryRequest()

deleteDeliveryRequest ( )

protected

Возвращает

void

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

deleteInternal()

static deleteInternal ( $primary )

staticprotected

Аргументы

$primary

Возвращает

Entity\DeleteResult

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

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

deleteNoDemand()

static deleteNoDemand ( $orderId )

static

Аргументы

$orderId

Возвращает

Result

Исключения

Main

ArgumentException

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

deliver()

deliver

(

)

Возвращает

Result

Исключения

Main

ObjectNotFoundException

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

disallowDelivery()

disallowDelivery

(

)

Возвращает

Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

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

fixReserveErrors()

static fixReserveErrors ( Shipment $entity )

static

Аргументы

Shipment

$entity

Возвращает

Result

Исключения

Main

ObjectNotFoundException

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

fixShipErrors()

static fixShipErrors ( Shipment $entity )

static

Аргументы

Shipment

$entity

Возвращает

Result

Исключения

Main

ObjectNotFoundException

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

generateXmlId()

static generateXmlId ( )

staticprotected

Возвращает

string

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

getAllowDeliveryDate()

getAllowDeliveryDate

(

)

Возвращает

Main\Type\DateTime

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

getAllowDeliveryUserId()

getAllowDeliveryUserId

(

)

Возвращает

int

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

getAutoFixErrorsList()

getAutoFixErrorsList

(

)

Возвращает

array

Замещает IEntityMarker.

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

getAutoFixRules()

static getAutoFixRules ( )

staticprotected

Возвращает

array

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

getAvailableFields()

static getAvailableFields ( )

static

Возвращает

array

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

getBusinessValueProviderInstance()

getBusinessValueProviderInstance

(

$mapping

)

Аргументы

$mapping

Возвращает

Shipment|null|string

Замещает IBusinessValueProvider.

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

getCompanyId()

getCompanyId

(

)

Возвращает

int

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

getCurrency()

getCurrency

(

)

Возвращает

string

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

getCustomizableFields()

static getCustomizableFields ( )

static

Возвращает

array

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

getDelivery()

getDelivery

(

)

Возвращает

Delivery\Services\Base

Исключения

Main

ArgumentNullException

Исключения

Main

SystemException

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

getDeliveryId()

getDeliveryId

(

)

Возвращает

int

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

getDeliveryName()

getDeliveryName

(

)

Возвращает

string

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

getEntityEventName()

static getEntityEventName ( )

static

Возвращает

null|string

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

getExtraServices()

getExtraServices

(

)

Возвращает

null

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

getExtraServicesObjects()

getExtraServicesObjects

(

)

Возвращает

Delivery\ExtraServices\Base[]

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

getFieldsMap()

static getFieldsMap ( )

staticprotected

Возвращает

array

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

getFixMethod()

static getFixMethod ( $code )

staticprotected

Аргументы

$code

Возвращает

mixed|null

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

getList()

static getList ( array $parameters )

static

Аргументы

array

$parameters

Возвращает

Main\ORM\Query\Result

Исключения

Main

ArgumentException

Исключения

Main

ObjectPropertyException

Исключения

Main

SystemException

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

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

getMarkField()

getMarkField

(

)

Возвращает

string

Замещает IEntityMarker.

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

getMeaningfulFields()

static getMeaningfulFields ( )

staticprotected

Возвращает

array

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

getOrder()

getOrder

(

)

Возвращает

Order|null

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

getParametersForLoad()

static getParametersForLoad ( $id )

staticprotected

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

getParentOrder()

getParentOrder

(

)

Возвращает

Order|null

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

getParentOrderId()

getParentOrderId

(

)

Возвращает

bool|int

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

getPersonTypeId()

getPersonTypeId

(

)

Возвращает

int|null

Замещает IBusinessValueProvider.

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

getPrice()

getPrice

(

)

Возвращает

float

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

getPropertyCollection()

getPropertyCollection

(

)

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

getRegistryEntity()

static getRegistryEntity ( )

static

Возвращает

string|void

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

getRegistryType()

static getRegistryType ( )

static

Возвращает

string

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

getServiceParams()

getServiceParams

(

)

Возвращает

array

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

getShipmentCode()

getShipmentCode

(

)

Возвращает

int

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

getShippedDate()

getShippedDate

(

)

Возвращает

Main\Type\DateTime

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

getShippedUserId()

getShippedUserId

(

)

Возвращает

int

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

getStoreId()

getStoreId

(

)

Возвращает

int

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

getUfId()

static getUfId ( )

static

Возвращает

null

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

getUnshipReason()

getUnshipReason

(

)

Возвращает

string

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

getVatRate()

getVatRate

(

)

Возвращает

float|int

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

LoaderException

Исключения

Main

ObjectPropertyException

Исключения

Main

SystemException

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

getVatSum()

getVatSum

(

)

Возвращает

float

Исключения

Main

ArgumentNullException

Исключения

Main

LoaderException

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

getWeight()

getWeight

(

)

Возвращает

float

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

isAllowDelivery()

isAllowDelivery

(

)

Возвращает

bool

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

isCanceled()

isCanceled

(

)

Возвращает

bool

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

isChanged()

isChanged

(

)

Возвращает

bool

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

ObjectNotFoundException

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

isCustomPrice()

isCustomPrice

(

)

Возвращает

bool

Исключения

Main

ArgumentOutOfRangeException

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

isEmpty()

isEmpty

(

)

Возвращает

bool

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

isMarked()

isMarked

(

)

Возвращает

bool

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

isPriceField()

isPriceField ( string $name )

protected

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

isShipped()

isShipped

(

)

Возвращает

bool

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

isSystem()

isSystem

(

)

Возвращает

bool

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

loadDeliveryService()

loadDeliveryService ( )

protected

Возвращает

Delivery\Services\Base

Исключения

Main

ArgumentNullException

Исключения

Main

SystemException

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

loadForOrder()

static loadForOrder ( $id )

static

Аргументы

$id

Возвращает

array

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

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

markSystem()

markSystem ( )

protected

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

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

needReservation()

needReservation

(

)

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

needShip()

needShip

(

)

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

normalizeValue()

normalizeValue ( $name, $value )

protected

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

onAfterSave()

onAfterSave ( $isNew )

protected

Аргументы

$isNew

Возвращает

void

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

onBeforeBasketItemDelete()

onBeforeBasketItemDelete

(

BasketItem

$basketItem

)

Аргументы

BasketItem

$basketItem

Возвращает

Result

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Main

ObjectNotFoundException

Исключения

Main

SystemException

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

onBeforeSetFields()

onBeforeSetFields ( array $values )

protected

Аргументы

array

$values

Возвращает

array

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

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 строка 620

resetData()

resetData

(

)

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

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

saveExtraServices()

saveExtraServices ( )

protected

Возвращает

Result

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

saveStoreId()

saveStoreId ( )

protected

Возвращает

Result

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

setBasePriceDelivery()

setBasePriceDelivery	(		$value,
			$custom = false )

Аргументы

	$value
bool	$custom

Возвращает

Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

setDeliveryRequestMarker()

setDeliveryRequestMarker ( )

protected

Возвращает

void

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

setDeliveryService()

setDeliveryService

(

Delivery\Services\Base

$service

)

Аргументы

Delivery\Services\Base

$service

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

setExtraServices()

setExtraServices

(

array

$extraServices

)

Аргументы

array

$extraServices

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

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 строка 789

setFieldNoDemand()

setFieldNoDemand	(		$name,
			$value )

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

setOrderId()

setOrderId

(

$orderId

)

Аргументы

$orderId

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

setServiceParams()

setServiceParams

(

array

$serviceParams

)

Аргументы

array

$serviceParams

Исключения

Main

NotSupportedException

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

setStoreId()

setStoreId

(

$storeId

)

Аргументы

$storeId

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

setWeight()

setWeight

(

float

$weight

)

Аргументы

float

$weight

Возвращает

string|null

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

toArray()

toArray

(

)

Возвращает

array

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

tryFixError()

tryFixError

(

$code

)

Аргументы

$code

Возвращает

Result

Замещает IEntityMarker.

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

tryReserve()

tryReserve

(

)

Исключения

Main

ArgumentException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

tryUnreserve()

tryUnreserve

(

)

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

tryUnship()

tryUnship

(

)

Возвращает

Result

Исключения

Main

NotSupportedException

Исключения

Main

ObjectNotFoundException

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

updateInternal()

updateInternal ( $primary, array $data )

protected

Аргументы

	$primary
array	$data

Возвращает

Entity\UpdateResult

Исключения

Exception

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

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

$extraServices

$extraServices = null

protected

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

$idShipment

$idShipment = 0

staticprotected

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

$internalId

$internalId = 0

protected

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

$isNew

bool $isNew = true

protected

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

$propertyCollection

ShipmentPropertyValueCollection $propertyCollection

protected

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

$service

$service = null

protected

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

$shipmentItemCollection

ShipmentItemCollection $shipmentItemCollection

protected

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

$storeId

$storeId = null

protected

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