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:  * Invoice API
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Sales
 32:  * @author     Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Sales_Model_Order_Invoice_Api extends Mage_Sales_Model_Api_Resource
 35: {
 36:     /**
 37:      * Initialize attributes map
 38:      */
 39:     public function __construct()
 40:     {
 41:         $this->_attributesMap = array(
 42:             'invoice' => array('invoice_id' => 'entity_id'),
 43:             'invoice_item' => array('item_id' => 'entity_id'),
 44:             'invoice_comment' => array('comment_id' => 'entity_id'));
 45:     }
 46: 
 47:     /**
 48:      * Retrive invoices list. Filtration could be applied
 49:      *
 50:      * @param null|object|array $filters
 51:      * @return array
 52:      */
 53:     public function items($filters = null)
 54:     {
 55:         $invoices = array();
 56:         /** @var $invoiceCollection Mage_Sales_Model_Mysql4_Order_Invoice_Collection */
 57:         $invoiceCollection = Mage::getResourceModel('sales/order_invoice_collection');
 58:         $invoiceCollection->addAttributeToSelect('entity_id')
 59:             ->addAttributeToSelect('order_id')
 60:             ->addAttributeToSelect('increment_id')
 61:             ->addAttributeToSelect('created_at')
 62:             ->addAttributeToSelect('state')
 63:             ->addAttributeToSelect('grand_total')
 64:             ->addAttributeToSelect('order_currency_code');
 65: 
 66:         /** @var $apiHelper Mage_Api_Helper_Data */
 67:         $apiHelper = Mage::helper('api');
 68:         try {
 69:             $filters = $apiHelper->parseFilters($filters, $this->_attributesMap['invoice']);
 70:             foreach ($filters as $field => $value) {
 71:                 $invoiceCollection->addFieldToFilter($field, $value);
 72:             }
 73:         } catch (Mage_Core_Exception $e) {
 74:             $this->_fault('filters_invalid', $e->getMessage());
 75:         }
 76:         foreach ($invoiceCollection as $invoice) {
 77:             $invoices[] = $this->_getAttributes($invoice, 'invoice');
 78:         }
 79:         return $invoices;
 80:     }
 81: 
 82:     /**
 83:      * Retrieve invoice information
 84:      *
 85:      * @param string $invoiceIncrementId
 86:      * @return array
 87:      */
 88:     public function info($invoiceIncrementId)
 89:     {
 90:         $invoice = Mage::getModel('sales/order_invoice')->loadByIncrementId($invoiceIncrementId);
 91: 
 92:         /* @var Mage_Sales_Model_Order_Invoice $invoice */
 93: 
 94:         if (!$invoice->getId()) {
 95:             $this->_fault('not_exists');
 96:         }
 97: 
 98:         $result = $this->_getAttributes($invoice, 'invoice');
 99:         $result['order_increment_id'] = $invoice->getOrderIncrementId();
100: 
101:         $result['items'] = array();
102:         foreach ($invoice->getAllItems() as $item) {
103:             $result['items'][] = $this->_getAttributes($item, 'invoice_item');
104:         }
105: 
106:         $result['comments'] = array();
107:         foreach ($invoice->getCommentsCollection() as $comment) {
108:             $result['comments'][] = $this->_getAttributes($comment, 'invoice_comment');
109:         }
110: 
111:         return $result;
112:     }
113: 
114:     /**
115:      * Create new invoice for order
116:      *
117:      * @param string $orderIncrementId
118:      * @param array $itemsQty
119:      * @param string $comment
120:      * @param booleam $email
121:      * @param boolean $includeComment
122:      * @return string
123:      */
124:     public function create($orderIncrementId, $itemsQty, $comment = null, $email = false, $includeComment = false)
125:     {
126:         $order = Mage::getModel('sales/order')->loadByIncrementId($orderIncrementId);
127: 
128:         /* @var $order Mage_Sales_Model_Order */
129:         /**
130:           * Check order existing
131:           */
132:         if (!$order->getId()) {
133:              $this->_fault('order_not_exists');
134:         }
135: 
136:         /**
137:          * Check invoice create availability
138:          */
139:         if (!$order->canInvoice()) {
140:              $this->_fault('data_invalid', Mage::helper('sales')->__('Cannot do invoice for order.'));
141:         }
142: 
143:         $invoice = $order->prepareInvoice($itemsQty);
144: 
145:         $invoice->register();
146: 
147:         if ($comment !== null) {
148:             $invoice->addComment($comment, $email);
149:         }
150: 
151:         if ($email) {
152:             $invoice->setEmailSent(true);
153:         }
154: 
155:         $invoice->getOrder()->setIsInProcess(true);
156: 
157:         try {
158:             $transactionSave = Mage::getModel('core/resource_transaction')
159:                 ->addObject($invoice)
160:                 ->addObject($invoice->getOrder())
161:                 ->save();
162: 
163:             $invoice->sendEmail($email, ($includeComment ? $comment : ''));
164:         } catch (Mage_Core_Exception $e) {
165:             $this->_fault('data_invalid', $e->getMessage());
166:         }
167: 
168:         return $invoice->getIncrementId();
169:     }
170: 
171:     /**
172:      * Add comment to invoice
173:      *
174:      * @param string $invoiceIncrementId
175:      * @param string $comment
176:      * @param boolean $email
177:      * @param boolean $includeComment
178:      * @return boolean
179:      */
180:     public function addComment($invoiceIncrementId, $comment, $email = false, $includeComment = false)
181:     {
182:         $invoice = Mage::getModel('sales/order_invoice')->loadByIncrementId($invoiceIncrementId);
183: 
184:         /* @var $invoice Mage_Sales_Model_Order_Invoice */
185: 
186:         if (!$invoice->getId()) {
187:             $this->_fault('not_exists');
188:         }
189: 
190: 
191:         try {
192:             $invoice->addComment($comment, $email);
193:             $invoice->sendUpdateEmail($email, ($includeComment ? $comment : ''));
194:             $invoice->save();
195:         } catch (Mage_Core_Exception $e) {
196:             $this->_fault('data_invalid', $e->getMessage());
197:         }
198: 
199:         return true;
200:     }
201: 
202:     /**
203:      * Capture invoice
204:      *
205:      * @param string $invoiceIncrementId
206:      * @return boolean
207:      */
208:     public function capture($invoiceIncrementId)
209:     {
210:         $invoice = Mage::getModel('sales/order_invoice')->loadByIncrementId($invoiceIncrementId);
211: 
212:         /* @var $invoice Mage_Sales_Model_Order_Invoice */
213: 
214:         if (!$invoice->getId()) {
215:             $this->_fault('not_exists');
216:         }
217: 
218:         if (!$invoice->canCapture()) {
219:             $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice cannot be captured.'));
220:         }
221: 
222:         try {
223:             $invoice->capture();
224:             $invoice->getOrder()->setIsInProcess(true);
225:             $transactionSave = Mage::getModel('core/resource_transaction')
226:                 ->addObject($invoice)
227:                 ->addObject($invoice->getOrder())
228:                 ->save();
229:         } catch (Mage_Core_Exception $e) {
230:             $this->_fault('status_not_changed', $e->getMessage());
231:         } catch (Exception $e) {
232:             $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice capturing problem.'));
233:         }
234: 
235:         return true;
236:     }
237: 
238:     /**
239:      * Void invoice
240:      *
241:      * @param unknown_type $invoiceIncrementId
242:      * @return unknown
243:      */
244:     public function void($invoiceIncrementId)
245:     {
246:         $invoice = Mage::getModel('sales/order_invoice')->loadByIncrementId($invoiceIncrementId);
247: 
248:         /* @var $invoice Mage_Sales_Model_Order_Invoice */
249: 
250:         if (!$invoice->getId()) {
251:             $this->_fault('not_exists');
252:         }
253: 
254:         if (!$invoice->canVoid()) {
255:             $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice cannot be voided.'));
256:         }
257: 
258:         try {
259:             $invoice->void();
260:             $invoice->getOrder()->setIsInProcess(true);
261:             $transactionSave = Mage::getModel('core/resource_transaction')
262:                 ->addObject($invoice)
263:                 ->addObject($invoice->getOrder())
264:                 ->save();
265:         } catch (Mage_Core_Exception $e) {
266:             $this->_fault('status_not_changed', $e->getMessage());
267:         } catch (Exception $e) {
268:             $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice void problem'));
269:         }
270: 
271:         return true;
272:     }
273: 
274:     /**
275:      * Cancel invoice
276:      *
277:      * @param string $invoiceIncrementId
278:      * @return boolean
279:      */
280:     public function cancel($invoiceIncrementId)
281:     {
282:         $invoice = Mage::getModel('sales/order_invoice')->loadByIncrementId($invoiceIncrementId);
283: 
284:         /* @var $invoice Mage_Sales_Model_Order_Invoice */
285: 
286:         if (!$invoice->getId()) {
287:             $this->_fault('not_exists');
288:         }
289: 
290:         if (!$invoice->canCancel()) {
291:             $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice cannot be canceled.'));
292:         }
293: 
294:         try {
295:             $invoice->cancel();
296:             $invoice->getOrder()->setIsInProcess(true);
297:             $transactionSave = Mage::getModel('core/resource_transaction')
298:                 ->addObject($invoice)
299:                 ->addObject($invoice->getOrder())
300:                 ->save();
301:         } catch (Mage_Core_Exception $e) {
302:             $this->_fault('status_not_changed', $e->getMessage());
303:         } catch (Exception $e) {
304:             $this->_fault('status_not_changed', Mage::helper('sales')->__('Invoice canceling problem.'));
305:         }
306: 
307:         return true;
308:     }
309: }
310: