Class Mage_Sales_Model_Order_Shipment

Description

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@magentocommerce.com so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

Located in /Sales/Model/Order/Shipment.php (line 28)

Varien_Object
   |
   --Mage_Core_Model_Abstract
      |
      --Mage_Sales_Model_Abstract
         |
         --Mage_Sales_Model_Order_Shipment
Class Constant Summary
REPORT_DATE_TYPE_ORDER_CREATED = 'order_created'
REPORT_DATE_TYPE_SHIPMENT_CREATED = 'shipment_created'
XML_PATH_EMAIL_COPY_METHOD = 'sales_email/shipment/copy_method'
XML_PATH_EMAIL_COPY_TO = 'sales_email/shipment/copy_to'
XML_PATH_EMAIL_ENABLED = 'sales_email/shipment/enabled'
XML_PATH_EMAIL_GUEST_TEMPLATE = 'sales_email/shipment/guest_template'
XML_PATH_EMAIL_IDENTITY = 'sales_email/shipment/identity'
XML_PATH_EMAIL_TEMPLATE = 'sales_email/shipment/template'
XML_PATH_UPDATE_EMAIL_COPY_METHOD = 'sales_email/shipment_comment/copy_method'
XML_PATH_UPDATE_EMAIL_COPY_TO = 'sales_email/shipment_comment/copy_to'
XML_PATH_UPDATE_EMAIL_ENABLED = 'sales_email/shipment_comment/enabled'
XML_PATH_UPDATE_EMAIL_GUEST_TEMPLATE = 'sales_email/shipment_comment/guest_template'
XML_PATH_UPDATE_EMAIL_IDENTITY = 'sales_email/shipment_comment/identity'
XML_PATH_UPDATE_EMAIL_TEMPLATE = 'sales_email/shipment_comment/template'
Variable Summary
mixed $_comments
mixed $_items
mixed $_order
mixed $_tracks
Method Summary
Variables
mixed $_comments (line 52)
  • access: protected
mixed $_eventObject = 'shipment' (line 55)
  • access: protected

Redefinition of:
Mage_Core_Model_Abstract::$_eventObject
Parameter name in event
mixed $_eventPrefix = 'sales_order_shipment' (line 54)
  • access: protected

Redefinition of:
Mage_Core_Model_Abstract::$_eventPrefix
Prefix of model events names
mixed $_items (line 49)
  • access: protected
mixed $_order (line 51)
  • access: protected
mixed $_tracks (line 50)
  • access: protected

Inherited Variables

Inherited from Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::$_cacheTag
Mage_Core_Model_Abstract::$_dataSaveAllowed
Mage_Core_Model_Abstract::$_isObjectNew
Mage_Core_Model_Abstract::$_resource
Mage_Core_Model_Abstract::$_resourceCollectionName
Mage_Core_Model_Abstract::$_resourceName
Methods
addComment (line 287)

Adds comment to shipment with additional possibility to send it to customer via email and show it in customer account

  • access: public
Mage_Sales_Model_Order_Shipment addComment ( $comment, [bool $notify = false], [bool $visibleOnFront = false])
  • bool $notify
  • bool $visibleOnFront
  • $comment
addItem (line 211)
  • access: public
void addItem (Mage_Sales_Model_Order_Shipment_Item $item)
addTrack (line 259)
  • access: public
void addTrack (Mage_Sales_Model_Order_Shipment_Track $track)
getAllItems (line 190)
  • access: public
void getAllItems ()
getAllTracks (line 238)
  • access: public
void getAllTracks ()
getBillingAddress (line 128)

Retrieve billing address

  • access: public
Mage_Sales_Model_Order_Address getBillingAddress ()
getCommentsCollection (line 304)
  • access: public
void getCommentsCollection ([ $reload = false])
  • $reload
getItemById (line 201)
  • access: public
void getItemById ( $itemId)
  • $itemId
getItemsCollection (line 175)
  • access: public
void getItemsCollection ()
getOrder (line 115)

Retrieve the order the shipment for created for

  • access: public
getProtectCode (line 105)

Retrieve hash code of current order

  • access: public
string getProtectCode ()
getShippingAddress (line 138)

Retrieve shipping address

  • access: public
Mage_Sales_Model_Order_Address getShippingAddress ()
getStore (line 554)

Retrieve store model instance

  • access: public
Mage_Core_Model_Store getStore ()

Redefinition of:
Mage_Sales_Model_Abstract::getStore()
Get object store identifier
getTrackById (line 249)
  • access: public
void getTrackById ( $trackId)
  • $trackId
getTracksCollection (line 223)
  • access: public
void getTracksCollection ()
loadByIncrementId (line 71)

Load shipment by increment id

  • access: public
Mage_Sales_Model_Order_Shipment loadByIncrementId (string $incrementId)
  • string $incrementId
register (line 150)

Register shipment

Apply to order, order items etc.

  • access: public
unknown register ()
sendEmail (line 332)

Send email with shipment data

  • access: public
Mage_Sales_Model_Order_Shipment sendEmail ([boolean $notifyCustomer = true], [string $comment = ''])
  • boolean $notifyCustomer
  • string $comment
sendUpdateEmail (line 422)

Send email with shipment update information

  • access: public
Mage_Sales_Model_Order_Shipment sendUpdateEmail ([boolean $notifyCustomer = true], [string $comment = ''])
  • boolean $notifyCustomer
  • string $comment
setOrder (line 91)

Declare order for shipment

  • access: public
_afterSave (line 526)

After object save manipulations

  • access: protected

Redefinition of:
Mage_Sales_Model_Abstract::_afterSave()
Processing object after save data Updates relevant grid table records.
_beforeDelete (line 515)
  • access: protected
void _beforeDelete ()

Redefinition of:
Mage_Core_Model_Abstract::_beforeDelete()
Processing object before delete data
_beforeSave (line 499)

Before object save

  • access: protected

Redefinition of:
Mage_Core_Model_Abstract::_beforeSave()
Processing object before save data
_construct (line 60)

Initialize shipment resource model

  • access: protected
void _construct ()
_getEmails (line 485)
  • access: protected
void _getEmails ( $configPath)
  • $configPath

Inherited Methods

Inherited From Mage_Sales_Model_Abstract

Mage_Sales_Model_Abstract::getCreatedAtDate()
Mage_Sales_Model_Abstract::getCreatedAtStoreDate()
Mage_Sales_Model_Abstract::getStore()
Mage_Sales_Model_Abstract::_afterSave()

Inherited From Mage_Core_Model_Abstract

Mage_Core_Model_Abstract::afterCommitCallback()
Mage_Core_Model_Abstract::afterLoad()
Mage_Core_Model_Abstract::cleanModelCache()
Mage_Core_Model_Abstract::clearInstance()
Mage_Core_Model_Abstract::delete()
Mage_Core_Model_Abstract::getCacheIdTags()
Mage_Core_Model_Abstract::getCacheTags()
Mage_Core_Model_Abstract::getCollection()
Mage_Core_Model_Abstract::getEntityId()
Mage_Core_Model_Abstract::getId()
Mage_Core_Model_Abstract::getIdFieldName()
Mage_Core_Model_Abstract::getResource()
Mage_Core_Model_Abstract::getResourceCollection()
Mage_Core_Model_Abstract::getResourceName()
Mage_Core_Model_Abstract::isObjectNew()
Mage_Core_Model_Abstract::load()
Mage_Core_Model_Abstract::save()
Mage_Core_Model_Abstract::setId()
Mage_Core_Model_Abstract::_afterDelete()
Mage_Core_Model_Abstract::_afterDeleteCommit()
Mage_Core_Model_Abstract::_afterLoad()
Mage_Core_Model_Abstract::_afterSave()
Mage_Core_Model_Abstract::_afterSaveCommit()
Mage_Core_Model_Abstract::_beforeDelete()
Mage_Core_Model_Abstract::_beforeLoad()
Mage_Core_Model_Abstract::_beforeSave()
Mage_Core_Model_Abstract::_clearData()
Mage_Core_Model_Abstract::_clearReferences()
Mage_Core_Model_Abstract::_getEventData()
Mage_Core_Model_Abstract::_getResource()
Mage_Core_Model_Abstract::_hasModelChanged()
Mage_Core_Model_Abstract::_init()
Mage_Core_Model_Abstract::_protectFromNonAdmin()
Mage_Core_Model_Abstract::_setResourceModel()
Class Constants
REPORT_DATE_TYPE_ORDER_CREATED = 'order_created' (line 46)
REPORT_DATE_TYPE_SHIPMENT_CREATED = 'shipment_created' (line 47)
STATUS_NEW = 1 (line 30)
XML_PATH_EMAIL_COPY_METHOD = 'sales_email/shipment/copy_method' (line 36)
XML_PATH_EMAIL_COPY_TO = 'sales_email/shipment/copy_to' (line 35)
XML_PATH_EMAIL_ENABLED = 'sales_email/shipment/enabled' (line 37)
XML_PATH_EMAIL_GUEST_TEMPLATE = 'sales_email/shipment/guest_template' (line 33)
XML_PATH_EMAIL_IDENTITY = 'sales_email/shipment/identity' (line 34)
XML_PATH_EMAIL_TEMPLATE = 'sales_email/shipment/template' (line 32)
XML_PATH_UPDATE_EMAIL_COPY_METHOD = 'sales_email/shipment_comment/copy_method' (line 43)
XML_PATH_UPDATE_EMAIL_COPY_TO = 'sales_email/shipment_comment/copy_to' (line 42)
XML_PATH_UPDATE_EMAIL_ENABLED = 'sales_email/shipment_comment/enabled' (line 44)
XML_PATH_UPDATE_EMAIL_GUEST_TEMPLATE = 'sales_email/shipment_comment/guest_template' (line 40)
XML_PATH_UPDATE_EMAIL_IDENTITY = 'sales_email/shipment_comment/identity' (line 41)
XML_PATH_UPDATE_EMAIL_TEMPLATE = 'sales_email/shipment_comment/template' (line 39)

Documentation generated on Fri, 11 Feb 2011 17:12:41 +0200 by phpDocumentor 1.4.3