How does a shipment saving work?

dmitrii_fediuk · April 26, 2016, 12:24pm

Context: How does \Magento\Shipping\Controller\Adminhtml\Order\Shipment\Save::_saveShipment() work?

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/AbstractModel.php#L622-L633


/**
 * Save object data
 *
 * @deprecated
 * @return $this
 * @throws \Exception
 */
public function save()
{
    $this->_getResource()->save($this);
    return $this;
}

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/ResourceModel/Db/AbstractDb.php#L371-L380


/**
 * Save object object data
 *
 * @param \Magento\Framework\Model\AbstractModel $object
 * @return $this
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 * @throws \Exception
 * @api
 */
public function save(\Magento\Framework\Model\AbstractModel $object)

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/ResourceModel/Db/AbstractDb.php#L679-L692


/**
 * Serialize serializable fields of the object
 *
 * @param \Magento\Framework\Model\AbstractModel $object
 * @return void
 * @SuppressWarnings(PHPMD.UnusedLocalVariable)
 */
protected function _serializeFields(\Magento\Framework\Model\AbstractModel $object)
{
    foreach ($this->_serializableFields as $field => $parameters) {
        list($serializeDefault, $unserializeDefault) = $parameters;
        $this->_serializeField($object, $field, $serializeDefault, isset($parameters[2]));
    }
}

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/ResourceModel/AbstractResource.php#L108-L117


/**
 * Serialize specified field in an object
 *
 * @param \Magento\Framework\DataObject $object
 * @param string $field
 * @param mixed $defaultValue
 * @param bool $unsetEmpty
 * @return $this
 */
protected function _serializeField(\Magento\Framework\DataObject $object, $field, $defaultValue = null, $unsetEmpty = false)

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/ResourceModel/AbstractResource.php#L119-L127


$value = $object->getData($field);
if (empty($value)) {
    if ($unsetEmpty) {
        $object->unsetData($field);
    } else {
        if (is_object($defaultValue) || is_array($defaultValue)) {
            $defaultValue = serialize($defaultValue);
        }
        $object->setData($field, $defaultValue);

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Model/ResourceModel/Order/Shipment.php#L45-L65


/**
 * Perform actions before object save
 *
 * @param \Magento\Framework\Model\AbstractModel|\Magento\Framework\DataObject $object
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
protected function _beforeSave(\Magento\Framework\Model\AbstractModel $object)
{
    /** @var \Magento\Sales\Model\Order\Shipment $object */
    if ((!$object->getId() || null !== $object->getItems()) && !count($object->getAllItems())) {
        throw new \Magento\Framework\Exception\LocalizedException(__('We cannot create an empty shipment.'));
    }


    if (!$object->getOrderId() && $object->getOrder()) {
        $object->setOrderId($object->getOrder()->getId());
        $object->setShippingAddressId($object->getOrder()->getShippingAddress()->getId());
    }


    return parent::_beforeSave($object);
}

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Model/ResourceModel/EntityAbstract.php#L113-L133


/**
 * Perform actions before object save
 * Perform actions before object save, calculate next sequence value for increment Id
 *
 * @param \Magento\Framework\Model\AbstractModel|\Magento\Framework\DataObject $object
 * @return $this
 */
protected function _beforeSave(\Magento\Framework\Model\AbstractModel $object)
{
    /** @var \Magento\Sales\Model\AbstractModel $object */
    if ($object instanceof EntityInterface && $object->getIncrementId() == null) {
        $object->setIncrementId(
            $this->sequenceManager->getSequence(
                $object->getEntityType(),
                $object->getStore()->getGroup()->getDefaultStoreId()
            )->getNextValue()
        );
    }
    parent::_beforeSave($object);
    return $this;
}

Details: How does \Magento\Sales\Model\ResourceModel\EntityAbstract::_beforeSave() work?

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/ResourceModel/Db/AbstractDb.php#L631-L641


/**
 * Perform actions before object save
 *
 * @param \Magento\Framework\Model\AbstractModel|\Magento\Framework\DataObject $object
 * @return $this
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
protected function _beforeSave(\Magento\Framework\Model\AbstractModel $object)
{
    return $this;
}

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/ResourceModel/Db/AbstractDb.php#L401-L401


$this->objectRelationProcessor->validateDataIntegrity($this->getMainTable(), $object->getData());

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/ResourceModel/Db/ObjectRelationProcessor.php#L35-L46


/**
 * Validate integrity of the given data
 *
 * @param string $table
 * @param array $involvedData
 * @return void
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function validateDataIntegrity($table, array $involvedData)
{
    return;
}

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/ResourceModel/Db/AbstractDb.php#L402-L406


if ($this->isObjectNotNew($object)) {
    $this->updateObject($object);
} else {
    $this->saveNewObject($object);
}

Details: How does \Magento\Sales\Model\ResourceModel\EntityAbstract::saveNewObject() work?

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/ResourceModel/Db/AbstractDb.php#L407-L408


$this->unserializeFields($object);
$this->processAfterSaves($object);

Details: How does \Magento\Framework\Model\ResourceModel\Db\VersionControl\AbstractDb::processAfterSaves() work?

github.com

magento/magento2/blob/958164/lib/internal/Magento/Framework/Model/ResourceModel/Db/AbstractDb.php#L410-L411


$this->addCommitCallback([$object, 'afterCommitCallback'])->commit();
$object->setHasDataChanges(false);

dmitrii_fediuk · April 26, 2016, 12:25pm