Bitrix-D7 22.6
 
Загрузка...
Поиск...
Не найдено
Класс 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)
 
 getPersonTypeId ()
 
 getBusinessValueProviderInstance ($mapping)
 
- Открытые члены унаследованные от IEntityMarker
 getErrorEntity ($value)
 
 canAutoFixError ($value)
 
 getAutoFixErrorsList ()
 
 tryFixError ($code)
 
 canMarked ()
 
 getMarkField ()
 

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

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 getList (array $parameters)
 
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 строка 2746

◆ allowDelivery()

allowDelivery ( )
Возвращает
Result
Исключения
Main

ArgumentOutOfRangeException

Исключения
Main

NotSupportedException

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

◆ calculateDelivery()

calculateDelivery ( )
Возвращает
Delivery\CalculationResult
Исключения
Main

NotSupportedException

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

◆ canMarked()

canMarked ( )
Возвращает
bool

Замещает IEntityMarker.

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

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

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

◆ deleteNoDemand()

static deleteNoDemand (   $orderId)
static
Аргументы
$orderId
Возвращает
Result
Исключения
Main

ArgumentException

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

◆ deliver()

deliver ( )
Возвращает
Result
Исключения
Main

ObjectNotFoundException

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

◆ disallowDelivery()

disallowDelivery ( )
Возвращает
Result
Исключения
Main

ArgumentOutOfRangeException

Исключения
Main

NotSupportedException

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

◆ fixReserveErrors()

static fixReserveErrors ( Shipment  $entity)
static
Аргументы
Shipment$entity
Возвращает
Result
Исключения
Main

ObjectNotFoundException

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

◆ fixShipErrors()

static fixShipErrors ( Shipment  $entity)
static
Аргументы
Shipment$entity
Возвращает
Result
Исключения
Main

ObjectNotFoundException

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

◆ generateXmlId()

static generateXmlId ( )
staticprotected
Возвращает
string

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

◆ getAllowDeliveryDate()

getAllowDeliveryDate ( )
Возвращает
Main\Type\DateTime

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

◆ getAllowDeliveryUserId()

getAllowDeliveryUserId ( )
Возвращает
int

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

◆ getAutoFixErrorsList()

getAutoFixErrorsList ( )
Возвращает
array

Замещает IEntityMarker.

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

◆ getAutoFixRules()

static getAutoFixRules ( )
staticprotected
Возвращает
array

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

◆ getAvailableFields()

static getAvailableFields ( )
static
Возвращает
array

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

◆ getBusinessValueProviderInstance()

getBusinessValueProviderInstance (   $mapping)
Аргументы
$mapping
Возвращает
Shipment|null|string

Замещает IBusinessValueProvider.

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

◆ getCompanyId()

getCompanyId ( )
Возвращает
int

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

◆ getCurrency()

getCurrency ( )
Возвращает
string

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

◆ getCustomizableFields()

static getCustomizableFields ( )
static
Возвращает
array

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

◆ getDelivery()

getDelivery ( )
Возвращает
Delivery\Services\Base
Исключения
Main

ArgumentNullException

Исключения
Main

SystemException

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

◆ getDeliveryId()

getDeliveryId ( )
Возвращает
int

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

◆ getDeliveryName()

getDeliveryName ( )
Возвращает
string

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

◆ getEntityEventName()

static getEntityEventName ( )
static
Возвращает
null|string

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

◆ getExtraServices()

getExtraServices ( )
Возвращает
null

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

◆ getExtraServicesObjects()

getExtraServicesObjects ( )
Возвращает
Delivery\ExtraServices\Base[]

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

◆ getFieldsMap()

static getFieldsMap ( )
staticprotected
Возвращает
array

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

◆ getFixMethod()

static getFixMethod (   $code)
staticprotected
Аргументы
$code
Возвращает
mixed|null

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

◆ getList()

static getList ( array  $parameters)
static
Аргументы
array$parameters
Возвращает
Main\ORM\Query\Result
Исключения
Main

ArgumentException

Исключения
Main

ObjectPropertyException

Исключения
Main

SystemException

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

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

◆ getMarkField()

getMarkField ( )
Возвращает
string

Замещает IEntityMarker.

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

◆ getMeaningfulFields()

static getMeaningfulFields ( )
staticprotected
Возвращает
array

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

◆ getOrder()

getOrder ( )
Возвращает
Order|null

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

◆ getParametersForLoad()

static getParametersForLoad (   $id)
staticprotected

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

◆ getParentOrder()

getParentOrder ( )
Возвращает
Order|null

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

◆ getParentOrderId()

getParentOrderId ( )
Возвращает
bool|int

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

◆ getPersonTypeId()

getPersonTypeId ( )
Возвращает
int|null

Замещает IBusinessValueProvider.

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

◆ getPrice()

getPrice ( )
Возвращает
float

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

◆ getPropertyCollection()

getPropertyCollection ( )

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

◆ getRegistryEntity()

static getRegistryEntity ( )
static
Возвращает
string|void

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

◆ getRegistryType()

static getRegistryType ( )
static
Возвращает
string

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

◆ getServiceParams()

getServiceParams ( )
Возвращает
array

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

◆ getShipmentCode()

getShipmentCode ( )
Возвращает
int

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

◆ getShippedDate()

getShippedDate ( )
Возвращает
Main\Type\DateTime

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

◆ getShippedUserId()

getShippedUserId ( )
Возвращает
int

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

◆ getStoreId()

getStoreId ( )
Возвращает
int

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

◆ getUfId()

static getUfId ( )
static
Возвращает
null

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

◆ getUnshipReason()

getUnshipReason ( )
Возвращает
string

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

◆ getVatRate()

getVatRate ( )
Возвращает
float|int
Исключения
Main

ArgumentException

Исключения
Main

ArgumentNullException

Исключения
Main

LoaderException

Исключения
Main

ObjectPropertyException

Исключения
Main

SystemException

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

◆ getVatSum()

getVatSum ( )
Возвращает
float
Исключения
Main

ArgumentNullException

Исключения
Main

LoaderException

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

◆ getWeight()

getWeight ( )
Возвращает
float

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

◆ isAllowDelivery()

isAllowDelivery ( )
Возвращает
bool

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

◆ isCanceled()

isCanceled ( )
Возвращает
bool

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

◆ isChanged()

isChanged ( )
Возвращает
bool
Исключения
Main

ArgumentException

Исключения
Main

ArgumentNullException

Исключения
Main

ObjectNotFoundException

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

◆ isCustomPrice()

isCustomPrice ( )
Возвращает
bool
Исключения
Main

ArgumentOutOfRangeException

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

◆ isEmpty()

isEmpty ( )
Возвращает
bool

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

◆ isMarked()

isMarked ( )
Возвращает
bool

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

◆ isPriceField()

isPriceField ( string  $name)
protected

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

◆ isShipped()

isShipped ( )
Возвращает
bool

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

◆ isSystem()

isSystem ( )
Возвращает
bool

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

◆ loadDeliveryService()

loadDeliveryService ( )
protected
Возвращает
Delivery\Services\Base
Исключения
Main

ArgumentNullException

Исключения
Main

SystemException

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

◆ loadForOrder()

static loadForOrder (   $id)
static
Аргументы
$id
Возвращает
array
Исключения
Main

ArgumentException

Исключения
Main

ArgumentNullException

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

◆ markSystem()

markSystem ( )
protected
Исключения
Main

ArgumentNullException

Исключения
Main

ArgumentOutOfRangeException

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

◆ needReservation()

needReservation ( )

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

◆ needShip()

needShip ( )

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

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

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

◆ saveExtraServices()

saveExtraServices ( )
protected
Возвращает
Result

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

◆ saveStoreId()

saveStoreId ( )
protected
Возвращает
Result

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

◆ setBasePriceDelivery()

setBasePriceDelivery (   $value,
  $custom = false 
)
Аргументы
$value
bool$custom
Возвращает
Result
Исключения
Main

ArgumentOutOfRangeException

Исключения
Main

NotSupportedException

Исключения

Exception

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

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

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

◆ setServiceParams()

setServiceParams ( array  $serviceParams)
Аргументы
array$serviceParams
Исключения
Main

NotSupportedException

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

◆ setStoreId()

setStoreId (   $storeId)
Аргументы
$storeId

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

◆ setWeight()

setWeight ( float  $weight)
Аргументы
float$weight
Возвращает
string|null

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

◆ toArray()

toArray ( )
Возвращает
array
Исключения
Main

ArgumentException

Исключения
Main

SystemException

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

◆ tryFixError()

tryFixError (   $code)
Аргументы
$code
Возвращает
Result

Замещает IEntityMarker.

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

◆ tryReserve()

tryReserve ( )
Исключения
Main

ArgumentException

Исключения
Main

ArgumentOutOfRangeException

Исключения
Main

NotSupportedException

Исключения

Exception

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

◆ tryUnreserve()

tryUnreserve ( )
Исключения
Main

ArgumentOutOfRangeException

Исключения
Main

NotSupportedException

Исключения

Exception

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

◆ tryUnship()

tryUnship ( )
Возвращает
Result
Исключения
Main

NotSupportedException

Исключения
Main

ObjectNotFoundException

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

◆ updateInternal()

updateInternal (   $primary,
array  $data 
)
protected
Аргументы
$primary
array$data
Возвращает
Entity\UpdateResult
Исключения

Exception

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

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

◆ $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