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

Открытые члены
	getShipmentCode ()

	setDeliveryService (Delivery\Services\Base $service)

	needReservation ()

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

	delete ()
	Deletes shipment. Подробнее...

	setField ($name, $value)
	Sets new value to specified field of shipment item. Подробнее...

	setFieldNoDemand ($name, $value)

	save ()

	getParentOrderId ()

	getOrder ()

	getShipmentItemCollection ()

	getPrice ()

	isCustomPrice ()

	getCurrency ()

	getDeliveryId ()

	getDeliveryName ()

	setOrderId ($orderId)

	getDelivery ()

	isSystem ()

	isCanceled ()

	isShipped ()

	getShippedDate ()

	getShippedUserId ()

	getUnshipReason ()

	isMarked ()

	isReserved ()

	isAllowDelivery ()

	isEmpty ()

	getAllowDeliveryDate ()

	getAllowDeliveryUserId ()

	getCompanyId ()

	tryReserve ()

	tryUnreserve ()

	tryShip ()

	tryUnship ()

	needShip ()

	deliver ()

	allowDelivery ()

	disallowDelivery ()

	onBeforeBasketItemDelete (BasketItem $basketItem)

	onBasketModify ($action, BasketItem $basketItem, $name=null, $oldValue=null, $value=null)

	getServiceParams ()

	setServiceParams (array $serviceParams)

	getExtraServices ()

	setExtraServices (array $extraServices)

	getStoreId ()

	setStoreId ($storeId)

	getWeight ()

	setWeight (float $weight)

	calculateDelivery ()

	resetData ()

	getBasketItemQuantity (BasketItem $basketItem)

	isExistBasketItem (BasketItem $basketItem)

	verify ()

	setAccountNumber ($id)

	getBusinessValueProviderInstance ($mapping)

	getPersonTypeId ()

	createClone (\SplObjectStorage $cloneEntity)

	getErrorEntity ($value)

	canAutoFixError ($value)

	getAutoFixErrorsList ()

	tryFixError ($code)

	canMarked ()

	getMarkField ()

	isChanged ()

	clearChanged ()

	getVatRate ()

	getVatSum ()

	setBasePriceDelivery ($value, $custom=false)

	toArray ()

	getParentOrder ()

Открытые члены унаследованные от CollectableEntity
	setCollection (EntityCollection $collection)

	getCollection ()

	setInternalIndex ($index)

	getInternalIndex ()

	isStartField ($isMeaningfulField=false)

	clearStartField ()

	hasMeaningfulField ()

	doFinalAction ($hasMeaningfulField=false)

	setMathActionOnly ($value=false)

	isMathActionOnly ()

	isClone ()

Открытые члены унаследованные от Entity
	initializeField ($fieldName, $fieldInfo)
	Fields factory. Подробнее...

	initialize ($className)

	postInitialize ()

	getObjectClass ()
	Returns class of Object for current entity. Подробнее...

	getObjectClassName ()
	Returns class name of Object for current entity. Подробнее...

	getCollectionClass ()

	getCollectionClassName ()

	createObject ($setDefaultValues=true)

	createCollection ()

	wakeUpObject ($row)

	wakeUpCollection ($rows)

	addField ($fieldInfo, $fieldName=null)

	getReferencesCountTo ($refEntityName)

	getReferencesTo ($refEntityName)

	getFields ()

	getField ($name)

	hasField ($name)

	getScalarFields ()

	getUField ($name)

	hasUField ($name)

	getName ()

	getFullName ()

	getNamespace ()

	getModule ()

	getDataClass ()

	getConnection ()

	getDBTableName ()

	getPrimary ()

	getPrimaryArray ()

	getAutoIncrement ()

	isUts ()

	isUtm ()

	setDefaultScope ($query)

	getCode ()

	getLangCode ()

	getTitle ()

	__clone ()

	compileDbTableStructureDump ()

	createDbTable ()
	Creates table according to Fields collection. Подробнее...

	readFromCache ($ttl, $cacheId, $countTotal=false)
	Reads data from cache. Подробнее...

	writeToCache (Main\DB\Result $result, $cacheId, $countTotal=false)

	getCacheTtl ($ttl)
	Returns cache TTL for the entity, possibly limited by the .settings.php: 'cache_flags' => array('value'=> array( "b_group_max_ttl" => 200, "b_group_min_ttl" => 100, )) Maximum is a higher-priority. Подробнее...

	cleanCache ()
	Cleans all cache entries for the entity. Подробнее...

	enableFullTextIndex ($field, $mode=true)
	Sets a flag indicating full text index support for a field. Подробнее...

	fullTextIndexEnabled ($field)
	Returns true if full text index is enabled for a field. Подробнее...

Открытые статические члены
static	getRegistryEntity ()

static	getAvailableFields ()

static	getCustomizableFields ()

static	create (ShipmentCollection $collection, Delivery\Services\Base $service=null)

static	getRegistryType ()

static	updateReservedFlag (Shipment $shipment)

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	get ($entityName)
	Returns entity object. Подробнее...

static	has ($entityName)
	Checks if entity exists. Подробнее...

static	getInstance ($entityName)

static	getDefaultObjectClassName ($entityName)

static	getDefaultCollectionClassName ($entityName)

static	isExists ($name)

static	normalizeEntityClass ($entityName)

static	getEntityClassParts ($class)

static	camel2snake ($str)

static	snake2camel ($str)

static	normalizeName ($entityName)

static	getInstanceByQuery (Query $query, &$entity_name=null)

static	compileEntity ($entityName, $fields=null, $parameters=array())

static	compileObjectClass ($dataClass)

static	compileCollectionClass ($dataClass)

static	destroy ($entity)

Защищенные члены
	__construct (array $fields=[])

	onBeforeSetFields (array $values)

	deleteDeliveryRequest ()

	checkValueBeforeSet ($name, $value)

	setDeliveryRequestMarker ()

	onAfterSave ($isNew)

	markSystem ()

	loadDeliveryService ()

	onFieldModify ($name, $oldValue, $value)

	syncQuantityAfterModify (BasketItem $basketItem, $value=null, $oldValue=null)

	saveExtraServices ()

	saveStoreId ()

	addChangesToHistory ($name, $oldValue=null, $value=null)

	setStatus ($status)

	addInternal (array $data)

	updateInternal ($primary, array $data)

Защищенные члены унаследованные от Entity
	appendField (Field $field)

	getCacheDir ()

Защищенные статические члены
static	getMeaningfulFields ()

static	generateXmlId ()

static	getFixMethod ($code)

static	getAutoFixRules ()

static	deleteInternal ($primary)

static	getFieldsMap ()

Защищенные статические члены унаследованные от Entity
static	getInstanceDirect ($className)

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

	$service = null

	$extraServices = null

	$storeId = null

	$internalId = 0

Защищенные данные унаследованные от CollectableEntity
	$collection

	$internalIndex = null

	$isClone = false

Защищенные данные унаследованные от Entity
	$className

	$module

	$uf_id

	$fields

	$fieldsMap

	$u_fields

	$code

	$references

	$isClone = false

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

Статические защищенные данные унаследованные от Entity
static	$instances

Дополнительные унаследованные члены
Поля данных унаследованные от Entity
	$name

	$connectionName

	$dbTableName

	$primary

	$autoIncrement

	$isUts

	$isUtm

const	DEFAULT_OBJECT_PREFIX = 'EO_'

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

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

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

◆ __construct()

__construct ( array $fields = [] )

protected

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

     {
         $priceFields = ['BASE_PRICE_DELIVERY', 'PRICE_DELIVERY', 'DISCOUNT_PRICE'];
  
         foreach ($priceFields as $code)
         {
             if (isset($fields[$code]))
             {
                 $fields[$code] = PriceMaths::roundPrecision($fields[$code]);
             }
         }
  
         parent::__construct($fields);
     }

Методы

◆ addChangesToHistory()

addChangesToHistory	(	$name,
		$oldValue = `null`,
		$value = `null`
	)

protected

Аргументы

string	$name
null	$oldValue
null	$value

Исключения

Main

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

     {
         if ($this->getId() > 0 && !$this->isSystem())
         {
             $order = $this->getOrder();
  
             if ($order && $order->getId() > 0)
             {
                 $registry = Registry::getInstance(static::getRegistryType());
  
                 /** @var OrderHistory $orderHistory */
                 $orderHistory = $registry->getOrderHistoryClassName();
                 $orderHistory::addField(
                     'SHIPMENT',
                     $order->getId(),
                     $name,
                     $oldValue,
                     $value,
                     $this->getId(),
                     $this
                 );
             }
         }
     }

◆ addInternal()

addInternal ( array $data )

protected

Аргументы

array $data

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

Исключения

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

     {
         return Internals\ShipmentTable::add($data);
     }

◆ allowDelivery()

allowDelivery ( )

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

Исключения

Main

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

     {
         return $this->setField('ALLOW_DELIVERY', "Y");
     }

◆ calculateDelivery()

calculateDelivery ( )

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

Исключения

Main

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

     {
         if ($this->isSystem())
         {
             throw new Main\NotSupportedException();
         }
  
         if ($this->getDeliveryId() === 0)
         {
             return new Delivery\CalculationResult();
         }
  
         return Delivery\Services\Manager::calculateDeliveryPrice($this);
     }

◆ canAutoFixError()

canAutoFixError ( $value )

Аргументы

$value

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

Замещает IEntityMarker.

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

     {
         $autoFix = false;
         $errorsList = static::getAutoFixErrorsList();
         if (is_array($errorsList) && in_array($value, $errorsList))
         {
             $autoFix = true;
         }
         else
         {
             /** @var ShipmentItemCollection $shipmentItemCollection */
             if ($shipmentItemCollection = $this->getShipmentItemCollection())
             {
                 $autoFix = $shipmentItemCollection->canAutoFixError($value);
             }
         }
  
         return $autoFix;
     }

◆ canMarked()

canMarked ( )

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

Замещает IEntityMarker.

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

     {
         return true;
     }

◆ checkValueBeforeSet()

checkValueBeforeSet	(	$name,
		$value
	)

protected

Аргументы

$name
$value

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

Исключения

Main

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

     {
         $result = parent::checkValueBeforeSet($name, $value);
  
         if ($name === "DELIVERY_ID")
         {
             if (intval($value) > 0 && !Delivery\Services\Manager::isServiceExist($value))
             {
                 $result->addError(
                     new ResultError(
                         Loc::getMessage('SALE_SHIPMENT_WRONG_DELIVERY_SERVICE'),
                         'SALE_SHIPMENT_WRONG_DELIVERY_SERVICE'
                     )
                 );
             }
         }
         elseif ($name === 'ACCOUNT_NUMBER')
         {
             $dbRes = static::getList([
                 'select' => ['ID'],
                 'filter' => ['=ACCOUNT_NUMBER' => $value]
             ]);
  
             if ($dbRes->fetch())
             {
                 $result->addError(
                     new ResultError(
                         Loc::getMessage('SALE_SHIPMENT_ACCOUNT_NUMBER_EXISTS')
                     )
                 );
             }
         }
  
         return $result;
     }

◆ clearChanged()

clearChanged ( )

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

     {
         parent::clearChanged();
  
         if ($shipmentItemCollection = $this->getShipmentItemCollection())
         {
             /** @var ShipmentItem $shipmentItem */
             foreach ($shipmentItemCollection as $shipmentItem)
             {
                 $shipmentItem->clearChanged();
             }
         }
     }

◆ create()

static create	(	ShipmentCollection	$collection,
		Delivery\Services\Base	$service = `null`
	)

static

Аргументы

ShipmentCollection	$collection
Delivery\Services\Base \| null	$service

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

Исключения

Main

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

     {
         $emptyService = Delivery\Services\Manager::getById(Delivery\Services\EmptyDeliveryService::getEmptyDeliveryServiceId());
         $fields = [
             'DATE_INSERT' => new Main\Type\DateTime(),
             'DELIVERY_ID' => $emptyService['ID'],
             'DELIVERY_NAME' => $emptyService['NAME'],
             'ALLOW_DELIVERY' => 'N',
             'DEDUCTED' => 'N',
             'CUSTOM_PRICE_DELIVERY' => 'N',
             'MARKED' => 'N',
             'CANCELED' => 'N',
             'SYSTEM' => 'N',
             'XML_ID' => static::generateXmlId(),
             'RESERVED' => 'N'
         ];
  
         $registry = Registry::getInstance(static::getRegistryType());
  
         /** @var DeliveryStatus $deliveryStatusClassName */
         $deliveryStatusClassName = $registry->getDeliveryStatusClassName();
         $fields['STATUS_ID'] = $deliveryStatusClassName::getInitialStatus();
  
         $shipment = static::createShipmentObject();
         $shipment->setFieldsNoDemand($fields);
         $shipment->setCollection($collection);
  
         if ($service !== null)
         {
             $shipment->setDeliveryService($service);
         }
  
         return $shipment;
     }

◆ createClone()

createClone ( \SplObjectStorage $cloneEntity )

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

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

     {
         if ($this->isClone() && $cloneEntity->contains($this))
         {
             return $cloneEntity[$this];
         }
  
         /** @var Shipment $shipmentClone */
         $shipmentClone = parent::createClone($cloneEntity);
  
         /** @var ShipmentItemCollection $shipmentItemCollection */
         if ($shipmentItemCollection = $this->getShipmentItemCollection())
         {
             if (!$cloneEntity->contains($shipmentItemCollection))
             {
                 $cloneEntity[$shipmentItemCollection] = $shipmentItemCollection->createClone($cloneEntity);
             }
  
             if ($cloneEntity->contains($shipmentItemCollection))
             {
                 $shipmentClone->shipmentItemCollection = $cloneEntity[$shipmentItemCollection];
             }
         }
  
         /** @var Delivery\Services\Base $service */
         if ($service = $this->getDelivery())
         {
             if (!$cloneEntity->contains($service))
             {
                 $cloneEntity[$service] = $service->createClone($cloneEntity);
             }
  
             if ($cloneEntity->contains($service))
             {
                 $shipmentClone->service = $cloneEntity[$service];
             }
         }
  
         return $shipmentClone;
     }

◆ createSystem()

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

static

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

     {
         $shipment = static::create($collection, $deliveryService);
         $shipment->markSystem();
  
         if ($deliveryService === null)
         {
             $shipment->setFieldNoDemand('DELIVERY_ID', Delivery\Services\Manager::getEmptyDeliveryServiceId());
         }
  
         return $shipment;
     }

◆ delete()

delete ( )

Deletes shipment.

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

Исключения

Main

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

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

     {
         if ($this->isShipped())
         {
             $result = new Result();
             return $result->addError(
                 new ResultError(
                     Loc::getMessage('SALE_SHIPMENT_EXIST_SHIPPED'),
                     'SALE_SHIPMENT_EXIST_SHIPPED'
                 )
             );
         }
  
         if (!$this->isSystem())
         {
             $this->setField('BASE_PRICE_DELIVERY', 0);
             $this->disallowDelivery();
         }
  
         $this->deleteDeliveryRequest();
  
         $this->getShipmentItemCollection()->clearCollection();
  
         return parent::delete();
     }

◆ deleteDeliveryRequest()

deleteDeliveryRequest ( )

protected

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

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

     {
         Requests\Manager::onBeforeShipmentDelete($this);
     }

◆ deleteInternal()

static deleteInternal ( $primary )

staticprotected

Аргументы

$primary

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

Исключения

Main

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

     {
         return Internals\ShipmentTable::deleteWithItems($primary);
     }

◆ deleteNoDemand()

static deleteNoDemand ( $orderId )

static

Аргументы

$orderId

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

Исключения

Main

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

     {
         $result = new Result();
  
         $shipmentDataList = static::getList(
             [
                 "filter" => ["=ORDER_ID" => $orderId],
                 "select" => ["ID"]
             ]
         );
  
         while ($shipment = $shipmentDataList->fetch())
         {
             $r = static::deleteInternal($shipment['ID']);
             if ($r -> isSuccess())
             {
                 Internals\ShipmentExtraServiceTable::deleteByShipmentId($shipment['ID']);
             }
             else
             {
                 $result->addErrors($r->getErrors());
             }
         }
  
         return $result;
     }

◆ deliver()

deliver ( )

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

Исключения

Main

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

     {
         $order = $this->getParentOrder();
         if (!$order)
         {
             throw new Main\ObjectNotFoundException('Entity "Order" not found');
         }
  
         $result = new Result();
  
         $context = array(
             'USER_ID' => $order->getUserId(),
             'SITE_ID' => $order->getSiteId(),
         );
  
         $creator = Internals\ProviderCreator::create($context);
  
         $shipmentItemCollection = $this->getShipmentItemCollection();
  
         /** @var ShipmentItemCollection $shipmentItemCollection */
         if (!$shipmentItemCollection)
         {
             throw new Main\ObjectNotFoundException('Entity "ShipmentItemCollection" not found');
         }
  
         /** @var ShipmentItem $shipmentItem */
         foreach ($shipmentItemCollection as $shipmentItem)
         {
             $creator->addShipmentItem($shipmentItem);
         }
  
         $r = $creator->deliver();
         if ($r->isSuccess())
         {
             $r = $creator->createItemsResultAfterDeliver($r);
             if ($r->isSuccess())
             {
                 $data = $r->getData();
                 if (array_key_exists('RESULT_AFTER_DELIVER_LIST', $data))
                 {
                     $resultList = $data['RESULT_AFTER_DELIVER_LIST'];
                 }
             }
         }
         else
         {
             $result->addErrors($r->getErrors());
         }
  
         if (!empty($resultList) && is_array($resultList))
         {
             Recurring::repeat($order, $resultList);
         }
  
         return $result;
     }

◆ disallowDelivery()

disallowDelivery ( )

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

Исключения

Main

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

     {
         return $this->setField('ALLOW_DELIVERY', "N");
     }

◆ fixReserveErrors()

static fixReserveErrors ( Shipment $entity )

static

Аргументы

Shipment $entity

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

Исключения

Main

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

     {
         $result = new Result();
  
         $r = $entity->tryReserve();
         if (!$r->isSuccess())
         {
             $result->addErrors($r->getErrors());
         }
         elseif ($r->hasWarnings())
         {
             $result->addWarnings($r->getWarnings());
         }
  
         return $result;
     }

◆ fixShipErrors()

static fixShipErrors ( Shipment $entity )

static

Аргументы

Shipment $entity

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

Исключения

Main

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

     {
         $result = new Result();
  
         $r = $entity->setField('DEDUCTED', 'Y');
         if (!$r->isSuccess())
         {
             if (!$r->isSuccess())
             {
                 $result->addErrors($r->getErrors());
             }
         }
  
         $r = $entity->tryShip();
         if (!$r->isSuccess())
         {
             if (!$r->isSuccess())
             {
                 $result->addErrors($r->getErrors());
             }
         }
  
         return $result;
     }

◆ generateXmlId()

static generateXmlId ( )

staticprotected

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

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

     {
         return uniqid('bx_');
     }

◆ getAllowDeliveryDate()

getAllowDeliveryDate ( )

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

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

     {
         return $this->getField('DATE_ALLOW_DELIVERY');
     }

◆ getAllowDeliveryUserId()

getAllowDeliveryUserId ( )

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

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

     {
         return (int)$this->getField('EMP_ALLOW_DELIVERY_ID');
     }

◆ getAutoFixErrorsList()

getAutoFixErrorsList ( )

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

Замещает IEntityMarker.

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

     {
         return array_keys(static::getAutoFixRules());
     }

◆ getAutoFixRules()

static getAutoFixRules ( )

staticprotected

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

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

     {
         return [
             'PROVIDER_BASKET_ITEM_WRONG_AVAILABLE_QUANTITY' => ['\Bitrix\Sale\Shipment', "fixReserveErrors"],
             'SALE_PROVIDER_RESERVE_SHIPMENT_ITEM_WRONG_AVAILABLE_QUANTITY' => ['\Bitrix\Sale\Shipment', "fixReserveErrors"],
             'PROVIDER_UNRESERVE_SHIPMENT_ITEM_WRONG_AVAILABLE_QUANTITY' => ['\Bitrix\Sale\Shipment', "fixReserveErrors"],
             'SALE_PROVIDER_RESERVE_SHIPMENT_ITEM_QUANTITY_NOT_ENOUGH' => ['\Bitrix\Sale\Shipment', "fixReserveErrors"],
  
             'SALE_PROVIDER_SHIPMENT_SHIPPED_LESS_QUANTITY' => ['\Bitrix\Sale\Shipment', "fixShipErrors"],
             'SALE_PROVIDER_SHIPMENT_SHIPPED_MORE_QUANTITY' => ['\Bitrix\Sale\Shipment', "fixShipErrors"],
             'DDCT_DEDUCTION_QUANTITY_STORE_ERROR' => ['\Bitrix\Sale\Shipment', "fixShipErrors"],
             'SALE_PROVIDER_SHIPMENT_QUANTITY_NOT_ENOUGH' => ['\Bitrix\Sale\Shipment', "fixShipErrors"],
             'DDCT_DEDUCTION_QUANTITY_ERROR' => ['\Bitrix\Sale\Shipment', "fixShipErrors"],
         ];
     }

◆ getAvailableFields()

static getAvailableFields ( )

static

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

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

     {
         return [
             "STATUS_ID",
             "BASE_PRICE_DELIVERY",
             "PRICE_DELIVERY",
             "EXPECTED_PRICE_DELIVERY",
             "ALLOW_DELIVERY",
             "DATE_ALLOW_DELIVERY",
             "EMP_ALLOW_DELIVERY_ID",
             "DEDUCTED",
             "DATE_DEDUCTED",
             "EMP_DEDUCTED_ID",
             "REASON_UNDO_DEDUCTED",
             "DELIVERY_ID",
             "DELIVERY_DOC_NUM",
             "DELIVERY_DOC_DATE",
             "TRACKING_NUMBER",
             "XML_ID",
             "PARAMS",
             "DELIVERY_NAME",
             "COMPANY_ID",
             "MARKED",
             "WEIGHT",
             "DATE_MARKED",
             "EMP_MARKED_ID",
             "REASON_MARKED",
             "CANCELED",
             "DATE_CANCELED",
             "EMP_CANCELED_ID",
             "RESPONSIBLE_ID",
             "DATE_RESPONSIBLE_ID",
             "EMP_RESPONSIBLE_ID",
             "COMMENTS",
             "CURRENCY",
             "CUSTOM_PRICE_DELIVERY",
             "UPDATED_1C",
             "EXTERNAL_DELIVERY",
             "VERSION_1C","ID_1C",
             "TRACKING_STATUS",
             "TRACKING_LAST_CHECK",
             "TRACKING_DESCRIPTION",
             "ACCOUNT_NUMBER",
             'DISCOUNT_PRICE'
         ];
     }

◆ getBasketItemQuantity()

getBasketItemQuantity ( BasketItem $basketItem )

Аргументы

BasketItem $basketItem

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

Исключения

Main

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

     {
         /** @var ShipmentItemCollection $shipmentItemCollection */
         $shipmentItemCollection = $this->getShipmentItemCollection();
  
         return $shipmentItemCollection->getBasketItemQuantity($basketItem);
     }

◆ getBusinessValueProviderInstance()

getBusinessValueProviderInstance ( $mapping )

Аргументы

$mapping

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

Замещает IBusinessValueProvider.

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

     {
         $providerInstance = null;
  
         if (is_array($mapping))
         {
             switch ($mapping['PROVIDER_KEY'])
             {
                 case 'SHIPMENT': $providerInstance = $this; break;
                 case 'COMPANY' : $providerInstance = $this->getField('COMPANY_ID'); break;
                 default:
                     $order = $this->getOrder();
                     if ($order)
                     {
                         $providerInstance = $order->getBusinessValueProviderInstance($mapping);
                     }
             }
         }
  
         return $providerInstance;
     }

◆ getCompanyId()

getCompanyId ( )

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

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

     {
         return (int)$this->getField('COMPANY_ID');
     }

◆ getCurrency()

getCurrency ( )

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

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

     {
         return (string)$this->getField('CURRENCY');
     }

◆ getCustomizableFields()

static getCustomizableFields ( )

static

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

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

                                                    : array
     {
         return ['PRICE_DELIVERY' => 'PRICE_DELIVERY', 'WEIGHT' => 'WEIGHT'];
     }

◆ getDelivery()

getDelivery ( )

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

Исключения

Main

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

     {
         if ($this->service === null)
         {
             $this->service = $this->loadDeliveryService();
         }
  
         return $this->service;
     }

◆ getDeliveryId()

getDeliveryId ( )

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

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

     {
         return (int)$this->getField('DELIVERY_ID');
     }

◆ getDeliveryName()

getDeliveryName ( )

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

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

     {
         return (string)$this->getField('DELIVERY_NAME');
     }

◆ getEntityEventName()

static getEntityEventName ( )

static

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

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

     {
         return 'SaleShipment';
     }

◆ getErrorEntity()

getErrorEntity ( $value )

Аргументы

$value

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

Замещает IEntityMarker.

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

     {
         $className = null;
         $errorsList = static::getAutoFixErrorsList();
         if (is_array($errorsList) && in_array($value, $errorsList))
         {
             $className = static::getClassName();
         }
         else
         {
             /** @var ShipmentItemCollection $shipmentItemCollection */
             if ($shipmentItemCollection = $this->getShipmentItemCollection())
             {
                 $className = $shipmentItemCollection->getErrorEntity($value);
             }
         }
  
         return $className;
     }

◆ getExtraServices()

getExtraServices ( )

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

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

     {
         if($this->extraServices === null)
         {
             $this->setExtraServices(
                 Delivery\ExtraServices\Manager::getValuesForShipment(
                     $this->getId(),
                     $this->getDeliveryId()
                 )
             );
         }
  
         return $this->extraServices;
     }

◆ getFieldsMap()

static getFieldsMap ( )

staticprotected

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

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

     {
         return Internals\ShipmentTable::getMap();
     }

◆ getFixMethod()

static getFixMethod ( $code )

staticprotected

Аргументы

$code

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

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

     {
         $codeList = static::getAutoFixRules();
  
         if (!empty($codeList[$code]))
         {
             return $codeList[$code];
         }
         return null;
     }

◆ getList()

static getList ( array $parameters )

static

Аргументы

array $parameters

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

Исключения

Main

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

     {
         return Internals\ShipmentTable::getList($parameters);
     }

◆ getMarkField()

getMarkField ( )

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

Замещает IEntityMarker.

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

     {
         return 'MARKED';
     }

◆ getMeaningfulFields()

static getMeaningfulFields ( )

staticprotected

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

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

     {
         return array('BASE_PRICE_DELIVERY', 'DELIVERY_ID');
     }

◆ getOrder()

getOrder ( )

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

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

     {
         return $this->getCollection()->getOrder();
     }

◆ getParentOrder()

getParentOrder ( )

Уст.:: Use getOrder instead

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

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

     {
         return $this->getOrder();
     }

◆ getParentOrderId()

getParentOrderId ( )

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

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

     {
         $order = $this->getParentOrder();
         if (!$order)
         {
             return false;
         }
  
         return $order->getId();
     }

◆ getPersonTypeId()

getPersonTypeId ( )

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

Замещает IBusinessValueProvider.

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

     {
         $order = $this->getOrder();
         if ($order)
         {
             return $order->getPersonTypeId();
         }
  
         return null;
     }

◆ getPrice()

getPrice ( )

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

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

     {
         return (float)$this->getField('PRICE_DELIVERY');
     }

◆ getRegistryEntity()

static getRegistryEntity ( )

static

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

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

     {
         return Registry::ENTITY_SHIPMENT;
     }

◆ getRegistryType()

static getRegistryType ( )

static

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

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

     {
         return Registry::REGISTRY_TYPE_ORDER;
     }

◆ getServiceParams()

getServiceParams ( )

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

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

     {
         $params = $this->getField('PARAMS');
         return isset($params["SERVICE_PARAMS"]) ? $params["SERVICE_PARAMS"] : array();
     }

◆ getShipmentCode()

getShipmentCode ( )

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

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

     {
         if ($this->internalId === 0)
         {
             if ($this->getId() > 0)
             {
                 $this->internalId = $this->getId();
             }
             else
             {
                 static::$idShipment++;
                 $this->internalId = static::$idShipment;
             }
         }
         return $this->internalId;
     }

◆ getShipmentItemCollection()

getShipmentItemCollection ( )

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

Исключения

Main

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

     {
         if (empty($this->shipmentItemCollection))
         {
             $registry = Registry::getInstance(static::getRegistryType());
  
             /** @var ShipmentItemCollection $itemCollectionClassName */
             $itemCollectionClassName = $registry->getShipmentItemCollectionClassName();
             $this->shipmentItemCollection = $itemCollectionClassName::load($this);
         }
  
         return $this->shipmentItemCollection;
     }

◆ getShippedDate()

getShippedDate ( )

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

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

     {
         return $this->getField('DATE_DEDUCTED');
     }

◆ getShippedUserId()

getShippedUserId ( )

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

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

     {
         return $this->getField('EMP_DEDUCTED_ID');
     }

◆ getStoreId()

getStoreId ( )

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

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

     {
         if($this->storeId === null)
         {
             $this->setStoreId(
                 Delivery\ExtraServices\Manager::getStoreIdForShipment(
                     $this->getId(),
                     $this->getDeliveryId()
             ));
         }
  
         return $this->storeId;
     }

◆ getUfId()

static getUfId ( )

static

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

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

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

     {
         return Internals\ShipmentTable::getUfId();
     }

◆ getUnshipReason()

getUnshipReason ( )

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

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

     {
         return (string)$this->getField('REASON_UNDO_DEDUCTED');
     }

◆ getVatRate()

getVatRate ( )

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

Исключения

Main

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

     {
         $vatRate = 0;
  
         $service = $this->getDelivery();
         if ($service)
         {
             if (!Main\Loader::includeModule('catalog'))
             {
                 return $vatRate;
             }
  
             $vatId = $service->getVatId();
             if ($vatId <= 0)
             {
                 return $vatRate;
             }
  
             $dbRes = VatTable::getById($vatId);
             $vatInfo = $dbRes->fetch();
             if ($vatInfo)
             {
                 $vatRate = $vatInfo['RATE'] / 100;
             }
         }
  
         return $vatRate;
     }

◆ getVatSum()

getVatSum ( )

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

Исключения

Main

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

     {
         $vatRate = $this->getVatRate();
         $price = $this->getPrice() * $vatRate / (1 + $vatRate);
  
         return PriceMaths::roundPrecision($price);
     }

◆ getWeight()

getWeight ( )

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

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

                                 : float
     {
         return (float)$this->getField('WEIGHT');
     }

◆ isAllowDelivery()

isAllowDelivery ( )

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

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

     {
         return $this->getField('ALLOW_DELIVERY') === "Y";
     }

◆ isCanceled()

isCanceled ( )

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

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

     {
         return $this->getField('CANCELED') === 'Y';
     }

◆ isChanged()

isChanged ( )

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

Исключения

Main

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

     {
         if (parent::isChanged())
         {
             return true;
         }
  
         return $this->getShipmentItemCollection()->isChanged();
     }

◆ isCustomPrice()

isCustomPrice ( )

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

Исключения

Main

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

     {
         return $this->isMarkedFieldCustom('PRICE_DELIVERY');
     }

◆ isEmpty()

isEmpty ( )

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

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

     {
         return $this->getShipmentItemCollection()->isEmpty();
     }

◆ isExistBasketItem()

isExistBasketItem ( BasketItem $basketItem )

Аргументы

BasketItem $basketItem

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

Исключения

Main

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

     {
         /** @var ShipmentItemCollection $shipmentItemCollection */
         if (!$shipmentItemCollection = $this->getShipmentItemCollection())
         {
             throw new Main\ObjectNotFoundException('Entity "ShipmentItemCollection" not found');
         }
  
         return $shipmentItemCollection->isExistBasketItem($basketItem);
     }

◆ isMarked()

isMarked ( )

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

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

     {
         return $this->getField('MARKED') === "Y";
     }

◆ isReserved()

isReserved ( )

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

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

     {
         return $this->getField('RESERVED') === "Y";
     }

◆ isShipped()

isShipped ( )

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

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

     {
         return $this->getField('DEDUCTED') === 'Y';
     }

◆ isSystem()

isSystem ( )

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

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

     {
         return $this->getField('SYSTEM') === 'Y';
     }

◆ loadDeliveryService()

loadDeliveryService ( )

protected

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

Исключения

Main

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

     {
         if ($deliveryId = $this->getDeliveryId())
         {
             return Delivery\Services\Manager::getObjectById($deliveryId);
         }
  
         return null;
     }

◆ loadForOrder()

static loadForOrder ( $id )

static

Аргументы

$id

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

Исключения

Main

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

     {
         if (intval($id) <= 0)
         {
             throw new Main\ArgumentNullException("id");
         }
  
         $shipments = [];
  
         $shipmentDataList = static::getList([
             'filter' => [
                 'ORDER_ID' => $id
             ],
             'order' => [
                 'SYSTEM' => 'ASC',
                 'DATE_INSERT' => 'ASC',
                 'ID' => 'ASC'
             ]
         ]);
         while ($shipmentData = $shipmentDataList->fetch())
         {
             $shipments[] = static::createShipmentObject($shipmentData);
         }
  
  
         return $shipments;
     }

◆ markSystem()

markSystem ( )

protected

Исключения

Main

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

     {
         $this->setFieldNoDemand("SYSTEM", 'Y');
     }

◆ needReservation()

needReservation ( )

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

     {
         $condition = Configuration::getProductReservationCondition();
  
         if ($condition === Configuration::RESERVE_ON_CREATE)
         {
             return true;
         }
  
         if ($condition === Configuration::RESERVE_ON_PAY
             || $condition === Configuration::RESERVE_ON_FULL_PAY)
         {
             $order = $this->getOrder();
             if ($condition === Configuration::RESERVE_ON_FULL_PAY)
             {
                 return $order->isPaid();
             }
  
             /** @var PaymentCollection $paymentCollection */
             if (!$paymentCollection = $order->getPaymentCollection())
             {
                 throw new Main\ObjectNotFoundException('Entity "PaymentCollection" not found');
             }
  
             return $paymentCollection->hasPaidPayment();
         }
  
         if ($this->isSystem())
         {
             return false;
         }
  
         return (($condition === Configuration::RESERVE_ON_ALLOW_DELIVERY) && $this->isAllowDelivery()
             || ($condition === Configuration::RESERVE_ON_SHIP) && $this->isShipped());
     }

◆ needShip()

needShip ( )

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

     {
         if ($this->fields->isChanged('DEDUCTED'))
         {
             if ($this->getField('DEDUCTED') === "Y")
             {
                 return true;
             }
             elseif ($this->getField('DEDUCTED') === "N" && $this->getId() != 0)
             {
                 return false;
             }
         }
  
         return null;
     }

◆ onAfterSave()

onAfterSave ( $isNew )

protected

Аргументы

$isNew

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

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

     {
         return;
     }

◆ onBasketModify()

onBasketModify	(		$action,
		BasketItem	$basketItem,
			$name = `null`,
			$oldValue = `null`,
			$value = `null`
	)

Аргументы

	$action
BasketItem	$basketItem
null	$name
null	$oldValue
null	$value

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

Исключения

Main

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

     {
         $result = new Result();
  
         if ($action === EventActions::ADD)
         {
             if (!$this->isSystem())
             {
                 return $result;
             }
  
             return $this->getShipmentItemCollection()->onBasketModify($action, $basketItem, $name, $oldValue, $value);
         }
         elseif ($action === EventActions::UPDATE)
         {
             if ($name === "QUANTITY")
             {
                 if ($this->isSystem())
                 {
                     return $this->syncQuantityAfterModify($basketItem, $value, $oldValue);
                 }
  
                 /** @var ShipmentItemCollection $shipmentItemCollection */
                 $shipmentItemCollection = $this->getShipmentItemCollection();
  
                 $r = $shipmentItemCollection->onBasketModify($action, $basketItem, $name, $oldValue, $value);
  
                 if (
                     $r->isSuccess()
                     && !$this->isCustomPrice()
                 )
                 {
                     /** @var Delivery\CalculationResult $deliveryCalculate */
                     $deliveryCalculate = $this->calculateDelivery();
                     if ($deliveryCalculate->isSuccess())
                     {
                         $this->setField('BASE_PRICE_DELIVERY', $deliveryCalculate->getPrice());
                     }
                     else
                     {
                         $result->addWarnings($deliveryCalculate->getErrors());
                     }
                 }
             }
             elseif ($name === 'WEIGHT')
             {
                 if (!$this->isMarkedFieldCustom('WEIGHT'))
                 {
                     if ($this->getShipmentItemCollection()->isExistBasketItem($basketItem))
                     {
                         $this->setField('WEIGHT', $this->getShipmentItemCollection()->getWeight());
                     }
                 }
             }
             elseif ($name === 'PRICE')
             {
                 if (!$this->isMarkedFieldCustom('BASE_PRICE_DELIVERY'))
                 {
                     if ($this->getShipmentItemCollection()->isExistBasketItem($basketItem))
                     {
                         $r = $this->calculateDelivery();
                         if ($r->isSuccess())
                         {
                             $this->setField('BASE_PRICE_DELIVERY', $r->getPrice());
                         }
                         else
                         {
                             $result->addErrors($r->getErrors());
                         }
                     }
                 }
             }
         }
  
         return $result;
     }

◆ onBeforeBasketItemDelete()

onBeforeBasketItemDelete ( BasketItem $basketItem )

Аргументы

BasketItem $basketItem

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

Исключения

Main

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

     {
         $result = new Result();
  
         $shipmentItemCollection = $this->getShipmentItemCollection();
         $r = $shipmentItemCollection->onBeforeBasketItemDelete($basketItem);
         if (!$r->isSuccess())
         {
             return $result->addErrors($r->getErrors());
         }
  
         if ($this->isSystem())
         {
             return $this->syncQuantityAfterModify($basketItem);
         }
  
         return $result;
     }

◆ onBeforeSetFields()

onBeforeSetFields ( array $values )

protected

Аргументы

array $values

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

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

     {
         if (isset($values['DEDUCTED']))
         {
             if ($this->getField('DEDUCTED') === 'Y')
             {
                 if ($values['DEDUCTED'] === 'N')
                 {
                     $values = ['DEDUCTED' => $values['DEDUCTED']] + $values;
                 }
             }
             else
             {
                 if ($values['DEDUCTED'] === 'Y')
                 {
                     // move to the end of array
                     unset($values['DEDUCTED']);
                     $values['DEDUCTED'] = 'Y';
                 }
             }
         }
  
         return $values;
     }

◆ onFieldModify()

onFieldModify	(	$name,
		$oldValue,
		$value
	)

protected

Аргументы

string	$name
mixed	$oldValue
mixed	$value

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

Исключения

Main

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

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

     {
         global $USER;
  
         $result = new Result();
  
         if ($name === "MARKED")
         {
             if ($oldValue != "Y")
             {
                 $this->setField('DATE_MARKED', new Main\Type\DateTime());
  
                 if (is_object($USER))
                 {
                     $this->setField('EMP_MARKED_ID', $USER->GetID());
                 }
             }
             elseif ($value === "N")
             {
                 $this->setField('REASON_MARKED', '');
             }
         }
         elseif ($name === "ALLOW_DELIVERY")
         {
             $this->setField('DATE_ALLOW_DELIVERY', new Main\Type\DateTime());
  
             if (is_object($USER))
             {
                 $this->setField('EMP_ALLOW_DELIVERY_ID', $USER->GetID());
             }
  
             if ($oldValue === 'N')
             {
                 $shipmentStatus = Main\Config\Option::get('sale', 'shipment_status_on_allow_delivery', '');
  
                 $registry = Registry::getInstance(static::getRegistryType());
                 /** @var DeliveryStatus $deliveryStatus */
                 $deliveryStatusClassName = $registry->getDeliveryStatusClassName();
  
                 if (strval($shipmentStatus) != '' && $this->getField('STATUS_ID') != $deliveryStatusClassName::getFinalStatus())
                 {
                     $r = $this->setStatus($shipmentStatus);
                     if (!$r->isSuccess())
                     {
                         $result->addErrors($r->getErrors());
                     }
                 }
             }
  
             Internals\EventsPool::addEvent(
                 's'.$this->getInternalIndex(),
                 EventActions::EVENT_ON_SHIPMENT_ALLOW_DELIVERY,
                 [
                     'ENTITY' => $this,
                     'VALUES' => $this->fields->getOriginalValues()
                 ]
             );
         }
         elseif ($name === "DEDUCTED")
         {
             $this->setField('DATE_DEDUCTED', new Main\Type\DateTime());
  
             if (is_object($USER))
             {
                 $this->setField('EMP_DEDUCTED_ID', $USER->GetID());
             }
  
             if ($oldValue === 'N')
             {
                 $shipmentStatus = Main\Config\Option::get('sale', 'shipment_status_on_shipped', '');
  
                 $registry = Registry::getInstance(static::getRegistryType());
                 /** @var DeliveryStatus $deliveryStatus */
                 $deliveryStatusClassName = $registry->getDeliveryStatusClassName();
  
                 if (strval($shipmentStatus) != '' && $this->getField('STATUS_ID') != $deliveryStatusClassName::getFinalStatus())
                 {
                     $r = $this->setStatus($shipmentStatus);
                     if (!$r->isSuccess())
                     {
                         $result->addErrors($r->getErrors());
                     }
                 }
             }
  
             if ($value === 'Y')
             {
                 /** @var ShipmentItem $shipmentItem */
                 foreach ($this->getShipmentItemCollection() as $shipmentItem)
                 {
                     $r = $shipmentItem->checkMarkingCodeOnDeducted();
                     if (!$r->isSuccess())
                     {
                         $result->addErrors($r->getErrors());
                     }
                 }
             }
  
             Internals\EventsPool::addEvent(
                 's'.$this->getInternalIndex(),
                 EventActions::EVENT_ON_SHIPMENT_DEDUCTED,
                 [
                     'ENTITY' => $this,
                     'VALUES' => $this->fields->getOriginalValues()
                 ]
             );
  
             Cashbox\Internals\Pool::addDoc($this->getOrder()->getInternalId(), $this);
         }
         elseif ($name === "STATUS_ID")
         {
             $event = new Main\Event(
                 'sale',
                 EventActions::EVENT_ON_BEFORE_SHIPMENT_STATUS_CHANGE,
                 [
                     'ENTITY' => $this,
                     'VALUE' => $value,
                     'OLD_VALUE' => $oldValue,
                 ]
             );
             $event->send();
  
             Internals\EventsPool::addEvent(
                 's'.$this->getInternalIndex(),
                 EventActions::EVENT_ON_SHIPMENT_STATUS_CHANGE,
                 [
                     'ENTITY' => $this,
                     'VALUE' => $value,
                     'OLD_VALUE' => $oldValue,
                 ]
             );
  
             Internals\EventsPool::addEvent(
                 's'.$this->getInternalIndex(),
                 EventActions::EVENT_ON_SHIPMENT_STATUS_CHANGE_SEND_MAIL,
                 [
                     'ENTITY' => $this,
                     'VALUE' => $value,
                     'OLD_VALUE' => $oldValue,
                 ]
             );
         }
         elseif ($name === 'RESPONSIBLE_ID')
         {
             $this->setField('DATE_RESPONSIBLE_ID', new Main\Type\DateTime());
         }
         elseif ($name === 'TRACKING_NUMBER')
         {
             if ($value)
             {
                 Internals\EventsPool::addEvent(
                     's'.$this->getInternalIndex(),
                     EventActions::EVENT_ON_SHIPMENT_TRACKING_NUMBER_CHANGE,
                     [
                         'ENTITY' => $this,
                         'VALUES' => $this->getFields()->getOriginalValues(),
                     ]
                 );
             }
         }
  
  
         $r = parent::onFieldModify($name, $oldValue, $value);
         if (!$r->isSuccess())
         {
             $result->addErrors($r->getErrors());
         }
  
         if ($r->hasWarnings())
         {
             $result->addWarnings($r->getWarnings());
         }
  
         if (($resultData = $r->getData()) && !empty($resultData))
         {
             $result->addData($resultData);
         }
  
         return $result;
     }

◆ onShipmentItemCollectionModify()

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

Аргументы

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

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

Исключения

Main

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

     {
         if ($action != EventActions::UPDATE)
         {
             return new Result();
         }
  
         if ($this->isSystem()
             && $name != 'RESERVED_QUANTITY'
         )
         {
             throw new Main\NotSupportedException(Loc::getMessage('SALE_SHIPMENT_SYSTEM_SHIPMENT_CHANGE'));
         }
  
         if ($name === "QUANTITY")
         {
             $result = $this->transferItem2SystemShipment($shipmentItem, $oldValue - $value);
  
             if (!$this->isMarkedFieldCustom('WEIGHT'))
             {
                 $this->setField(
                     'WEIGHT',
                     $this->getShipmentItemCollection()->getWeight()
                 );
             }
  
             return $result;
         }
         elseif ($name === 'RESERVED_QUANTITY')
         {
             $order = $this->getParentOrder();
             if ($order &&
                 !Internals\ActionEntity::isTypeExists(
                     $order->getInternalId(),
                     Internals\ActionEntity::ACTION_ENTITY_SHIPMENT_COLLECTION_RESERVED_QUANTITY
                 )
             )
             {
                 Internals\ActionEntity::add(
                     $order->getInternalId(),
                     Internals\ActionEntity::ACTION_ENTITY_SHIPMENT_COLLECTION_RESERVED_QUANTITY,
                     [
                         'METHOD' => 'Bitrix\Sale\ShipmentCollection::updateReservedFlag',
                         'PARAMS' => [$this->getCollection()]
                     ]
                 );
             }
         }
  
         return new Result();
     }

◆ resetData()

resetData ( )

Исключения

Main

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

     {
         if (!$this->isCustomPrice())
         {
             $this->setField('BASE_PRICE_DELIVERY', 0);
         }
     }

◆ save()

save ( )

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

     {
         $this->checkCallingContext();
  
         $result = new Result();
  
         $id = $this->getId();
         $isNew = ($this->getId() === 0);
  
         $this->callEventOnBeforeEntitySaved();
  
         if ($id > 0)
         {
             $r = $this->update();
         }
         else
         {
             $r = $this->add();
  
             if ($r->getId() > 0)
             {
                 $id = $r->getId();
             }
         }
  
         if (!$r->isSuccess())
         {
             $result->addErrors($r->getErrors());
             return $result;
         }
  
         if ($id > 0)
         {
             $result->setId($id);
  
             $controller = Internals\CustomFieldsController::getInstance();
             $controller->save($this);
         }
  
         if (!$this->isSystem())
         {
             $this->saveExtraServices();
             $this->saveStoreId();
         }
  
         $this->callEventOnEntitySaved();
  
         $this->callDelayedEvents();
  
         $shipmentItemCollection = $this->getShipmentItemCollection();
         $r = $shipmentItemCollection->save();
         if (!$r->isSuccess())
         {
             $result->addErrors($r->getErrors());
             return $result;
         }
  
         if (!$this->isSystem())
         {
             $registry = Registry::getInstance(static::getRegistryType());
  
             /** @var OrderHistory $orderHistory */
             $orderHistory = $registry->getOrderHistoryClassName();
             $orderHistory::collectEntityFields('SHIPMENT', $this->getParentOrderId(), $id);
         }
  
         $this->onAfterSave($isNew);
  
         return $result;
     }

◆ saveExtraServices()

saveExtraServices ( )

protected

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

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

     {
         return Delivery\ExtraServices\Manager::saveValuesForShipment($this->getId(), $this->getExtraServices());
     }

◆ saveStoreId()

saveStoreId ( )

protected

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

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

     {
         return Delivery\ExtraServices\Manager::saveStoreIdForShipment($this->getId(), $this->getDeliveryId(), $this->getStoreId());
     }

◆ setAccountNumber()

setAccountNumber ( $id )

Аргументы

$id

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

Исключения

Main

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

     {
         $result = new Result();
         $accountNumber = null;
         $id = intval($id);
         if ($id <= 0)
         {
             $result->addError(new ResultError(Loc::getMessage('SALE_PAYMENT_GENERATE_ACCOUNT_NUMBER_ORDER_NUMBER_WRONG_ID'), 'SALE_PAYMENT_GENERATE_ACCOUNT_NUMBER_ORDER_NUMBER_WRONG_ID'));
             return $result;
         }
  
         $value = Internals\AccountNumberGenerator::generateForShipment($this);
  
         try
         {
             /** @var \Bitrix\Sale\Result $r */
             $r = static::updateInternal($id, array("ACCOUNT_NUMBER" => $value));
             $res = $r->isSuccess(true);
         }
         catch (Main\DB\SqlQueryException $exception)
         {
             $res = false;
         }
  
         if ($res)
         {
             $this->setFieldNoDemand('ACCOUNT_NUMBER', $value);
         }
  
         return $result;
     }

◆ setBasePriceDelivery()

setBasePriceDelivery	(	$value,
		$custom = `false`
	)

Аргументы

	$value
bool	$custom

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

Исключения

Main

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

     {
         $result = new Result();
  
         if ($custom === true)
         {
             $this->markFieldCustom('PRICE_DELIVERY');
         }
  
         $r = $this->setField('BASE_PRICE_DELIVERY', $value);
         if (!$r->isSuccess())
         {
             $result->addErrors($r->getErrors());
         }
  
         return $result;
     }

◆ setDeliveryRequestMarker()

setDeliveryRequestMarker ( )

protected

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

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

     {
         $order = $this->getParentOrder();
  
         Requests\Manager::onBeforeShipmentSave($order, $this);
     }

◆ setDeliveryService()

setDeliveryService ( Delivery\Services\Base $service )

Аргументы

Delivery\Services\Base $service

Исключения

Main

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

     {
         $this->service = $service;
  
         $result = $this->setField("DELIVERY_ID", $service->getId());
         if ($result->isSuccess())
         {
             $this->setField("DELIVERY_NAME", $service->getName());
         }
     }

◆ setExtraServices()

setExtraServices ( array $extraServices )

Аргументы

array $extraServices

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

     {
         $this->extraServices = $extraServices;
     }

◆ setField()

setField	(	$name,
		$value
	)

Sets new value to specified field of shipment item.

Аргументы

string	$name
mixed	$value

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

Исключения

Main

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

     {
         if ($this->isSystem())
         {
             throw new Main\NotSupportedException();
         }
  
         if ($name === "REASON_MARKED" && mb_strlen($value) > 255)
         {
             $value = mb_substr($value, 0, 255);
         }
  
         $priceFields = [
             'BASE_PRICE_DELIVERY' => 'BASE_PRICE_DELIVERY',
             'PRICE_DELIVERY' => 'PRICE_DELIVERY',
             'DISCOUNT_PRICE' => 'DISCOUNT_PRICE',
         ];
         if (isset($priceFields[$name]))
         {
             $value = PriceMaths::roundPrecision($value);
         }
  
         if ($name === 'CUSTOM_PRICE_DELIVERY')
         {
             if ($value === 'Y')
             {
                 $this->markFieldCustom('PRICE_DELIVERY');
             }
             else
             {
                 $this->unmarkFieldCustom('PRICE_DELIVERY');
             }
         }
  
         return parent::setField($name, $value);
     }

◆ setFieldNoDemand()

setFieldNoDemand	(	$name,
		$value
	)

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

     {
         $priceFields = [
             'BASE_PRICE_DELIVERY' => 'BASE_PRICE_DELIVERY',
             'PRICE_DELIVERY' => 'PRICE_DELIVERY',
             'DISCOUNT_PRICE' => 'DISCOUNT_PRICE',
         ];
         if (isset($priceFields[$name]))
         {
             $value = PriceMaths::roundPrecision($value);
         }
  
         if ($name === 'CUSTOM_PRICE_DELIVERY')
         {
             if ($value === 'Y')
             {
                 $this->markFieldCustom('PRICE_DELIVERY');
             }
             else
             {
                 $this->unmarkFieldCustom('PRICE_DELIVERY');
             }
         }
  
         parent::setFieldNoDemand($name, $value);
     }

◆ setOrderId()

setOrderId ( $orderId )

Аргументы

$orderId

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

     {
         $this->setField('ORDER_ID', $orderId);
     }

◆ setServiceParams()

setServiceParams ( array $serviceParams )

Аргументы

array $serviceParams

Исключения

Main

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

     {
         $params = $this->getField('PARAMS');
         $params["SERVICE_PARAMS"] = $serviceParams;
         $this->setField("PARAMS", $params);
     }

◆ setStatus()

setStatus ( $status )

protected

Аргументы

$status

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

Исключения

Main

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

     {
         global $USER;
  
         $result = new Result();
  
         $registry = Registry::getInstance(static::getRegistryType());
         /** @var DeliveryStatus $deliveryStatus */
         $deliveryStatusClassName = $registry->getDeliveryStatusClassName();
  
         if (is_object($USER)  && $USER->isAuthorized())
         {
             $statusesList = $deliveryStatusClassName::getAllowedUserStatuses($USER->getID(), $this->getField('STATUS_ID'));
         }
         else
         {
             $statusesList = $deliveryStatusClassName::getAllStatuses();
         }
  
         if($this->getField('STATUS_ID') != $status && array_key_exists($status, $statusesList))
         {
             /** @var Result $r */
             $r = $this->setField('STATUS_ID', $status);
             if (!$r->isSuccess())
             {
                 $result->addErrors($r->getErrors());
                 return $result;
             }
         }
  
         return $result;
     }

◆ setStoreId()

setStoreId ( $storeId )

Аргументы

$storeId

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

     {
         $this->storeId = (int)$storeId;
     }

◆ setWeight()

setWeight ( float $weight )

Аргументы

float $weight

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

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

     {
         return $this->setField('WEIGHT', $weight);
     }

◆ syncQuantityAfterModify()

syncQuantityAfterModify	(	BasketItem	$basketItem,
			$value = `null`,
			$oldValue = `null`
	)

protected

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

     {
         $result = new Result();
  
         /** @var ShipmentItemCollection $shipmentItemCollection */
         if (!$shipmentItemCollection = $this->getShipmentItemCollection())
         {
             throw new Main\ObjectNotFoundException('Entity "ShipmentItemCollection" not found');
         }
  
         $shipmentItem = $shipmentItemCollection->getItemByBasketCode($basketItem->getBasketCode());
  
         if ($value === 0)
         {
             if ($shipmentItem !== null)
             {
                 $shipmentItem->setFieldNoDemand('QUANTITY', 0);
             }
  
             return $result;
         }
  
         if ($shipmentItem === null)
         {
             $shipmentItem = $shipmentItemCollection->createItem($basketItem);
         }
  
         $deltaQuantity = $value - $oldValue;
  
  
         /** @var Basket $basket */
         $basket = $basketItem->getCollection();
         if (!$basket)
         {
             throw new Main\ObjectNotFoundException('Entity "Basket" not found');
         }
  
         /** @var Order $order */
         $order = $basket->getOrder();
         if (!$order)
         {
             throw new Main\ObjectNotFoundException('Entity "Order" not found');
         }
  
         $context = [
             'USER_ID' => $order->getUserId(),
             'SITE_ID' => $order->getSiteId(),
             'CURRENCY' => $order->getCurrency(),
         ];
  
         if ($deltaQuantity > 0)     // plus
         {
             $shipmentItem->setFieldNoDemand(
                 "QUANTITY",
                 $shipmentItem->getField("QUANTITY") + $deltaQuantity
             );
  
             if ($this->needReservation())
             {
                 /** @var Result $tryReserveResult */
                 Internals\Catalog\Provider::tryReserveShipmentItem($shipmentItem, $context);
             }
         }
         else        // minus
         {
             if (floatval($shipmentItem->getField("QUANTITY")) <= 0)
             {
                 return new Result();
             }
  
             if ($value != 0 && roundEx($shipmentItem->getField("QUANTITY"), SALE_VALUE_PRECISION) < roundEx(-$deltaQuantity, SALE_VALUE_PRECISION))
             {
                 $result->addError(
                     new ResultError(
                         str_replace(
                             array("#NAME#", "#QUANTITY#", "#DELTA_QUANTITY#"),
                             array($basketItem->getField("NAME"), $shipmentItem->getField("QUANTITY"), abs($deltaQuantity)),
                             Loc::getMessage('SALE_SHIPMENT_SYSTEM_QUANTITY_ERROR')
                         ),
                         'SALE_SHIPMENT_SYSTEM_QUANTITY_ERROR'
                     )
                 );
                 return $result;
             }
  
             if ($value > 0)
             {
                 $shipmentItem->setFieldNoDemand(
                     "QUANTITY",
                     $shipmentItem->getField("QUANTITY") + $deltaQuantity
                 );
                 if ($this->needReservation())
                 {
                     Internals\Catalog\Provider::tryReserveShipmentItem($shipmentItem, $context);
                 }
             }
  
         }
  
         return $result;
     }

◆ toArray()

toArray ( )

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

Исключения

Main

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

                               : array
     {
         $result = parent::toArray();
  
         $result['ITEMS'] = $this->getShipmentItemCollection()->toArray();
  
         return $result;
     }

◆ tryFixError()

tryFixError ( $code )

Аргументы

$code

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

Замещает IEntityMarker.

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

     {
         $result = new Result();
  
         $method = static::getFixMethod($code);
         $r = call_user_func_array($method, array($this));
         if (!$r->isSuccess())
         {
             $result->addErrors($r->getErrors());
         }
         elseif ($r->hasWarnings())
         {
             $result->addWarnings($r->getWarnings());
         }
  
         return $result;
     }

◆ tryReserve()

tryReserve ( )

Исключения

Main

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

     {
         return Internals\Catalog\Provider::tryReserveShipment($this);
     }

◆ tryShip()

tryShip ( )

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

Исключения

Main

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

     {
         $result = new Result();
  
         /** @var Result $r */
         $r = Internals\Catalog\Provider::tryShipShipment($this);
         if ($r->isSuccess())
         {
             $resultList = $r->getData();
  
             if (!empty($resultList) && is_array($resultList))
             {
                 /** @var Result $resultDat */
                 foreach ($resultList as $resultDat)
                 {
                     if (!$resultDat->isSuccess())
                     {
                         $result->addErrors( $resultDat->getErrors() );
                     }
                 }
             }
         }
         else
         {
             $result->addErrors( $r->getErrors() );
         }
  
         if ($r->hasWarnings())
         {
             $result->addWarnings( $r->getWarnings() );
         }
         return $result;
     }

◆ tryUnreserve()

tryUnreserve ( )

Исключения

Main

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

     {
         return Internals\Catalog\Provider::tryUnreserveShipment($this);
     }

◆ tryUnship()

tryUnship ( )

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

Исключения

Main

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

     {
         return $this->tryShip();
     }

◆ updateInternal()

updateInternal	(		$primary,
		array	$data
	)

protected

Аргументы

	$primary
array	$data

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

Исключения

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

     {
         return Internals\ShipmentTable::update($primary, $data);
     }

◆ updateReservedFlag()

static updateReservedFlag ( Shipment $shipment )

static

Аргументы

Shipment $shipment

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

Исключения

Main

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

     {
         $shipmentReserved = true;
  
         $shipmentItemList = $shipment->getShipmentItemCollection()->getShippableItems();
  
         if ($shipmentItemList->count() === 0)
         {
             $shipmentReserved = false;
         }
  
         /** @var ShipmentItem $shipmentItem */
         foreach ($shipmentItemList as $shipmentItem)
         {
             if ($shipmentItem->getQuantity() - $shipmentItem->getReservedQuantity())
             {
                 $shipmentReserved = false;
                 break;
             }
         }
  
         $shipmentReservedValue = $shipmentReserved ? "Y" : "N";
         $currentValue = $shipment->getField('RESERVED');
         if ($shipment->getField('RESERVED') != $shipmentReservedValue)
         {
             $eventManager = Main\EventManager::getInstance();
             $eventsList = $eventManager->findEventHandlers('sale', EventActions::EVENT_ON_BEFORE_SHIPMENT_RESERVE);
             if (!empty($eventsList))
             {
                 /** @var Main\Entity\Event $event */
                 $event = new Main\Event('sale', EventActions::EVENT_ON_BEFORE_SHIPMENT_RESERVE, [
                     'ENTITY' => $shipment,
                     'VALUE' => $shipmentReservedValue,
                 ]);
  
                 $event->send();
  
                 if ($event->getResults())
                 {
                     $result = new Result();
                     /** @var Main\EventResult $eventResult */
                     foreach($event->getResults() as $eventResult)
                     {
                         if($eventResult->getType() === Main\EventResult::ERROR)
                         {
                             $errorMsg = new ResultError(Main\Localization\Loc::getMessage('SALE_EVENT_ON_BEFORE_SHIPMENT_RESERVE_ERROR'), 'SALE_EVENT_ON_BEFORE_SHIPMENT_RESERVE_ERROR');
  
                             $eventResultData = $eventResult->getParameters();
                             if ($eventResultData)
                             {
                                 if (isset($eventResultData) && $eventResultData instanceof ResultError)
                                 {
                                     /** @var ResultError $errorMsg */
                                     $errorMsg = $eventResultData;
                                 }
                             }
  
                             $result->addError($errorMsg);
  
                         }
                     }
  
                     if (!$result->isSuccess())
                     {
                         return $result;
                     }
                 }
             }
  
             $shipment->setFieldNoDemand('RESERVED', $shipmentReserved ? "Y" : "N");
  
             Internals\EventsPool::addEvent('s'.$shipment->getInternalIndex(), EventActions::EVENT_ON_SHIPMENT_RESERVED, [
                 'ENTITY' => $shipment,
                 'VALUE' => $shipmentReservedValue,
                 'OLD_VALUE' => $currentValue,
             ]);
         }
  
         return new Result();
     }

◆ verify()

verify ( )

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

Исключения

Main

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

     {
         $result = new Result();
  
         if ($this->getDeliveryId() <= 0)
         {
             $result->addError(
                 new ResultError(
                     Loc::getMessage("SALE_SHIPMENT_DELIVERY_SERVICE_EMPTY"),
                     'SALE_SHIPMENT_DELIVERY_SERVICE_EMPTY'
                 )
             );
         }
  
         /** @var ShipmentItemCollection $shipmentItemCollection */
         if ($shipmentItemCollection = $this->getShipmentItemCollection())
         {
             /** @var ShipmentItem $shipmentItem */
             foreach ($shipmentItemCollection as $shipmentItem)
             {
                 $r = $shipmentItem->verify();
                 if (!$r->isSuccess())
                 {
                     $result->addErrors($r->getErrors());
                 }
             }
         }
  
         return $result;
     }

Поля

◆ $extraServices

$extraServices = null

protected

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

◆ $idShipment

$idShipment = 0

staticprotected

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

◆ $internalId

$internalId = 0

protected

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

◆ $service

$service = null

protected

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

◆ $shipmentItemCollection

$shipmentItemCollection

protected

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

◆ $storeId

$storeId = null

protected

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

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

shipment.php

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

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

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

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

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

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

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

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

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

◆ __construct()

Методы

◆ addChangesToHistory()

◆ addInternal()

◆ allowDelivery()

◆ calculateDelivery()

◆ canAutoFixError()

◆ canMarked()

◆ checkValueBeforeSet()

◆ clearChanged()

◆ create()

◆ createClone()

◆ createSystem()

◆ delete()

◆ deleteDeliveryRequest()

◆ deleteInternal()

◆ deleteNoDemand()

◆ deliver()

◆ disallowDelivery()

◆ fixReserveErrors()

◆ fixShipErrors()

◆ generateXmlId()

◆ getAllowDeliveryDate()

◆ getAllowDeliveryUserId()

◆ getAutoFixErrorsList()

◆ getAutoFixRules()

◆ getAvailableFields()

◆ getBasketItemQuantity()

◆ getBusinessValueProviderInstance()

◆ getCompanyId()

◆ getCurrency()

◆ getCustomizableFields()

◆ getDelivery()

◆ getDeliveryId()

◆ getDeliveryName()

◆ getEntityEventName()

◆ getErrorEntity()

◆ getExtraServices()

◆ getFieldsMap()

◆ getFixMethod()

◆ getList()

◆ getMarkField()

◆ getMeaningfulFields()

◆ getOrder()

◆ getParentOrder()

◆ getParentOrderId()

◆ getPersonTypeId()

◆ getPrice()

◆ getRegistryEntity()

◆ getRegistryType()

◆ getServiceParams()

◆ getShipmentCode()

◆ getShipmentItemCollection()

◆ getShippedDate()

◆ getShippedUserId()

◆ getStoreId()

◆ getUfId()

◆ getUnshipReason()

◆ getVatRate()

◆ getVatSum()

◆ getWeight()

◆ isAllowDelivery()

◆ isCanceled()

◆ isChanged()

◆ isCustomPrice()

◆ isEmpty()

◆ isExistBasketItem()

◆ isMarked()

◆ isReserved()

◆ isShipped()

◆ isSystem()