Shipping Class Reference

Inheritance diagram for Shipping:

Public Member Functions
	getAddress ()
	getMethod ()
	getTotal ()
	setAddress (\Magento\Sales\Api\Data\OrderAddressInterface $address)
	setMethod ($method)
	setTotal (\Magento\Sales\Api\Data\TotalInterface $total)
	getExtensionAttributes ()
	setExtensionAttributes (\Magento\Sales\Api\Data\ShippingExtensionInterface $extensionAttributes)
Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	getCustomAttributes ()
	getCustomAttribute ($attributeCode)
	setCustomAttributes (array $attributes)
	setCustomAttribute ($attributeCode, $attributeValue)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	setId ($value)
	__sleep ()
	__wakeup ()
Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	__sleep ()
	__wakeup ()
	setIdFieldName ($name)
	getIdFieldName ()
	getId ()
	setId ($value)
	isDeleted ($isDeleted=null)
	hasDataChanges ()
	setData ($key, $value=null)
	unsetData ($key=null)
	setDataChanges ($value)
	getOrigData ($key=null)
	setOrigData ($key=null, $data=null)
	dataHasChangedFor ($field)
	getResourceName ()
	getResourceCollection ()
	getCollection ()
	load ($modelId, $field=null)
	beforeLoad ($identifier, $field=null)
	afterLoad ()
	isSaveAllowed ()
	setHasDataChanges ($flag)
	save ()
	afterCommitCallback ()
	isObjectNew ($flag=null)
	beforeSave ()
	validateBeforeSave ()
	getCacheTags ()
	cleanModelCache ()
	afterSave ()
	delete ()
	beforeDelete ()
	afterDelete ()
	afterDeleteCommit ()
	getResource ()
	getEntityId ()
	setEntityId ($entityId)
	clearInstance ()
	getStoredData ()
	getEventPrefix ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)
Public Member Functions inherited from ShippingInterface
	setAddress (\Magento\Sales\Api\Data\OrderAddressInterface $address)
	setTotal (\Magento\Sales\Api\Data\TotalInterface $total)
	setExtensionAttributes (\Magento\Sales\Api\Data\ShippingExtensionInterface $extensionAttributes)

Additional Inherited Members
Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'
Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'
Data Fields inherited from ShippingInterface
const	KEY_ADDRESS = 'address'
const	KEY_METHOD = 'method'
const	KEY_TOTAL = 'total'
Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)
	initializeCustomAttributes ()
	convertCustomAttributeValues (array &$customAttributes)
	getCustomAttributesCodes ()
	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)
	_getExtensionAttributes ()
Protected Member Functions inherited from AbstractModel
	_construct ()
	_init ($resourceModel)
	_setResourceModel ($resourceName, $collectionName=null)
	_getResource ()
	_getEventData ()
	_beforeLoad ($modelId, $field=null)
	_afterLoad ()
	_hasModelChanged ()
	_getValidatorBeforeSave ()
	_createValidatorBeforeSave ()
	_getValidationRulesBeforeSave ()
	_clearReferences ()
	_clearData ()
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory
	$extensionAttributes
	$customAttributeFactory
	$customAttributesCodes = null
	$customAttributesChanged = false
Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'
	$_eventObject = 'object'
	$_idFieldName = 'id'
	$_hasDataChanges = false
	$_origData
	$_isDeleted = false
	$_resource
	$_resourceCollection
	$_resourceName
	$_collectionName
	$_cacheTag = false
	$_dataSaveAllowed = true
	$_isObjectNew = null
	$_validatorBeforeSave = null
	$_eventManager
	$_cacheManager
	$_registry
	$_logger
	$_appState
	$_actionValidator
	$storedData = []
Protected Attributes inherited from DataObject
	$_data = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Definition at line 11 of file Shipping.php.

Member Function Documentation

getAddress()

getAddress

(

)

{#- Gets shipping address

Returns

\Magento\Sales\Api\Data\OrderAddressInterface|null

Since

100.0.4

}

Implements ShippingInterface.

Definition at line 16 of file Shipping.php.

    {
        return $this->_getData(self::KEY_ADDRESS);
    }

getExtensionAttributes()

getExtensionAttributes

(

)

{Retrieve existing extension attributes object or create a new one.

Returns

\Magento\Sales\Api\Data\ShippingExtensionInterface|null

Since

100.0.4

}

Implements ShippingInterface.

Definition at line 64 of file Shipping.php.

    {
        return $this->_getExtensionAttributes();
    }

getMethod()

getMethod

(

)

{Gets shipping method

Returns

string|null

Since

100.0.4

}

Implements ShippingInterface.

Definition at line 24 of file Shipping.php.

    {
        return $this->_getData(self::KEY_METHOD);
    }

getTotal()

getTotal

(

)

{Gets object with shipping totals

Returns

\Magento\Sales\Api\Data\TotalInterface|null

Since

100.0.4

}

Implements ShippingInterface.

Definition at line 32 of file Shipping.php.

    {
        return $this->_getData(self::KEY_TOTAL);
    }

setAddress()

setAddress

(

\Magento\Sales\Api\Data\OrderAddressInterface

$address

)

{}

Definition at line 40 of file Shipping.php.

    {
        return $this->setData(self::KEY_ADDRESS, $address);
    }

setExtensionAttributes()

setExtensionAttributes

(

\Magento\Sales\Api\Data\ShippingExtensionInterface

$extensionAttributes

)

{}

Definition at line 72 of file Shipping.php.

      {
        return $this->_setExtensionAttributes($extensionAttributes);
    }

setMethod()

setMethod

(

$method

)

{Sets method to shipping

Parameters

string

$method

Returns

$this

Since

100.0.4

}

Implements ShippingInterface.

Definition at line 48 of file Shipping.php.

    {
        return $this->setData(self::KEY_METHOD, $method);
    }

setTotal()

setTotal

(

\Magento\Sales\Api\Data\TotalInterface

$total

)

{}

Definition at line 56 of file Shipping.php.

    {
        return $this->setData(self::KEY_TOTAL, $total);
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/module-sales/Model/Order/Shipping.php