| 1: | <?php |
| 2: | /** |
| 3: | * XOOPS form element |
| 4: | * |
| 5: | * You may not change or alter any portion of this comment or credits |
| 6: | * of supporting developers from this source code or any supporting source code |
| 7: | * which is considered copyrighted (c) material of the original comment or credit authors. |
| 8: | * This program is distributed in the hope that it will be useful, |
| 9: | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 10: | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| 11: | * |
| 12: | * @copyright (c) 2000-2017 XOOPS Project (www.xoops.org) |
| 13: | * @license GNU GPL 2 (https://www.gnu.org/licenses/gpl-2.0.html) |
| 14: | * @package kernel |
| 15: | * @subpackage form |
| 16: | * @since 2.0.0 |
| 17: | * @author Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/ |
| 18: | */ |
| 19: | |
| 20: | defined('XOOPS_ROOT_PATH') || exit('Restricted access'); |
| 21: | |
| 22: | /** |
| 23: | * A text label |
| 24: | */ |
| 25: | class XoopsFormLabel extends XoopsFormElement |
| 26: | { |
| 27: | /** |
| 28: | * Text |
| 29: | * |
| 30: | * @var string |
| 31: | * @access private |
| 32: | */ |
| 33: | public $_value; |
| 34: | |
| 35: | /** |
| 36: | * Constructor |
| 37: | * |
| 38: | * @param string $caption Caption |
| 39: | * @param string $value Text |
| 40: | * @param string $name |
| 41: | */ |
| 42: | public function __construct($caption = '', $value = '', $name = '') |
| 43: | { |
| 44: | $this->setCaption($caption); |
| 45: | $this->setName($name); |
| 46: | $this->_value = $value; |
| 47: | } |
| 48: | |
| 49: | /** |
| 50: | * Get the "value" attribute |
| 51: | * |
| 52: | * @param bool $encode To sanitizer the text? |
| 53: | * @return string |
| 54: | */ |
| 55: | public function getValue($encode = false) |
| 56: | { |
| 57: | return $encode ? htmlspecialchars($this->_value, ENT_QUOTES) : $this->_value; |
| 58: | } |
| 59: | |
| 60: | /** |
| 61: | * Prepare HTML for output |
| 62: | * |
| 63: | * @return string |
| 64: | */ |
| 65: | public function render() |
| 66: | { |
| 67: | return XoopsFormRenderer::getInstance()->get()->renderFormLabel($this); |
| 68: | } |
| 69: | } |
| 70: |