Класс 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 ()
	setCollection (EntityCollection $collection)
	getCollection ()
	setInternalIndex ($index)
	getInternalIndex ()
	isStartField ($isMeaningfulField=false)
	clearStartField ()
	hasMeaningfulField ()
	doFinalAction ($hasMeaningfulField=false)
	setMathActionOnly ($value=false)
	isMathActionOnly ()
	isClone ()
	fetch (Main\Text\Converter $converter=null)
	getErrorEntity ($value)
	canAutoFixError ($value)

Открытые статические члены
static	getRegistryEntity ()
static	getAvailableFields ()
static	getCustomizableFields ()
static	getRegistryType ()
static	deleteNoDemand ($orderId)
static	loadForOrder ($id)
static	createSystem (ShipmentCollection $collection, Delivery\Services\Base $deliveryService=null)
static	getList (array $parameters)
static	fixReserveErrors (Shipment $entity)
static	fixShipErrors (Shipment $entity)
static	getUfId ()
static	getEntityEventName ()
static	getEntity ()
static	getRow (array $parameters)
static	clearCache ()
static	add (array $data)
static	update ($id, array $data)
static	delete ($id)
static	setCacheItem ($id, array $row)
static	getCacheItem ($id, bool $load=false)
static	clearCacheItem ($id)
static	getTabletClassName ()
static	getTabletFieldNames (int $fields=self::FIELDS_MAIN)
static	getCachedFieldList ()
static	getCallbackRestEvent ()
static	clearSettings ()

Поля данных
const	PREFIX_OLD = 'OLD_'
const	EVENT_ON_BUILD_CACHED_FIELD_LIST = 'OnBuildCachedFieldList'
const	FIELDS_MAIN = 0x0001
const	FIELDS_UF = 0x0002
const	FIELDS_ALL = self::FIELDS_MAIN|self::FIELDS_UF

Защищенные члены
	__construct (array $fields=[])
	onBeforeSetFields (array $values)
	deleteDeliveryRequest ()
	checkValueBeforeSet ($name, $value)
	setDeliveryRequestMarker ()
	onAfterSave ($isNew)
	markSystem ()
	loadDeliveryService ()
	saveExtraServices ()
	saveStoreId ()
	addInternal (array $data)
	updateInternal ($primary, array $data)
	onFieldModify ($name, $oldValue, $value)
	getTablet ()

Защищенные статические члены
static	getMeaningfulFields ()
static	generateXmlId ()
static	getParametersForLoad ($id)
static	getFixMethod ($code)
static	getAutoFixRules ()
static	deleteInternal ($primary)
static	getFieldsMap ()
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
	$collection
	$internalIndex = null
	$isClone = false

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

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

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

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

__construct()

__construct ( array  $fields = [] )

protected

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

    {
        $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);
    }

Методы

add()

static add ( array  $data )

staticinherited

Add entity item. Use instead of DataManager method.

Аргументы

array

$data

Возвращает

ORM\Data\AddResult

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

                                           : ORM\Data\AddResult
    {
        $result = new ORM\Data\AddResult();
 
        $entity = static::getEntity();
 
        static::normalize($data);
 
        if (Event::existEventHandlers($entity, ORM\Data\DataManager::EVENT_ON_BEFORE_ADD))
        {
            $event = new Event(
                $entity,
                ORM\Data\DataManager::EVENT_ON_BEFORE_ADD,
                $data
            );
            $event->send();
 
            $event->mergeData($data);
            if ($event->getErrors($result))
                return $result;
        }
 
        static::prepareForAdd($result, null, $data);
        if (!$result->isSuccess())
            return $result;
        unset($result);
 
        if (Event::existEventHandlers($entity, ORM\Data\DataManager::EVENT_ON_ADD))
        {
            $event = new Event(
                $entity,
                ORM\Data\DataManager::EVENT_ON_ADD,
                $data
            );
            $event->send();
            unset($event);
        }
 
        $result = $entity->getTablet()->add($data['fields']);
        $success = $result->isSuccess();
        if ($success)
        {
            $data['fields'] = $result->getData();
            if ($entity->fieldsCount > 0)
                $entity->setEntityCacheItem((int)$result->getId(), $result->getData(), false);
        }
 
        if (Event::existEventHandlers($entity, ORM\Data\DataManager::EVENT_ON_AFTER_ADD))
        {
            $event = new Event(
                $entity,
                ORM\Data\DataManager::EVENT_ON_AFTER_ADD,
                [
                    'id' => $result->getId(),
                    'fields' => $data['fields'],
                    'external_fields' => $data['external_fields'],
                    'actions' => $data['actions'],
                    'success' => $success
                ]
            );
            $event->send();
            unset($event);
        }
 
        if ($success && !empty($data['actions']))
            static::runAddExternalActions($result->getId(), $data);
 
        unset($success, $entity);
 
        return $result;
    }

addInternal()

addInternal ( array  $data )

protected

Аргументы

array

$data

Возвращает

Entity\AddResult

Исключения

Exception

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

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

allowDelivery()

allowDelivery

(

)

Возвращает

Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

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

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

calculateDelivery()

calculateDelivery

(

)

Возвращает

Delivery\CalculationResult

Исключения

Main

NotSupportedException

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

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

canAutoFixError()

canAutoFixError (   $value )

inherited

Аргументы

$value

Возвращает

bool

Замещается в Payment и ShipmentItemStore.

canMarked()

canMarked

(

)

Возвращает

bool

Замещает IEntityMarker.

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

    {
        return true;
    }

checkValueBeforeSet()

checkValueBeforeSet (   $name,   $value  )

protected

Аргументы

$name
$value

Возвращает

Result

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

    {
        $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;
    }

clearCache()

static clearCache ( )

staticinherited

Clear all cache for entity.

Возвращает

void

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

                                       : void
    {
        static::getEntity()->clearEntityCache();
    }

clearCacheItem()

static clearCacheItem (   $id )

staticinherited

Clear item cache. Do not use without good reason.

Аргументы

int

$id

Возвращает

void @noinspection PhpUnused

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

                                              : void
    {
        $id = (int)$id;
        if ($id <= 0)
            return;
        static::getEntity()->clearEntityCacheItem($id);
    }

clearSettings()

static clearSettings ( )

staticinherited

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

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

: void {}

clearStartField()

clearStartField ( )

inherited

Возвращает

bool

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

    {
        $parent = $this->getCollection();
        if ($parent == null)
            return false;
 
        return $parent->clearStartField();
    }

createSystem()

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

static

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

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

delete() [1/2]

static delete (   $id )

staticinherited

Delete entity item. Use instead of DataManager method.

Аргументы

int

$id

Возвращает

ORM\Data\DeleteResult

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

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

                                      : ORM\Data\DeleteResult
    {
        $result = new ORM\Data\DeleteResult();
 
        $entity = static::getEntity();
 
        if (Event::existEventHandlers($entity, ORM\Data\DataManager::EVENT_ON_BEFORE_DELETE))
        {
            $event = new Event(
                $entity,
                ORM\Data\DataManager::EVENT_ON_BEFORE_DELETE,
                ['id' => $id]
            );
            $event->send();
 
            if ($event->getErrors($result))
                return $result;
        }
 
        if (Event::existEventHandlers($entity, ORM\Data\DataManager::EVENT_ON_DELETE))
        {
            $event = new Event(
                $entity,
                ORM\Data\DataManager::EVENT_ON_DELETE,
                ['id' => $id]
            );
            $event->send();
            unset($event);
        }
 
        if ($entity->fieldsCount > 0 && !isset($entity->cache[$id]))
            $entity->loadEntityCacheItem($id);
 
        $result = $entity->getTablet()->delete($id);
        $success = $result->isSuccess();
        if ($success)
            $entity->expireEntityCacheItem((int)$id);
 
        if (Event::existEventHandlers($entity, ORM\Data\DataManager::EVENT_ON_AFTER_DELETE))
        {
            $event = new Event(
                $entity,
                ORM\Data\DataManager::EVENT_ON_AFTER_DELETE,
                ['id' => $id, 'success' => $success]
            );
            $event->send();
            unset($event);
        }
 
        if ($success)
            static::runDeleteExternalActions($id);
 
        unset($success, $entity);
 
        return $result;
    }

delete() [2/2]

delete

(

)

Deletes shipment

Возвращает

Result

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Main

ObjectNotFoundException

Исключения

Exception

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

    {
        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);
 
            if ($this->getFields()->isMarkedCustom('PRICE_DELIVERY'))
            {
                $this->setField('PRICE_DELIVERY', 0);
            }
 
            $this->disallowDelivery();
        }
 
        $this->getPropertyCollection()->deleteNoDemand($this->getId());
        $this->deleteDeliveryRequest();
 
        $this->getShipmentItemCollection()->clearCollection();
 
        return parent::delete();
    }

deleteDeliveryRequest()

deleteDeliveryRequest ( )

protected

Возвращает

void

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

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

deleteInternal()

static deleteInternal (   $primary )

staticprotected

Аргументы

$primary

Возвращает

Entity\DeleteResult

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

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

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

deleteNoDemand()

static deleteNoDemand (   $orderId )

static

Аргументы

$orderId

Возвращает

Result

Исключения

Main

ArgumentException

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

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

deleteNoDemands()

static deleteNoDemands (   $id )

staticprotectedinherited

Delete entity item without entity events (tablet events only).

Аргументы

int

$id

Возвращает

ORM\Data\DeleteResult

Исключения

Main

ObjectNotFoundException

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

                                                  : ORM\Data\DeleteResult
    {
        $entity = static::getEntity();
 
        if ($entity->fieldsCount > 0 && !isset($entity->cache[$id]))
            $entity->loadEntityCacheItem($id);
 
        $result = $entity->getTablet()->delete($id);
        if ($result->isSuccess())
        {
            if ($entity->fieldsCount > 0)
                $entity->expireEntityCacheItem((int)$id);
            static::runDeleteExternalActions($id);
        }
 
        unset($entity);
 
        return $result;
    }

deliver()

deliver

(

)

Возвращает

Result

Исключения

Main

ObjectNotFoundException

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

    {
        $result = Internals\Catalog\Provider::deliver($this);
        if ($result->isSuccess())
        {
            Recurring::repeat($this->getOrder(), $result->getData());
        }
 
        return $result;
    }

disallowDelivery()

disallowDelivery

(

)

Возвращает

Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

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

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

doFinalAction()

doFinalAction (   $hasMeaningfulField = false )

inherited

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

    {
        $parent = $this->getCollection();
        if ($parent == null)
        {
            return false;
        }
 
        return $parent->doFinalAction($hasMeaningfulField);
    }

fetch()

fetch ( Main\Text\Converter  $converter = null )

inherited

Entity fetch. Work with entity change cache.

Аргументы

Main\Text\Converter | null

$converter

Возвращает

array|false

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

    {
        if ($this->result === null)
            return false;
        $row = $this->result->fetch($converter);
        if (!$row)
        {
            $this->result = null;
            $this->fetchCutMask = [];
            return false;
        }
        if (empty($this->fields))
            return $row;
        if (!isset($row['ID']))
            return $row;
 
        $this->setEntityCacheItem((int)$row['ID'], $row, true);
        if (!empty($this->fetchCutMask))
            $row = array_diff_key($row, $this->fetchCutMask);
        return $row;
    }

fixReserveErrors()

static fixReserveErrors ( Shipment  $entity )

static

Аргументы

Shipment

$entity

Возвращает

Result

Исключения

Main

ObjectNotFoundException

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

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

ObjectNotFoundException

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

    {
        $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 строка 242

    {
        return uniqid('bx_');
    }

getAllowDeliveryDate()

getAllowDeliveryDate

(

)

Возвращает

Main\Type\DateTime

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

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

getAllowDeliveryUserId()

getAllowDeliveryUserId

(

)

Возвращает

int

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

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

getAutoFixErrorsList()

getAutoFixErrorsList

(

)

Возвращает

array

Замещает IEntityMarker.

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

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

getAutoFixRules()

static getAutoFixRules ( )

staticprotected

Возвращает

array

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

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

    {
        return [
            "STATUS_ID",
            "BASE_PRICE_DELIVERY",
            "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'
        ];
    }

getBusinessValueProviderInstance()

getBusinessValueProviderInstance

(

$mapping

)

Аргументы

$mapping

Возвращает

Shipment|null|string

Замещает IBusinessValueProvider.

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

    {
        $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;
    }

getCachedFieldList()

static getCachedFieldList ( )

staticinherited

Returns fields list in cache.

Возвращает

array

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

                                               : array
    {
        $entity = static::getEntity();
        return $entity->fields;
    }

getCacheItem()

static getCacheItem (   $id, bool  $load = false  )

staticinherited

Returns item cache.

Аргументы

int	$id
bool	$load

Возвращает

array|null

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

                                                                : ?array
    {
        $id = (int)$id;
        if ($id <= 0)
            return null;
        return static::getEntity()->getEntityCacheItem($id, $load);
    }

getCallbackRestEvent()

static getCallbackRestEvent ( )

staticinherited

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

                                                 : array
    {
        return [Main\Rest\Event::class, 'processItemEvent'];
    }

getCollection()

getCollection ( )

inherited

Возвращает

EntityCollection

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

    {
        return $this->collection;
    }

getCompanyId()

getCompanyId

(

)

Возвращает

int

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

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

getCurrency()

getCurrency

(

)

Возвращает

string

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

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

getCustomizableFields()

static getCustomizableFields ( )

static

Возвращает

array

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

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

getDefaultCachedFieldList()

static getDefaultCachedFieldList ( )

staticprotectedinherited

Returns entity default fields list for caching.

Возвращает

array

Переопределяется в Price, Product и Vat.

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

                                                         : array
    {
        return [];
    }

getDelivery()

getDelivery

(

)

Возвращает

Delivery\Services\Base

Исключения

Main

ArgumentNullException

Исключения

Main

SystemException

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

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

getDeliveryId()

getDeliveryId

(

)

Возвращает

int

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

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

getDeliveryName()

getDeliveryName

(

)

Возвращает

string

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

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

getEntity()

static getEntity ( )

staticinherited

Returns entity class.

Возвращает

Entity

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

                                      : Entity
    {
        $className = get_called_class();
        if (empty(self::$entity[$className]))
        {
            $entity = new static;
            self::$entity[$className] = $entity;
        }
 
        return self::$entity[$className];
    }

getEntityEventName()

static getEntityEventName ( )

static

Возвращает

null|string

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

    {
        return 'SaleShipment';
    }

getErrorEntity()

getErrorEntity (   $value )

inherited

Аргументы

$value

Возвращает

string

Замещается в Payment и ShipmentItemStore.

getExtraServices()

getExtraServices

(

)

Возвращает

null

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

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

getExtraServicesObjects()

getExtraServicesObjects

(

)

Возвращает

Delivery\ExtraServices\Base[]

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

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

getFieldsMap()

static getFieldsMap ( )

staticprotected

Возвращает

array

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

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

getFixMethod()

static getFixMethod (   $code )

staticprotected

Аргументы

$code

Возвращает

mixed|null

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

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

getInternalIndex()

getInternalIndex ( )

inherited

Возвращает

null|int

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

    {
        return $this->internalIndex;
    }

getList()

static getList ( array  $parameters )

static

Аргументы

array

$parameters

Возвращает

Main\ORM\Query\Result

Исключения

Main

ArgumentException

Исключения

Main

ObjectPropertyException

Исключения

Main

SystemException

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

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

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

getMarkField()

getMarkField

(

)

Возвращает

string

Замещает IEntityMarker.

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

    {
        return 'MARKED';
    }

getMeaningfulFields()

static getMeaningfulFields ( )

staticprotected

Возвращает

array

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

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

getOrder()

getOrder

(

)

Возвращает

Order|null

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

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

getParametersForLoad()

static getParametersForLoad (   $id )

staticprotected

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

                                                        : array
    {
        return [
            'filter' => [
                'ORDER_ID' => $id
            ],
            'order' => [
                'SYSTEM' => 'ASC',
                'DATE_INSERT' => 'ASC',
                'ID' => 'ASC'
            ]
        ];
    }

getParentOrder()

getParentOrder

(

)

Уст.:

Use getOrder instead

Возвращает

Order|null

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

    {
        return $this->getOrder();
    }

getParentOrderId()

getParentOrderId

(

)

Возвращает

bool|int

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

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

getPersonTypeId()

getPersonTypeId

(

)

Возвращает

int|null

Замещает IBusinessValueProvider.

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

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

getPrice()

getPrice

(

)

Возвращает

float

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

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

getPropertyCollection()

getPropertyCollection

(

)

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

                                           : ShipmentPropertyValueCollection
    {
        if(empty($this->propertyCollection))
        {
            $this->propertyCollection = $this->loadPropertyCollection();
        }
 
        return $this->propertyCollection;
    }

getRegistryEntity()

static getRegistryEntity ( )

static

Возвращает

string|void

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

    {
        return Registry::ENTITY_SHIPMENT;
    }

getRegistryType()

static getRegistryType ( )

static

Возвращает

string

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

    {
        return Registry::REGISTRY_TYPE_ORDER;
    }

getRow()

static getRow ( array  $parameters )

staticinherited

Entity getRow with change cache. Wrapper for entity getList.

Аргументы

array

$parameters

Возвращает

array|null

Исключения

Main

ArgumentException

Исключения

Main

ObjectNotFoundException

Исключения

Main

ObjectPropertyException

Исключения

Main

SystemException

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

                                                    : ?array
    {
        $parameters['limit'] = 1;
        $result = static::getList($parameters);
        $row = $result->fetch();
 
        return (is_array($row) ? $row : null);
    }

getServiceParams()

getServiceParams

(

)

Возвращает

array

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

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

getShipmentCode()

getShipmentCode

(

)

Возвращает

int

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

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

getShippedDate()

getShippedDate

(

)

Возвращает

Main\Type\DateTime

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

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

getShippedUserId()

getShippedUserId

(

)

Возвращает

int

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

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

getStoreId()

getStoreId

(

)

Возвращает

int

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

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

getTablet()

getTablet ( )

protectedinherited

Returns entity table object.

Возвращает

ORM\Data\DataManager

Исключения

Main

ObjectNotFoundException

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

                                  : ORM\Data\DataManager
    {
        if (!($this->tablet instanceof ORM\Data\DataManager))
            throw new Main\ObjectNotFoundException(sprintf(
                'Tablet not found in entity `%s`',
                get_class($this)
            ));
        return $this->tablet;
    }

getTabletClassName()

static getTabletClassName ( )

staticinherited

Returns entity tablet name.

Возвращает

string

Переопределяется в Price, Product и Vat.

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

                                               : string
    {
        return '';
    }

getTabletFieldNames()

static getTabletFieldNames ( int  $fields = self::FIELDS_MAIN )

staticinherited

Returns list of tablet field names, include user fields.

Аргументы

int

$fields

Возвращает

array

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

                                                                             : array
    {
        $result = [];
        $entity = static::getEntity();
        if ($fields & self::FIELDS_MAIN)
        {
            $result = array_keys($entity->tabletFields);
        }
        if ($fields & self::FIELDS_UF)
        {
            $list = array_keys($entity->tabletUserFields);
            if (!empty($list))
            {
                $result = (empty($result)
                    ? $list
                    : array_merge($result, $list)
                );
            }
            unset($list);
        }
 
        unset($entity);
        return $result;
    }

getUfId()

static getUfId ( )

static

Возвращает

null

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

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

getUnshipReason()

getUnshipReason

(

)

Возвращает

string

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

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

getVatRate()

getVatRate

(

)

Возвращает

float|int

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

LoaderException

Исключения

Main

ObjectPropertyException

Исключения

Main

SystemException

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

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

ArgumentNullException

Исключения

Main

LoaderException

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

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

getWeight()

getWeight

(

)

Возвращает

float

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

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

hasMeaningfulField()

hasMeaningfulField ( )

inherited

Возвращает

bool

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

    {
        $parent = $this->getCollection();
        if ($parent == null)
            return false;
 
        return $parent->hasMeaningfulField();
    }

isAllowDelivery()

isAllowDelivery

(

)

Возвращает

bool

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

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

isCanceled()

isCanceled

(

)

Возвращает

bool

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

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

isChanged()

isChanged

(

)

Возвращает

bool

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

ObjectNotFoundException

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

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

isClone()

isClone ( )

inherited

Возвращает

bool

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

    {
        return $this->isClone;
    }

isCustomPrice()

isCustomPrice

(

)

Возвращает

bool

Исключения

Main

ArgumentOutOfRangeException

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

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

isEmpty()

isEmpty

(

)

Возвращает

bool

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

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

isMarked()

isMarked

(

)

Возвращает

bool

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

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

isMathActionOnly()

isMathActionOnly ( )

inherited

Возвращает

bool

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

    {
        $parent = $this->getCollection();
        if ($parent == null)
            return false;
 
        return $parent->isMathActionOnly();
    }

isShipped()

isShipped

(

)

Возвращает

bool

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

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

isStartField()

isStartField (   $isMeaningfulField = false )

inherited

Аргументы

bool

$isMeaningfulField

Возвращает

bool

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

    {
        $parent = $this->getCollection();
        if ($parent == null)
            return false;
 
        return $parent->isStartField($isMeaningfulField);
    }

isSystem()

isSystem

(

)

Возвращает

bool

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

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

loadDeliveryService()

loadDeliveryService ( )

protected

Возвращает

Delivery\Services\Base

Исключения

Main

ArgumentNullException

Исключения

Main

SystemException

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

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

loadForOrder()

static loadForOrder (   $id )

static

Аргументы

$id

Возвращает

array

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

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

    {
        if (intval($id) <= 0)
        {
            throw new Main\ArgumentNullException("id");
        }
 
        $shipments = [];
 
        $shipmentDataList = static::getList(static::getParametersForLoad($id));
        while ($shipmentData = $shipmentDataList->fetch())
        {
            $shipments[] = static::createShipmentObject($shipmentData);
        }
 
 
        return $shipments;
    }

markSystem()

markSystem ( )

protected

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

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

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

needReservation()

needReservation

(

)

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

    {
        $condition = Configuration::getProductReservationCondition();
 
        if ($condition === ReserveCondition::ON_CREATE)
        {
            return true;
        }
 
        if ($condition === ReserveCondition::ON_PAY
            || $condition === ReserveCondition::ON_FULL_PAY)
        {
            $order = $this->getOrder();
            if ($condition === ReserveCondition::ON_FULL_PAY)
            {
                return $order->isPaid();
            }
 
            return $order->getPaymentCollection()->hasPaidPayment();
        }
 
        if ($this->isSystem())
        {
            return false;
        }
 
        return
            (
                $condition === ReserveCondition::ON_ALLOW_DELIVERY
                && $this->isAllowDelivery()
            )
            || (
                $condition === ReserveCondition::ON_SHIP
                && $this->isShipped()
            )
        ;
    }

needShip()

needShip

(

)

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

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

normalize()

static normalize ( array &  $data )

staticprotectedinherited

Normalize data before prepare. Convert fields list into complex structure.

Аргументы

array

&$data

Возвращает

void

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

                                                     : void
    {
        $result = [
            'fields' => [],
            'external_fields' => [],
            'actions' => []
        ];
 
        if (isset($data['fields']) && is_array($data['fields']))
        {
            $result['fields'] = $data['fields'];
            if (isset($data['external_fields']) && is_array($data['external_fields']))
                $result['external_fields'] = $data['external_fields'];
            if (isset($data['actions']) && is_array($data['actions']))
                $result['actions'] = $data['actions'];
        }
        else
        {
            $result['fields'] = $data;
        }
 
        $data = $result;
        unset($result);
    }

onAfterSave()

onAfterSave (   $isNew )

protected

Аргументы

$isNew

Возвращает

void

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

    {
        return;
    }

onBeforeBasketItemDelete()

onBeforeBasketItemDelete

(

BasketItem

$basketItem

)

Аргументы

BasketItem

$basketItem

Возвращает

Result

Исключения

Main

ArgumentException

Исключения

Main

ArgumentNullException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Main

ObjectNotFoundException

Исключения

Main

SystemException

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

    {
        $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 строка 147

    {
        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  )

protectedinherited

Аргументы

string	$name
mixed	$oldValue
mixed	$value

Возвращает

Result

Переопределяется в PayableBasketItem, PayableShipmentItem, ReserveQuantity и TradeBindingEntity.

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

    {
        $collection = $this->getCollection();
        return $collection->onItemModify($this, $name, $oldValue, $value);
    }

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 строка 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();
    }

prepareFloatValue()

static prepareFloatValue (   $value )

staticprotectedinherited

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

                                                       : ?float
    {
        if ($value === null)
        {
            return null;
        }
 
        $result = null;
        if (is_string($value))
        {
            if ($value !== '' && is_numeric($value))
            {
                $value = (float)$value;
                if (is_finite($value))
                {
                    $result = $value;
                }
            }
        }
        else
        {
            if (is_int($value))
            {
                $value = (float)$value;
            }
            if (
                is_float($value) && is_finite($value)
            )
            {
                $result = $value;
            }
        }
 
        return $result;
    }

prepareForAdd()

static prepareForAdd ( ORM\Data\AddResult  $result,   $id, array &  $data  )

staticprotectedinherited

Check and modify fields before add entity item. Need for entity automation.

Аргументы

ORM\Data\AddResult	$result
int | null	$id
array	&$data

Возвращает

void

Переопределяется в Price, Product и Vat.

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

                                                                                          : void
    {
        $data = static::getEntity()->checkTabletWhiteList($data);
        if (empty($data))
        {
            $result->addError(new ORM\EntityError(sprintf(
                'Empty data for add in entity `%s`',
                get_called_class()
            )));
        }
    }

prepareForUpdate()

static prepareForUpdate ( ORM\Data\UpdateResult  $result,   $id, array &  $data  )

staticprotectedinherited

Check and modify fields before update entity item. Need for entity automation.

Аргументы

ORM\Data\UpdateResult	$result
int	$id
array	&$data

Возвращает

void

Переопределяется в Price, Product и Vat.

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

                                                                                                : void
    {
        $data = static::getEntity()->checkTabletWhiteList($data);
        if (empty($data))
        {
            $result->addError(new ORM\EntityError(sprintf(
                'Empty data for update in entity `%s`',
                get_called_class()
            )));
        }
    }

prepareIntValue()

static prepareIntValue (   $value )

staticprotectedinherited

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

                                                     : ?int
    {
        if ($value === null)
        {
            return null;
        }
 
        $result = null;
        if (is_string($value))
        {
            if ($value !== '' && is_numeric($value))
            {
                $result = (int)$value;
            }
        }
        elseif (is_int($value))
        {
            $result = $value;
        }
 
        return $result;
    }

prepareStringValue()

static prepareStringValue (   $value )

staticprotectedinherited

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

                                                        : ?string
    {
        if (is_string($value))
        {
            return trim($value) ?: null;
        }
 
        return null;
    }

resetData()

resetData

(

)

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

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

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

runAddExternalActions()

static runAddExternalActions (   $id, array  $data  )

staticprotectedinherited

Run core automation after add entity item.

Аргументы

int	$id
array	$data

Возвращает

void

Переопределяется в Price и Product.

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

: void {}

runDeleteExternalActions()

static runDeleteExternalActions (   $id )

staticprotectedinherited

Run core automation after delete entity item.

Аргументы

int

$id

Возвращает

void

Переопределяется в Price и Product.

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

: void {}

runUpdateExternalActions()

static runUpdateExternalActions (   $id, array  $data  )

staticprotectedinherited

Run core automation after update entity item.

Аргументы

int	$id
array	$data

Возвращает

void

Переопределяется в Price и Product.

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

: void {}

saveExtraServices()

saveExtraServices ( )

protected

Возвращает

Result

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

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

saveStoreId()

saveStoreId ( )

protected

Возвращает

Result

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

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

setBasePriceDelivery()

setBasePriceDelivery	(		$value,
			$custom = false
	)

Аргументы

	$value
bool	$custom

Возвращает

Result

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

    {
        $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;
    }

setCacheItem()

static setCacheItem (   $id, array  $row  )

staticinherited

Fill item cache data. Do not use without good reason.

Аргументы

int	$id
array	$row

Возвращает

void

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

                                                        : void
    {
        $id = (int)$id;
        if ($id <= 0 || empty($row))
            return;
        static::getEntity()->setEntityCacheItem($id, $row, false);
    }

setCollection()

setCollection ( EntityCollection  $collection )

inherited

Аргументы

EntityCollection

$collection

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

    {
        $this->collection = $collection;
    }

setDeliveryRequestMarker()

setDeliveryRequestMarker ( )

protected

Возвращает

void

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

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

setDeliveryService()

setDeliveryService

(

Delivery\Services\Base

$service

)

Аргументы

Delivery\Services\Base

$service

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

    {
        $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 строка 2097

    {
        $this->extraServices = $extraServices;
    }

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

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

    {
        $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);
    }

setInternalIndex()

setInternalIndex (   $index )

inherited

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

    {
        $this->internalIndex = $index;
    }

setMathActionOnly()

setMathActionOnly (   $value = false )

inherited

Аргументы

bool | false

$value

Возвращает

bool

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

    {
        $parent = $this->getCollection();
        if ($parent == null)
        {
            return false;
        }
 
        return $parent->setMathActionOnly($value);
    }

setOrderId()

setOrderId

(

$orderId

)

Аргументы

$orderId

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

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

setServiceParams()

setServiceParams

(

array

$serviceParams

)

Аргументы

array

$serviceParams

Исключения

Main

NotSupportedException

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

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

setStoreId()

setStoreId

(

$storeId

)

Аргументы

$storeId

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

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

setWeight()

setWeight

(

float

$weight

)

Аргументы

float

$weight

Возвращает

string|null

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

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

toArray()

toArray

(

)

Возвращает

array

Исключения

Main

ArgumentException

Исключения

Main

SystemException

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

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

tryFixError()

tryFixError

(

$code

)

Аргументы

$code

Возвращает

Result

Замещает IEntityMarker.

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

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

ArgumentException

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

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

tryUnreserve()

tryUnreserve

(

)

Исключения

Main

ArgumentOutOfRangeException

Исключения

Main

NotSupportedException

Исключения

Exception

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

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

tryUnship()

tryUnship

(

)

Возвращает

Result

Исключения

Main

NotSupportedException

Исключения

Main

ObjectNotFoundException

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

    {
        return $this->tryShip();
    }

update()

static update (   $id, array  $data  )

staticinherited

Update entity item. Use instead of DataManager method.

Аргументы

int	$id
array	$data

Возвращает

ORM\Data\UpdateResult

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

                                                   : ORM\Data\UpdateResult
    {
        $result = new ORM\Data\UpdateResult();
 
        $entity = static::getEntity();
 
        static::normalize($data);
 
        if (Event::existEventHandlers($entity, ORM\Data\DataManager::EVENT_ON_BEFORE_UPDATE))
        {
            $event = new Event(
                $entity,
                ORM\Data\DataManager::EVENT_ON_BEFORE_UPDATE,
                [
                    'id' => $id,
                    'fields' => $data['fields'],
                    'external_fields' => $data['external_fields'],
                    'actions' => $data['actions']
                ]
            );
            $event->send();
 
            $event->mergeData($data);
            if ($event->getErrors($result))
                return $result;
        }
 
        static::prepareForUpdate($result, $id, $data);
        if (!$result->isSuccess())
            return $result;
        unset($result);
 
        if (Event::existEventHandlers($entity, ORM\Data\DataManager::EVENT_ON_UPDATE))
        {
            $event = new Event(
                $entity,
                ORM\Data\DataManager::EVENT_ON_UPDATE,
                [
                    'id' => $id,
                    'fields' => $data['fields'],
                    'external_fields' => $data['external_fields'],
                    'actions' => $data['actions']
                ]
            );
            $event->send();
            unset($event);
        }
 
        $result = $entity->getTablet()->update($id, $data['fields']);
        $success = $result->isSuccess();
        if ($success)
        {
            $data['fields'] = $result->getData();
            if ($entity->fieldsCount > 0)
                $entity->modifyEntityCacheItem($id, $data['fields']);
        }
 
        if (Event::existEventHandlers($entity, ORM\Data\DataManager::EVENT_ON_AFTER_UPDATE))
        {
            $event = new Event(
                $entity,
                ORM\Data\DataManager::EVENT_ON_AFTER_UPDATE,
                [
                    'id' => $id,
                    'fields' => $data['fields'],
                    'external_fields' => $data['external_fields'],
                    'actions' => $data['actions'],
                    'success' => $success
                ]
            );
            $event->send();
            unset($event);
        }
 
        if ($success && !empty($data['actions']))
            static::runUpdateExternalActions($id, $data);
 
        unset($success, $entity);
 
        return $result;
    }

updateInternal()

updateInternal (   $primary, array  $data  )

protected

Аргументы

	$primary
array	$data

Возвращает

Entity\UpdateResult

Исключения

Exception

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

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

Поля

$collection

$collection

protectedinherited

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

$extraServices

$extraServices = null

protected

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

$idShipment

$idShipment = 0

staticprotected

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

$internalId

$internalId = 0

protected

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

$internalIndex

$internalIndex = null

protectedinherited

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

$isClone

$isClone = false

protectedinherited

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

$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

EVENT_ON_BUILD_CACHED_FIELD_LIST

const EVENT_ON_BUILD_CACHED_FIELD_LIST = 'OnBuildCachedFieldList'

inherited

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

FIELDS_ALL

const FIELDS_ALL = self::FIELDS_MAIN|self::FIELDS_UF

inherited

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

FIELDS_MAIN

const FIELDS_MAIN = 0x0001

inherited

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

FIELDS_UF

const FIELDS_UF = 0x0002

inherited

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

PREFIX_OLD

const PREFIX_OLD = 'OLD_'

inherited

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

---

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

• C:/Bitrix/modules/sale/lib/shipment.php