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: /**
29: * Flat sales order abstract comments collection, used as parent for: invoice, shipment, creditmemo
30: *
31: * @category Mage
32: * @package Mage_Sales
33: * @author Magento Core Team <core@magentocommerce.com>
34: */
35: abstract class Mage_Sales_Model_Resource_Order_Comment_Collection_Abstract
36: extends Mage_Sales_Model_Resource_Collection_Abstract
37: {
38: /**
39: * Set filter on comments by their parent item
40: *
41: * @param Mage_Core_Model_Abstract|int $parent
42: * @return Mage_Sales_Model_Resource_Order_Comment_Collection_Abstract
43: */
44: public function setParentFilter($parent)
45: {
46: if ($parent instanceof Mage_Core_Model_Abstract) {
47: $parent = $parent->getId();
48: }
49: return $this->addFieldToFilter('parent_id', $parent);
50: }
51:
52: /**
53: * Adds filter to get only 'visible on front' comments
54: *
55: * @param int $flag
56: * @return Mage_Sales_Model_Resource_Order_Comment_Collection_Abstract
57: */
58: public function addVisibleOnFrontFilter($flag = 1)
59: {
60: return $this->addFieldToFilter('is_visible_on_front', $flag);
61: }
62:
63: /**
64: * Set created_at sort order
65: *
66: * @param string $direction
67: * @return Mage_Sales_Model_Resource_Order_Comment_Collection_Abstract
68: */
69: public function setCreatedAtOrder($direction = 'desc')
70: {
71: return $this->setOrder('created_at', $direction);
72: }
73: }
74: