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_Widget
 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:  * WYSIWYG widget plugin form
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Widget
 32:  * @author     Magento Core Team <core@magentocommerce.com>
 33:  */
 34: 
 35: class Mage_Widget_Block_Adminhtml_Widget_Form extends Mage_Adminhtml_Block_Widget_Form
 36: {
 37:     /**
 38:      * Form with widget to select
 39:      */
 40:     protected function _prepareForm()
 41:     {
 42:         $form = new Varien_Data_Form();
 43: 
 44:         $fieldset = $form->addFieldset('base_fieldset', array(
 45:             'legend'    => $this->helper('widget')->__('Widget')
 46:         ));
 47: 
 48:         $select = $fieldset->addField('select_widget_type', 'select', array(
 49:             'label'                 => $this->helper('widget')->__('Widget Type'),
 50:             'title'                 => $this->helper('widget')->__('Widget Type'),
 51:             'name'                  => 'widget_type',
 52:             'required'              => true,
 53:             'options'               => $this->_getWidgetSelectOptions(),
 54:             'after_element_html'    => $this->_getWidgetSelectAfterHtml(),
 55:         ));
 56: 
 57:         $form->setUseContainer(true);
 58:         $form->setId('widget_options_form');
 59:         $form->setMethod('post');
 60:         $form->setAction($this->getUrl('*/*/buildWidget'));
 61:         $this->setForm($form);
 62:     }
 63: 
 64:     /**
 65:      * Prepare options for widgets HTML select
 66:      *
 67:      * @return array
 68:      */
 69:     protected function _getWidgetSelectOptions()
 70:     {
 71:         foreach ($this->_getAvailableWidgets(true) as $data) {
 72:             $options[$data['type']] = $data['name'];
 73:         }
 74:         return $options;
 75:     }
 76: 
 77:     /**
 78:      * Prepare widgets select after element HTML
 79:      *
 80:      * @return string
 81:      */
 82:     protected function _getWidgetSelectAfterHtml()
 83:     {
 84:         $html = '<p class="nm"><small></small></p>';
 85:         $i = 0;
 86:         foreach ($this->_getAvailableWidgets(true) as $data) {
 87:             $html .= sprintf('<div id="widget-description-%s" class="no-display">%s</div>', $i, $data['description']);
 88:             $i++;
 89:         }
 90:         return $html;
 91:     }
 92: 
 93:     /**
 94:      * Return array of available widgets based on configuration
 95:      *
 96:      * @return array
 97:      */
 98:     protected function _getAvailableWidgets($withEmptyElement = false)
 99:     {
100:         if (!$this->hasData('available_widgets')) {
101:             $result = array();
102:             $allWidgets = Mage::getModel('widget/widget')->getWidgetsArray();
103:             $skipped = $this->_getSkippedWidgets();
104:             foreach ($allWidgets as $widget) {
105:                 if (is_array($skipped) && in_array($widget['type'], $skipped)) {
106:                     continue;
107:                 }
108:                 $result[] = $widget;
109:             }
110:             if ($withEmptyElement) {
111:                 array_unshift($result, array(
112:                     'type'        => '',
113:                     'name'        => $this->helper('adminhtml')->__('-- Please Select --'),
114:                     'description' => '',
115:                 ));
116:             }
117:             $this->setData('available_widgets', $result);
118:         }
119: 
120:         return $this->_getData('available_widgets');
121:     }
122: 
123:     /**
124:      * Return array of widgets disabled for selection
125:      *
126:      * @return array
127:      */
128:     protected function _getSkippedWidgets()
129:     {
130:         return Mage::registry('skip_widgets');
131:     }
132: }
133: