1: <?php
2: /**
3: * Magento
4: *
5: * NOTICE OF LICENSE
6: *
7: * This source file is subject to the Open Software License (OSL 3.0)
8: * that is bundled with this package in the file LICENSE.txt.
9: * It is also available through the world-wide-web at this URL:
10: * http://opensource.org/licenses/osl-3.0.php
11: * If you did not receive a copy of the license and are unable to
12: * obtain it through the world-wide-web, please send an email
13: * to license@magentocommerce.com so we can send you a copy immediately.
14: *
15: * DISCLAIMER
16: *
17: * Do not edit or add to this file if you wish to upgrade Magento to newer
18: * versions in the future. If you wish to customize Magento for your
19: * needs please refer to http://www.magentocommerce.com for more information.
20: *
21: * @category Mage
22: * @package Mage_Sales
23: * @copyright Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
24: * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
25: */
26:
27: /**
28: * Abstract API2 class for sales order comments
29: *
30: * @category Mage
31: * @package Mage_Sales
32: * @author Magento Core Team <core@magentocommerce.com>
33: */
34: abstract class Mage_Sales_Model_Api2_Order_Comment_Rest extends Mage_Sales_Model_Api2_Order_Comment
35: {
36: /**#@+
37: * Parameters in request used in model (usually specified in route mask)
38: */
39: const PARAM_ORDER_ID = 'id';
40: /**#@-*/
41:
42: /**
43: * Get sales order comments
44: *
45: * @return array
46: */
47: protected function _retrieveCollection()
48: {
49: $collection = $this->_getCollectionForRetrieve();
50: $collection->addFieldToSelect($this->getForcedAttributes());
51:
52: $this->_applyCollectionModifiers($collection);
53:
54: $data = $collection->load()->toArray();
55: return isset($data['items']) ? $data['items'] : $data;
56: }
57:
58: /**
59: * Retrieve collection instances
60: *
61: * @return Mage_Sales_Model_Resource_Order_Status_History_Collection
62: */
63: protected function _getCollectionForRetrieve()
64: {
65: /* @var $collection Mage_Sales_Model_Resource_Order_Status_History_Collection */
66: $collection = Mage::getResourceModel('sales/order_status_history_collection');
67: $collection->setOrderFilter($this->_loadOrderById($this->getRequest()->getParam(self::PARAM_ORDER_ID)));
68:
69: return $collection;
70: }
71:
72: /**
73: * Load order by id
74: *
75: * @param int $id
76: * @throws Mage_Api2_Exception
77: * @return Mage_Sales_Model_Order
78: */
79: protected function _loadOrderById($id)
80: {
81: /* @var $order Mage_Sales_Model_Order */
82: $order = Mage::getModel('sales/order')->load($id);
83: if (!$order->getId()) {
84: $this->_critical(self::RESOURCE_NOT_FOUND);
85: }
86:
87: return $order;
88: }
89: }
90: