Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
ShippingInformation Class Reference
Inheritance diagram for ShippingInformation:
AbstractExtensibleModel ShippingInformationInterface AbstractModel CustomAttributesDataInterface CustomAttributesDataInterface DataObject ExtensibleDataInterface ExtensibleDataInterface

Public Member Functions

 getShippingAddress ()
 
 setShippingAddress (\Magento\Quote\Api\Data\AddressInterface $address)
 
 getBillingAddress ()
 
 setBillingAddress (\Magento\Quote\Api\Data\AddressInterface $address)
 
 getShippingMethodCode ()
 
 setShippingMethodCode ($code)
 
 getShippingCarrierCode ()
 
 setShippingCarrierCode ($code)
 
 getExtensionAttributes ()
 
 setExtensionAttributes (\Magento\Checkout\Api\Data\ShippingInformationExtensionInterface $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 ShippingInformationInterface
 setShippingAddress (\Magento\Quote\Api\Data\AddressInterface $address)
 
 setBillingAddress (\Magento\Quote\Api\Data\AddressInterface $address)
 

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 ShippingInformationInterface
const SHIPPING_ADDRESS = 'shipping_address'
 
const BILLING_ADDRESS = 'billing_address'
 
const SHIPPING_METHOD_CODE = 'shipping_method_code'
 
const SHIPPING_CARRIER_CODE = 'shipping_carrier_code'
 
- 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

@codeCoverageIgnoreStart

Definition at line 14 of file ShippingInformation.php.

Member Function Documentation

◆ getBillingAddress()

getBillingAddress ( )

{Returns billing address

Returns
\Magento\Quote\Api\Data\AddressInterface|null
}

Implements ShippingInformationInterface.

Definition at line 35 of file ShippingInformation.php.

36  {
37  return $this->getData(self::BILLING_ADDRESS);
38  }

◆ getExtensionAttributes()

getExtensionAttributes ( )

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

Returns
\Magento\Checkout\Api\Data\ShippingInformationExtensionInterface|null
}

Implements ShippingInformationInterface.

Definition at line 83 of file ShippingInformation.php.

◆ getShippingAddress()

getShippingAddress ( )

{#- Returns shipping address

Returns
\Magento\Quote\Api\Data\AddressInterface
}

Implements ShippingInformationInterface.

Definition at line 19 of file ShippingInformation.php.

20  {
21  return $this->getData(self::SHIPPING_ADDRESS);
22  }

◆ getShippingCarrierCode()

getShippingCarrierCode ( )

{Returns carrier code

Returns
string
}

Implements ShippingInformationInterface.

Definition at line 67 of file ShippingInformation.php.

68  {
69  return $this->getData(self::SHIPPING_CARRIER_CODE);
70  }

◆ getShippingMethodCode()

getShippingMethodCode ( )

{Returns shipping method code

Returns
string
}

Implements ShippingInformationInterface.

Definition at line 51 of file ShippingInformation.php.

52  {
53  return $this->getData(self::SHIPPING_METHOD_CODE);
54  }

◆ setBillingAddress()

setBillingAddress ( \Magento\Quote\Api\Data\AddressInterface  $address)

{}

Definition at line 43 of file ShippingInformation.php.

44  {
45  return $this->setData(self::BILLING_ADDRESS, $address);
46  }
$address
Definition: customer.php:38

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Checkout\Api\Data\ShippingInformationExtensionInterface  $extensionAttributes)

{Set an extension attributes object.

Parameters
\Magento\Checkout\Api\Data\ShippingInformationExtensionInterface$extensionAttributes
Returns
$this
}

Implements ShippingInformationInterface.

Definition at line 91 of file ShippingInformation.php.

93  {
95  }
_setExtensionAttributes(\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

◆ setShippingAddress()

setShippingAddress ( \Magento\Quote\Api\Data\AddressInterface  $address)

{}

Definition at line 27 of file ShippingInformation.php.

28  {
29  return $this->setData(self::SHIPPING_ADDRESS, $address);
30  }
$address
Definition: customer.php:38

◆ setShippingCarrierCode()

setShippingCarrierCode (   $code)

{Set carrier code

Parameters
string$code
Returns
$this
}

Implements ShippingInformationInterface.

Definition at line 75 of file ShippingInformation.php.

76  {
77  return $this->setData(self::SHIPPING_CARRIER_CODE, $code);
78  }
$code
Definition: info.phtml:12

◆ setShippingMethodCode()

setShippingMethodCode (   $code)

{Set shipping method code

Parameters
string$code
Returns
$this
}

Implements ShippingInformationInterface.

Definition at line 59 of file ShippingInformation.php.

60  {
61  return $this->setData(self::SHIPPING_METHOD_CODE, $code);
62  }
$code
Definition: info.phtml:12

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