<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_View

 * @subpackage Helper

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: FormNote.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * Abstract class for extension

 */

require_once 'Zend/View/Helper/FormElement.php';

/**

 * Helper to show an HTML note

 *

 * @category   Zend

 * @package    Zend_View

 * @subpackage Helper

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_View_Helper_FormNote extends Zend_View_Helper_FormElement

{

    /**

    * Helper to show a "note" based on a hidden value.

     *

     * @access public

     *

     * @param string|array $name If a string, the element name.  If an

     * array, all other parameters are ignored, and the array elements

     * are extracted in place of added parameters.

     *

     * @param array $value The note to display.  HTML is *not* escaped; the

     * note is displayed as-is.

     *

     * @return string The element XHTML.

     */

    public function formNote($name, $value = null)

    {

        $info = $this->_getInfo($name, $value);

        extract($info); // name, value, attribs, options, listsep, disable

        return $value;

    }

}