HTML_QuickForm_element::freeze()
PEAR Manual
PrevNext

HTML_QuickForm_element::freeze()

HTML_QuickForm_element::freeze() -- Freezes the element

Synopsis

require_once 'HTML/QuickForm/element.php';

void HTML_QuickForm_element::freeze ()

Description

When the element is displayed after the call to freeze(), only its value is displayed without the input tags, thus the element cannot be edited. If persistant freeze is set, then hidden field containing the element value will be output, too.

Note: This method makes sense only with the elements that actually are editable in the first place. It has no effect on buttons, images, hidden fields, static content and the like.

Throws

throws no exceptions thrown

See

see unfreeze(), isFrozen(), setPersistantFreeze(), getFrozenHtml(), HTML_QuickForm::freeze(), HTML_QuickForm::isFrozen().

Note

This function can not be called statically.

Example

Example 41-1. Freezing the text element

require_once 'HTML/QuickForm.php';

$text =& HTML_QuickForm::createElement('text', 'freezeMe');
$text->setValue('Some value');
echo $text->toHtml() . "\n";
$text->freeze();
echo $text->toHtml() . "\n";
$text->setPersistantFreeze(false);
echo $text->toHtml() . "\n";
$text->unfreeze();
echo $text->toHtml() . "\n";

Example 41-2. Output

<input name="freezeMe" type="text" value="Some value" />
Some value<input type="hidden" name="freezeMe" value="Some value" />
Some value
<input name="freezeMe" type="text" value="Some value" />
PrevHomeNext
HTML_QuickForm_element::exportValue()UpHTML_QuickForm_element::getFrozenHtml()