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 order address
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_Address_Rest extends Mage_Sales_Model_Api2_Order_Address
35: {
36: /**#@+
37: * Parameters in request used in model (usually specified in route mask)
38: */
39: const PARAM_ORDER_ID = 'order_id';
40: const PARAM_ADDRESS_TYPE = 'address_type';
41: /**#@-*/
42:
43: /**
44: * Retrieve order address
45: *
46: * @return array
47: */
48: protected function _retrieve()
49: {
50: /** @var $address Mage_Sales_Model_Order_Address */
51: $address = $this->_getCollectionForRetrieve()
52: ->addAttributeToFilter('address_type', $this->getRequest()->getParam(self::PARAM_ADDRESS_TYPE))
53: ->getFirstItem();
54: if (!$address->getId()) {
55: $this->_critical(self::RESOURCE_NOT_FOUND);
56: }
57: return $address->getData();
58: }
59:
60: /**
61: * Retrieve order addresses
62: *
63: * @return array
64: */
65: protected function _retrieveCollection()
66: {
67: $collection = $this->_getCollectionForRetrieve();
68:
69: $this->_applyCollectionModifiers($collection);
70: $data = $collection->load()->toArray();
71:
72: if (0 == count($data['items'])) {
73: $this->_critical(self::RESOURCE_NOT_FOUND);
74: }
75:
76: return $data['items'];
77: }
78:
79: /**
80: * Retrieve collection instances
81: *
82: * @return Mage_Sales_Model_Resource_Order_Address_Collection
83: */
84: protected function _getCollectionForRetrieve()
85: {
86: /* @var $collection Mage_Sales_Model_Resource_Order_Address_Collection */
87: $collection = Mage::getResourceModel('sales/order_address_collection');
88: $collection->addAttributeToFilter('parent_id', $this->getRequest()->getParam(self::PARAM_ORDER_ID));
89:
90: return $collection;
91: }
92: }
93: