Class Mage_Sales_Model_Order_Shipment

Sales order shipment model

Varien_Object

Mage_Sales_Model_Order_Shipment

Package: Mage\Sales
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sales/Model/Order/Shipment.php

Methods summary
`protected`	# `_construct( )` Initialize shipment resource model Initialize shipment resource model
`protected Mage_Sales_Model_Order_Shipment`	# `_initOldFieldsMap( )` Init mapping array of short fields to its full names Init mapping array of short fields to its full names Returns `Mage_Sales_Model_Order_Shipment`
`public Mage_Sales_Model_Order_Shipment`	# `loadByIncrementId( string $incrementId )` Load shipment by increment id Load shipment by increment id Parameters `$incrementId` `string` $incrementId Returns `Mage_Sales_Model_Order_Shipment`
`public Mage_Sales_Model_Order_Shipment`	# `setOrder( Mage_Sales_Model_Order $order )` Declare order for shipment Declare order for shipment Parameters `$order` `Mage_Sales_Model_Order` $order Returns `Mage_Sales_Model_Order_Shipment`
`public string`	# `getProtectCode( )` Retrieve hash code of current order Retrieve hash code of current order Returns `string`
`public Mage_Sales_Model_Order`	# `getOrder( )` Retrieve the order the shipment for created for Retrieve the order the shipment for created for Returns `Mage_Sales_Model_Order`
`public Mage_Sales_Model_Order_Address`	# `getBillingAddress( )` Retrieve billing address Retrieve billing address Returns `Mage_Sales_Model_Order_Address`
`public Mage_Sales_Model_Order_Address`	# `getShippingAddress( )` Retrieve shipping address Retrieve shipping address Returns `Mage_Sales_Model_Order_Address`
`public unknown`	# `register( )` Register shipment Register shipment Apply to order, order items etc. Returns `unknown`
`public`	# `getItemsCollection( )`
`public`	# `getAllItems( )`
`public`	# `getItemById( mixed $itemId )`
`public`	# `addItem( Mage_Sales_Model_Order_Shipment_Item $item )`
`public`	# `getTracksCollection( )`
`public`	# `getAllTracks( )`
`public`	# `getTrackById( mixed $trackId )`
`public`	# `addTrack( Mage_Sales_Model_Order_Shipment_Track $track )`
`public Mage_Sales_Model_Order_Shipment`	# `addComment( boolean $comment, boolean $notify = false, mixed $visibleOnFront = false )` Adds comment to shipment with additional possibility to send it to customer via email and show it in customer account Adds comment to shipment with additional possibility to send it to customer via email and show it in customer account Parameters `$comment` `boolean` $notify `$notify` `boolean` $visibleOnFront `$visibleOnFront` Returns `Mage_Sales_Model_Order_Shipment`
`public`	# `getCommentsCollection( mixed $reload = false )`
`public Mage_Sales_Model_Order_Shipment`	# `sendEmail( boolean $notifyCustomer = true, string $comment = '' )` Send email with shipment data Send email with shipment data Parameters `$notifyCustomer` `boolean` $notifyCustomer `$comment` `string` $comment Returns `Mage_Sales_Model_Order_Shipment`
`public Mage_Sales_Model_Order_Shipment`	# `sendUpdateEmail( boolean $notifyCustomer = true, string $comment = '' )` Send email with shipment update information Send email with shipment update information Parameters `$notifyCustomer` `boolean` $notifyCustomer `$comment` `string` $comment Returns `Mage_Sales_Model_Order_Shipment`
`protected`	# `_getEmails( mixed $configPath )`
`protected Mage_Sales_Model_Order_Shipment`	# `_beforeSave( )` Before object save Before object save Returns `Mage_Sales_Model_Order_Shipment` Overrides `Mage_Core_Model_Abstract::_beforeSave()`
`protected Mage_Core_Model_Abstract`	# `_beforeDelete( )` Processing object before delete data Processing object before delete data Returns `Mage_Core_Model_Abstract` Overrides `Mage_Core_Model_Abstract::_beforeDelete()`
`protected Mage_Sales_Model_Order_Shipment`	# `_afterSave( )` After object save manipulations After object save manipulations Returns `Mage_Sales_Model_Order_Shipment` Overrides `Mage_Sales_Model_Abstract::_afterSave()`
`public Mage_Core_Model_Store`	# `getStore( )` Retrieve store model instance Retrieve store model instance Returns `Mage_Core_Model_Store`
`public Mage_Sales_Model_Order_Shipment`	# `setShippingLabel( string $label )` Set shipping label Set shipping label Parameters `$label` `string` $label label representation (image or pdf file) Returns `Mage_Sales_Model_Order_Shipment`
`public`	# `getShippingLabel( )` Get shipping label and decode by db adapter Get shipping label and decode by db adapter

Methods inherited from Mage_Sales_Model_Abstract
`getCreatedAtDate(), getCreatedAtStoreDate()`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceCollection(), getResourceName(), isObjectNew(), load(), save(), setId()`

Constants summary
`integer`	`STATUS_NEW`	`1`	#
`string`	`XML_PATH_EMAIL_TEMPLATE`	`'sales_email/shipment/template'`	#
`string`	`XML_PATH_EMAIL_GUEST_TEMPLATE`	`'sales_email/shipment/guest_template'`	#
`string`	`XML_PATH_EMAIL_IDENTITY`	`'sales_email/shipment/identity'`	#
`string`	`XML_PATH_EMAIL_COPY_TO`	`'sales_email/shipment/copy_to'`	#
`string`	`XML_PATH_EMAIL_COPY_METHOD`	`'sales_email/shipment/copy_method'`	#
`string`	`XML_PATH_EMAIL_ENABLED`	`'sales_email/shipment/enabled'`	#
`string`	`XML_PATH_UPDATE_EMAIL_TEMPLATE`	`'sales_email/shipment_comment/template'`	#
`string`	`XML_PATH_UPDATE_EMAIL_GUEST_TEMPLATE`	`'sales_email/shipment_comment/guest_template'`	#
`string`	`XML_PATH_UPDATE_EMAIL_IDENTITY`	`'sales_email/shipment_comment/identity'`	#
`string`	`XML_PATH_UPDATE_EMAIL_COPY_TO`	`'sales_email/shipment_comment/copy_to'`	#
`string`	`XML_PATH_UPDATE_EMAIL_COPY_METHOD`	`'sales_email/shipment_comment/copy_method'`	#
`string`	`XML_PATH_UPDATE_EMAIL_ENABLED`	`'sales_email/shipment_comment/enabled'`	#
`string`	`REPORT_DATE_TYPE_ORDER_CREATED`	`'order_created'`	#
`string`	`REPORT_DATE_TYPE_SHIPMENT_CREATED`	`'shipment_created'`	#
`string`	`HISTORY_ENTITY_NAME`	`'shipment'`	#

Properties summary
`protected mixed`	`$_items`		#
`protected mixed`	`$_tracks`		#
`protected mixed`	`$_order`		#
`protected mixed`	`$_comments`		#
`protected string`	`$_eventPrefix`	`'sales_order_shipment'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'shipment'`	# Parameter name in event Parameter name in event In observe method you can use $observer->getEvent()->getObject() in this case

Properties inherited from Mage_Core_Model_Abstract
`$_cacheTag, $_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Order_Shipment

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides

Returns

Overrides

Returns

Overrides

Returns

Parameters

Returns