Mage_Sales_Model_Order_Shipment Class Reference

Inheritance diagram for Mage_Sales_Model_Order_Shipment:

List of all members.

Public Member Functions
	loadByIncrementId ($incrementId)
	setOrder (Mage_Sales_Model_Order $order)
	getOrder ()
	getBillingAddress ()
	getShippingAddress ()
	register ()
	getItemsCollection ()
	getAllItems ()
	getItemById ($itemId)
	addItem (Mage_Sales_Model_Order_Shipment_Item $item)
	getTracksCollection ()
	getAllTracks ()
	getTrackById ($trackId)
	addTrack (Mage_Sales_Model_Order_Shipment_Track $track)
	addComment ($comment, $notify=false)
	getCommentsCollection ($reload=false)
	sendEmail ($notifyCustomer=true, $comment='')
	sendUpdateEmail ($notifyCustomer=true, $comment='')
	getStore ()
Public Attributes
const	STATUS_NEW = 1
const	XML_PATH_EMAIL_TEMPLATE = 'sales_email/shipment/template'
const	XML_PATH_EMAIL_GUEST_TEMPLATE = 'sales_email/shipment/guest_template'
const	XML_PATH_EMAIL_IDENTITY = 'sales_email/shipment/identity'
const	XML_PATH_EMAIL_COPY_TO = 'sales_email/shipment/copy_to'
const	XML_PATH_EMAIL_COPY_METHOD = 'sales_email/shipment/copy_method'
const	XML_PATH_EMAIL_ENABLED = 'sales_email/shipment/enabled'
const	XML_PATH_UPDATE_EMAIL_TEMPLATE = 'sales_email/shipment_comment/template'
const	XML_PATH_UPDATE_EMAIL_GUEST_TEMPLATE = 'sales_email/shipment_comment/guest_template'
const	XML_PATH_UPDATE_EMAIL_IDENTITY = 'sales_email/shipment_comment/identity'
const	XML_PATH_UPDATE_EMAIL_COPY_TO = 'sales_email/shipment_comment/copy_to'
const	XML_PATH_UPDATE_EMAIL_COPY_METHOD = 'sales_email/shipment_comment/copy_method'
const	XML_PATH_UPDATE_EMAIL_ENABLED = 'sales_email/shipment_comment/enabled'
Protected Member Functions
	_construct ()
	_getEmails ($configPath)
	_beforeSave ()
	_beforeDelete ()
Protected Attributes
	$_items
	$_tracks
	$_order
	$_eventPrefix = 'sales_order_shipment'
	$_eventObject = 'shipment'

---

Detailed Description

Definition at line 28 of file Shipment.php.

---

Member Function Documentation

_beforeDelete

(

)

[protected]

Processing object before delete data

Returns:

Mage_Core_Model_Abstract

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 476 of file Shipment.php.

    {
        $this->_protectFromNonAdmin();
        return parent::_beforeDelete();
    }

_beforeSave

(

)

[protected]

Processing object before save data

Returns:

Mage_Core_Model_Abstract

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 467 of file Shipment.php.

    {
        if (!count($this->getAllItems())) {
            Mage::throwException(
                Mage::helper('sales')->__('Cannot create an empty shipment.')
            );
        }
    }

_construct

(

)

[protected]

Initialize shipment resource model

Reimplemented from Varien_Object.

Definition at line 56 of file Shipment.php.

    {
        $this->_init('sales/order_shipment');
    }

_getEmails

(

$

configPath

)

[protected]

Definition at line 458 of file Shipment.php.

    {
        $data = Mage::getStoreConfig($configPath, $this->getStoreId());
        if (!empty($data)) {
            return explode(',', $data);
        }
        return false;
    }

addComment	(	$	comment,
		$	notify = false
	)

Definition at line 258 of file Shipment.php.

    {
        if (!($comment instanceof Mage_Sales_Model_Order_Shipment_Comment)) {
            $comment = Mage::getModel('sales/order_shipment_comment')
                ->setComment($comment)
                ->setIsCustomerNotified($notify);
        }
        $comment->setShipment($this)
            ->setParentId($this->getId())
            ->setStoreId($this->getStoreId());
        if (!$comment->getId()) {
            $this->getCommentsCollection()->addItem($comment);
        }
        return $this;
    }

addItem

(

Mage_Sales_Model_Order_Shipment_Item $

item

)

Definition at line 197 of file Shipment.php.

    {
        $item->setShipment($this)
            ->setParentId($this->getId())
            ->setStoreId($this->getStoreId());
        if (!$item->getId()) {
            $this->getItemsCollection()->addItem($item);
        }
        return $this;
    }

addTrack

(

Mage_Sales_Model_Order_Shipment_Track $

track

)

Definition at line 246 of file Shipment.php.

    {
        $track->setShipment($this)
            ->setParentId($this->getId())
            ->setOrderId($this->getOrderId())
            ->setStoreId($this->getStoreId());
        if (!$track->getId()) {
            $this->getTracksCollection()->addItem($track);
        }
        return $this;
    }

getAllItems

(

)

Definition at line 176 of file Shipment.php.

    {
        $items = array();
        foreach ($this->getItemsCollection() as $item) {
            if (!$item->isDeleted()) {
                $items[] =  $item;
            }
        }
        return $items;
    }

getAllTracks

(

)

Definition at line 225 of file Shipment.php.

    {
        $tracks = array();
        foreach ($this->getTracksCollection() as $track) {
            if (!$track->isDeleted()) {
                $tracks[] =  $track;
            }
        }
        return $tracks;
    }

getBillingAddress

(

)

Retrieve billing address

Returns:

Mage_Sales_Model_Order_Address

Definition at line 113 of file Shipment.php.

    {
        return $this->getOrder()->getBillingAddress();
    }

getCommentsCollection

(

$

reload = false

)

Definition at line 274 of file Shipment.php.

    {
        if (is_null($this->_comments) || $reload) {
            $this->_comments = Mage::getResourceModel('sales/order_shipment_comment_collection')
                ->addAttributeToSelect('*')
                ->setShipmentFilter($this->getId())
                ->setCreatedAtOrder();
            if ($this->getId()) {
                foreach ($this->_comments as $comment) {
                    $comment->setShipment($this);
                }
            }
        }
        return $this->_comments;
    }

getItemById

(

$

itemId

)

Definition at line 187 of file Shipment.php.

    {
        foreach ($this->getItemsCollection() as $item) {
            if ($item->getId()==$itemId) {
                return $item;
            }
        }
        return false;
    }

getItemsCollection

(

)

Definition at line 160 of file Shipment.php.

    {
        if (empty($this->_items)) {
            $this->_items = Mage::getResourceModel('sales/order_shipment_item_collection')
                ->addAttributeToSelect('*')
                ->setShipmentFilter($this->getId());

            if ($this->getId()) {
                foreach ($this->_items as $item) {
                    $item->setShipment($this);
                }
            }
        }
        return $this->_items;
    }

getOrder

(

)

Retrieve the order the shipment for created for

Returns:

Mage_Sales_Model_Order

Definition at line 100 of file Shipment.php.

    {
        if (!$this->_order instanceof Mage_Sales_Model_Order) {
            $this->_order = Mage::getModel('sales/order')->load($this->getOrderId());
        }
        return $this->_order;
    }

getShippingAddress

(

)

Retrieve shipping address

Returns:

Mage_Sales_Model_Order_Address

Definition at line 123 of file Shipment.php.

    {
        return $this->getOrder()->getShippingAddress();
    }

getStore

(

)

Retrieve store model instance

Returns:

Mage_Core_Model_Store

Reimplemented from Mage_Sales_Model_Abstract.

Definition at line 487 of file Shipment.php.

    {
        return $this->getOrder()->getStore();
    }

getTrackById

(

$

trackId

)

Definition at line 236 of file Shipment.php.

    {
        foreach ($this->getTracksCollection() as $track) {
            if ($track->getId()==$trackId) {
                return $track;
            }
        }
        return false;
    }

getTracksCollection

(

)

Definition at line 209 of file Shipment.php.

    {
        if (empty($this->_tracks)) {
            $this->_tracks = Mage::getResourceModel('sales/order_shipment_track_collection')
                ->addAttributeToSelect('*')
                ->setShipmentFilter($this->getId());

            if ($this->getId()) {
                foreach ($this->_tracks as $track) {
                    $track->setShipment($this);
                }
            }
        }
        return $this->_tracks;
    }

loadByIncrementId

(

$

incrementId

)

Load shipment by increment id

Parameters:

string

$incrementId

Returns:

Mage_Sales_Model_Order_Shipment

Definition at line 67 of file Shipment.php.

    {
        $ids = $this->getCollection()
            ->addAttributeToFilter('increment_id', $incrementId)
            ->getAllIds();

        if (!empty($ids)) {
            reset($ids);
            $this->load(current($ids));
        }
        return $this;
    }

register

(

)

Register shipment

Apply to order, order items etc.

Returns:

unknown

Definition at line 135 of file Shipment.php.

    {
        if ($this->getId()) {
            Mage::throwException(
                Mage::helper('sales')->__('Can not register existing shipment')
            );
        }

        $totalQty = 0;
        foreach ($this->getAllItems() as $item) {
            if ($item->getQty()>0) {
                $item->register();
                if (!$item->getOrderItem()->isDummy(true)) {
                    $totalQty+= $item->getQty();
                }
            }
            else {
                $item->isDeleted(true);
            }
        }
        $this->setTotalQty($totalQty);

        return $this;
    }

sendEmail	(	$	notifyCustomer = true,
		$	comment = ''
	)

Sending email with Invoice data

Returns:

Mage_Sales_Model_Order_Invoice

Definition at line 295 of file Shipment.php.

    {
        if (!Mage::helper('sales')->canSendNewShipmentEmail($this->getOrder()->getStore()->getId())) {
            return $this;
        }

        $currentDesign = Mage::getDesign()->setAllGetOld(array(
            'package' => Mage::getStoreConfig('design/package/name', $this->getStoreId()),
            'store' => $this->getStoreId()
        ));

        $translate = Mage::getSingleton('core/translate');
        /* @var $translate Mage_Core_Model_Translate */
        $translate->setTranslateInline(false);

        $order  = $this->getOrder();
        $copyTo = $this->_getEmails(self::XML_PATH_EMAIL_COPY_TO);
        $copyMethod = Mage::getStoreConfig(self::XML_PATH_EMAIL_COPY_METHOD, $this->getStoreId());

        if (!$notifyCustomer && !$copyTo) {
            return $this;
        }
        $paymentBlock   = Mage::helper('payment')->getInfoBlock($order->getPayment())
            ->setIsSecureMode(true);
        $mailTemplate = Mage::getModel('core/email_template');

        if ($order->getCustomerIsGuest()) {
            $template = Mage::getStoreConfig(self::XML_PATH_EMAIL_GUEST_TEMPLATE, $order->getStoreId());
            $customerName = $order->getBillingAddress()->getName();
        } else {
            $template = Mage::getStoreConfig(self::XML_PATH_EMAIL_TEMPLATE, $order->getStoreId());
            $customerName = $order->getCustomerName();
        }

        if ($notifyCustomer) {
            $sendTo[] = array(
                'name'  => $customerName,
                'email' => $order->getCustomerEmail()
            );
            if ($copyTo && $copyMethod == 'bcc') {
                foreach ($copyTo as $email) {
                    $mailTemplate->addBcc($email);
                }
            }

        }

        if ($copyTo && ($copyMethod == 'copy' || !$notifyCustomer)) {
            foreach ($copyTo as $email) {
                $sendTo[] = array(
                    'name'  => null,
                    'email' => $email
                );
            }
        }

        foreach ($sendTo as $recipient) {
            $mailTemplate->setDesignConfig(array('area'=>'frontend', 'store'=>$order->getStoreId()))
                ->sendTransactional(
                    $template,
                    Mage::getStoreConfig(self::XML_PATH_EMAIL_IDENTITY, $order->getStoreId()),
                    $recipient['email'],
                    $recipient['name'],
                    array(
                        'order'       => $order,
                        'shipment'    => $this,
                        'comment'     => $comment,
                        'billing'     => $order->getBillingAddress(),
                        'payment_html'=> $paymentBlock->toHtml(),
                    )
                );
        }

        $translate->setTranslateInline(true);

        Mage::getDesign()->setAllGetOld($currentDesign);

        return $this;
    }

sendUpdateEmail	(	$	notifyCustomer = true,
		$	comment = ''
	)

Sending email with Shipment update information

Returns:

Mage_Sales_Model_Order_Shipment

Definition at line 380 of file Shipment.php.

    {
        if (!Mage::helper('sales')->canSendShipmentCommentEmail($this->getOrder()->getStore()->getId())) {
            return $this;
        }

        $currentDesign = Mage::getDesign()->setAllGetOld(array(
            'package' => Mage::getStoreConfig('design/package/name', $this->getStoreId()),
        ));

        $translate = Mage::getSingleton('core/translate');
        /* @var $translate Mage_Core_Model_Translate */
        $translate->setTranslateInline(false);

        $order  = $this->getOrder();

        $copyTo = $this->_getEmails(self::XML_PATH_UPDATE_EMAIL_COPY_TO);
        $copyMethod = Mage::getStoreConfig(self::XML_PATH_UPDATE_EMAIL_COPY_METHOD, $this->getStoreId());

        if (!$notifyCustomer && !$copyTo) {
            return $this;
        }

        $mailTemplate = Mage::getModel('core/email_template');

        if ($order->getCustomerIsGuest()) {
            $template = Mage::getStoreConfig(self::XML_PATH_UPDATE_EMAIL_GUEST_TEMPLATE, $order->getStoreId());
            $customerName = $order->getBillingAddress()->getName();
        } else {
            $template = Mage::getStoreConfig(self::XML_PATH_UPDATE_EMAIL_TEMPLATE, $order->getStoreId());
            $customerName = $order->getCustomerName();
        }

        if ($notifyCustomer) {
            $sendTo[] = array(
                'name'  => $customerName,
                'email' => $order->getCustomerEmail()
            );
            if ($copyTo && $copyMethod == 'bcc') {
                foreach ($copyTo as $email) {
                    $mailTemplate->addBcc($email);
                }
            }

        }

        if ($copyTo && ($copyMethod == 'copy' || !$notifyCustomer)) {
            foreach ($copyTo as $email) {
                $sendTo[] = array(
                    'name'  => null,
                    'email' => $email
                );
            }
        }

        foreach ($sendTo as $recipient) {
            $mailTemplate->setDesignConfig(array('area'=>'frontend', 'store'=>$order->getStoreId()))
                ->sendTransactional(
                    $template,
                    Mage::getStoreConfig(self::XML_PATH_UPDATE_EMAIL_IDENTITY, $order->getStoreId()),
                    $recipient['email'],
                    $recipient['name'],
                    array(
                        'order'   => $order,
                        'billing' => $order->getBillingAddress(),
                        'shipment'=> $this,
                        'comment' => $comment
                    )
                );
        }

        $translate->setTranslateInline(true);

        Mage::getDesign()->setAllGetOld($currentDesign);

        return $this;
    }

setOrder

(

Mage_Sales_Model_Order $

order

)

Declare order for shipment

Parameters:

Mage_Sales_Model_Order

$order

Returns:

Mage_Sales_Model_Order_Shipment

Definition at line 87 of file Shipment.php.

    {
        $this->_order = $order;
        $this->setOrderId($order->getId())
            ->setStoreId($order->getStoreId());
        return $this;
    }

---

Member Data Documentation

$_eventObject = 'shipment' [protected]

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 51 of file Shipment.php.

$_eventPrefix = 'sales_order_shipment' [protected]

Reimplemented from Mage_Core_Model_Abstract.

Definition at line 50 of file Shipment.php.

$_items [protected]

Definition at line 46 of file Shipment.php.

$_order [protected]

Definition at line 48 of file Shipment.php.

$_tracks [protected]

Definition at line 47 of file Shipment.php.

const STATUS_NEW = 1

Definition at line 30 of file Shipment.php.

const XML_PATH_EMAIL_COPY_METHOD = 'sales_email/shipment/copy_method'

Definition at line 36 of file Shipment.php.

const XML_PATH_EMAIL_COPY_TO = 'sales_email/shipment/copy_to'

Definition at line 35 of file Shipment.php.

const XML_PATH_EMAIL_ENABLED = 'sales_email/shipment/enabled'

Definition at line 37 of file Shipment.php.

const XML_PATH_EMAIL_GUEST_TEMPLATE = 'sales_email/shipment/guest_template'

Definition at line 33 of file Shipment.php.

const XML_PATH_EMAIL_IDENTITY = 'sales_email/shipment/identity'

Definition at line 34 of file Shipment.php.

const XML_PATH_EMAIL_TEMPLATE = 'sales_email/shipment/template'

Definition at line 32 of file Shipment.php.

const XML_PATH_UPDATE_EMAIL_COPY_METHOD = 'sales_email/shipment_comment/copy_method'

Definition at line 43 of file Shipment.php.

const XML_PATH_UPDATE_EMAIL_COPY_TO = 'sales_email/shipment_comment/copy_to'

Definition at line 42 of file Shipment.php.

const XML_PATH_UPDATE_EMAIL_ENABLED = 'sales_email/shipment_comment/enabled'

Definition at line 44 of file Shipment.php.

const XML_PATH_UPDATE_EMAIL_GUEST_TEMPLATE = 'sales_email/shipment_comment/guest_template'

Definition at line 40 of file Shipment.php.

const XML_PATH_UPDATE_EMAIL_IDENTITY = 'sales_email/shipment_comment/identity'

Definition at line 41 of file Shipment.php.

const XML_PATH_UPDATE_EMAIL_TEMPLATE = 'sales_email/shipment_comment/template'

Definition at line 39 of file Shipment.php.

---

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

• app/code/core/Mage/Sales/Model/Order/Shipment.php