Magento: lib/Varien/Data/Form/Element/Obscure.php Source File

00001 <?php
00002 /**
00003  * Magento
00004  *
00005  * NOTICE OF LICENSE
00006  *
00007  * This source file is subject to the Open Software License (OSL 3.0)
00008  * that is bundled with this package in the file LICENSE.txt.
00009  * It is also available through the world-wide-web at this URL:
00010  * http://opensource.org/licenses/osl-3.0.php
00011  * If you did not receive a copy of the license and are unable to
00012  * obtain it through the world-wide-web, please send an email
00013  * to license@magentocommerce.com so we can send you a copy immediately.
00014  *
00015  * DISCLAIMER
00016  *
00017  * Do not edit or add to this file if you wish to upgrade Magento to newer
00018  * versions in the future. If you wish to customize Magento for your
00019  * needs please refer to http://www.magentocommerce.com for more information.
00020  *
00021  * @category   Varien
00022  * @package    Varien_Data
00023  * @copyright  Copyright (c) 2008 Irubin Consulting Inc. DBA Varien (http://www.varien.com)
00024  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
00025  */
00026 
00027 /**
00028  * Form text element
00029  *
00030  * @category   Varien
00031  * @package    Varien_Data
00032  * @author      Magento Core Team <core@magentocommerce.com>
00033  */
00034 class Varien_Data_Form_Element_Obscure extends Varien_Data_Form_Element_Text
00035 {
00036     /**
00037      * @var string
00038      */
00039     protected $_obscuredValue = '******';
00040 
00041     /**
00042      * Hide value to make sure it will not show in HTML
00043      *
00044      * @param string $index
00045      * @return string
00046      */
00047     public function getEscapedValue($index = null)
00048     {
00049         $value = parent::getEscapedValue($index);
00050         if (!empty($value)) {
00051             return $this->_obscuredValue;
00052         }
00053         return $value;
00054     }
00055 }