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_Adminhtml
 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:  * Grid widget massaction block
 29:  *
 30:  * @method Mage_Sales_Model_Quote setHideFormElement(boolean $value) Hide Form element to prevent IE errors
 31:  * @method boolean getHideFormElement()
 32:  * @category   Mage
 33:  * @package    Mage_Adminhtml
 34:  * @author      Magento Core Team <core@magentocommerce.com>
 35:  */
 36: abstract class Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract extends Mage_Adminhtml_Block_Widget
 37: {
 38:     /**
 39:      * Massaction items
 40:      *
 41:      * @var array
 42:      */
 43:     protected $_items = array();
 44: 
 45:     /**
 46:      * Sets Massaction template
 47:      */
 48:     public function __construct()
 49:     {
 50:         parent::__construct();
 51:         $this->setTemplate('widget/grid/massaction.phtml');
 52:         $this->setErrorText(Mage::helper('catalog')->jsQuoteEscape(Mage::helper('catalog')->__('Please select items.')));
 53:     }
 54: 
 55:     /**
 56:      * Add new massaction item
 57:      *
 58:      * $item = array(
 59:      *      'label'    => string,
 60:      *      'complete' => string, // Only for ajax enabled grid (optional)
 61:      *      'url'      => string,
 62:      *      'confirm'  => string, // text of confirmation of this action (optional)
 63:      *      'additional' => string|array|Mage_Core_Block_Abstract // (optional)
 64:      * );
 65:      *
 66:      * @param string $itemId
 67:      * @param array $item
 68:      * @return Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract
 69:      */
 70:     public function addItem($itemId, array $item)
 71:     {
 72:         $this->_items[$itemId] =  $this->getLayout()->createBlock('adminhtml/widget_grid_massaction_item')
 73:             ->setData($item)
 74:             ->setMassaction($this)
 75:             ->setId($itemId);
 76: 
 77:         if($this->_items[$itemId]->getAdditional()) {
 78:             $this->_items[$itemId]->setAdditionalActionBlock($this->_items[$itemId]->getAdditional());
 79:             $this->_items[$itemId]->unsAdditional();
 80:         }
 81: 
 82:         return $this;
 83:     }
 84: 
 85:     /**
 86:      * Retrieve massaction item with id $itemId
 87:      *
 88:      * @param string $itemId
 89:      * @return Mage_Adminhtml_Block_Widget_Grid_Massaction_Item
 90:      */
 91:     public function getItem($itemId)
 92:     {
 93:         if(isset($this->_items[$itemId])) {
 94:             return $this->_items[$itemId];
 95:         }
 96: 
 97:         return null;
 98:     }
 99: 
100:     /**
101:      * Retrieve massaction items
102:      *
103:      * @return array
104:      */
105:     public function getItems()
106:     {
107:         return $this->_items;
108:     }
109: 
110:     /**
111:      * Retrieve massaction items JSON
112:      *
113:      * @return string
114:      */
115:     public function getItemsJson()
116:     {
117:         $result = array();
118:         foreach ($this->getItems() as $itemId=>$item) {
119:             $result[$itemId] = $item->toArray();
120:         }
121: 
122:         return Mage::helper('core')->jsonEncode($result);
123:     }
124: 
125:     /**
126:      * Retrieve massaction items count
127:      *
128:      * @return integer
129:      */
130:     public function getCount()
131:     {
132:         return sizeof($this->_items);
133:     }
134: 
135:     /**
136:      * Checks are massactions available
137:      *
138:      * @return boolean
139:      */
140:     public function isAvailable()
141:     {
142:         return $this->getCount() > 0 && $this->getParentBlock()->getMassactionIdField();
143:     }
144: 
145:     /**
146:      * Retrieve global form field name for all massaction items
147:      *
148:      * @return string
149:      */
150:     public function getFormFieldName()
151:     {
152:         return ($this->getData('form_field_name') ? $this->getData('form_field_name') : 'massaction');
153:     }
154: 
155:     /**
156:      * Retrieve form field name for internal use. Based on $this->getFormFieldName()
157:      *
158:      * @return string
159:      */
160:     public function getFormFieldNameInternal()
161:     {
162:         return  'internal_' . $this->getFormFieldName();
163:     }
164: 
165:     /**
166:      * Retrieve massaction block js object name
167:      *
168:      * @return string
169:      */
170:     public function getJsObjectName()
171:     {
172:         return $this->getHtmlId() . 'JsObject';
173:     }
174: 
175:     /**
176:      * Retrieve grid block js object name
177:      *
178:      * @return string
179:      */
180:     public function getGridJsObjectName()
181:     {
182:         return $this->getParentBlock()->getJsObjectName();
183:     }
184: 
185:     /**
186:      * Retrieve JSON string of selected checkboxes
187:      *
188:      * @return string
189:      */
190:     public function getSelectedJson()
191:     {
192:         if($selected = $this->getRequest()->getParam($this->getFormFieldNameInternal())) {
193:             $selected = explode(',', $selected);
194:             return join(',', $selected);
195:         } else {
196:             return '';
197:         }
198:     }
199: 
200:     /**
201:      * Retrieve array of selected checkboxes
202:      *
203:      * @return array
204:      */
205:     public function getSelected()
206:     {
207:         if($selected = $this->getRequest()->getParam($this->getFormFieldNameInternal())) {
208:             $selected = explode(',', $selected);
209:             return $selected;
210:         } else {
211:             return array();
212:         }
213:     }
214: 
215:     /**
216:      * Retrieve apply button html
217:      *
218:      * @return string
219:      */
220:     public function getApplyButtonHtml()
221:     {
222:         return $this->getButtonHtml($this->__('Submit'), $this->getJsObjectName() . ".apply()");
223:     }
224: 
225:     public function getJavaScript()
226:     {
227:         return " var {$this->getJsObjectName()} = new varienGridMassaction('{$this->getHtmlId()}', "
228:                 . "{$this->getGridJsObjectName()}, '{$this->getSelectedJson()}'"
229:                 . ", '{$this->getFormFieldNameInternal()}', '{$this->getFormFieldName()}');"
230:                 . "{$this->getJsObjectName()}.setItems({$this->getItemsJson()}); "
231:                 . "{$this->getJsObjectName()}.setGridIds('{$this->getGridIdsJson()}');"
232:                 . ($this->getUseAjax() ? "{$this->getJsObjectName()}.setUseAjax(true);" : '')
233:                 . ($this->getUseSelectAll() ? "{$this->getJsObjectName()}.setUseSelectAll(true);" : '')
234:                 . "{$this->getJsObjectName()}.errorText = '{$this->getErrorText()}';";
235:     }
236: 
237:     public function getGridIdsJson()
238:     {
239:         if (!$this->getUseSelectAll()) {
240:             return '';
241:         }
242: 
243:         $gridIds = $this->getParentBlock()->getCollection()->getAllIds();
244: 
245:         if(!empty($gridIds)) {
246:             return join(",", $gridIds);
247:         }
248:         return '';
249:     }
250: 
251:     public function getHtmlId()
252:     {
253:         return $this->getParentBlock()->getHtmlId() . '_massaction';
254:     }
255: 
256:     /**
257:      * Remove existing massaction item by its id
258:      *
259:      * @param string $itemId
260:      * @return Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract
261:      */
262:     public function removeItem($itemId)
263:     {
264:         if (isset($this->_items[$itemId])) {
265:             unset($this->_items[$itemId]);
266:         }
267: 
268:         return $this;
269:     }
270: 
271:     /**
272:      * Retrieve select all functionality flag check
273:      *
274:      * @return boolean
275:      */
276:     public function getUseSelectAll()
277:     {
278:         return $this->_getData('use_select_all') === null || $this->_getData('use_select_all');
279:     }
280: 
281:     /**
282:      * Retrieve select all functionality flag check
283:      *
284:      * @param boolean $flag
285:      * @return Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract
286:      */
287:     public function setUseSelectAll($flag)
288:     {
289:         $this->setData('use_select_all', (bool) $flag);
290:         return $this;
291:     }
292: }
293: