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:  * Widget Block Interface
29:  *
30:  * @category    Mage
31:  * @package     Mage_Widget
32:  * @author      Magento Core Team <core@magentocommerce.com>
33:  */
34: interface Mage_Widget_Block_Interface
35: {
36:     /**
37:      * Produce and return widget's html output
38:      *
39:      * @return string
40:      */
41:     public function toHtml();
42: 
43:     /**
44:      * Add data to the widget.
45:      * Retains previous data in the widget.
46:      *
47:      * @param array $arr
48:      * @return Mage_Widget_Block_Interface
49:      */
50:     public function addData(array $arr);
51: 
52:     /**
53:      * Overwrite data in the widget.
54:      *
55:      * $key can be string or array.
56:      * If $key is string, the attribute value will be overwritten by $value.
57:      * If $key is an array, it will overwrite all the data in the widget.
58:      *
59:      * @param string|array $key
60:      * @param mixed $value
61:      * @return Varien_Object
62:      */
63:     public function setData($key, $value = null);
64: }
65: