Warning: You are browsing the documentation from version 4 to 10 of Pimcore.
Please visit https://pimcore.com/docs/platform/ for the latest versions of Pimcore.
Version:
Input Editable
General
The input editable is a single line unformatted text placeholder (just as HTMLs <input>
is), which is useful for text headlines, paragraphs and other values.
For a multi-line alternative have a look at the textarea editable, for rich-text WYSIWYG.
Configuration
Name | Type | Configuration |
---|---|---|
width |
integer | Width of the input in editmode (in pixels) |
htmlspecialchars |
boolean | Set to false to get the raw value without HTML special chars like & (default to true) |
nowrap |
boolean | set to false to disable the automatic line break |
class |
string | A CSS class that is added to the surrounding container of this element in editmode |
placeholder |
string | A placeholder that is displayed when the field is empty |
Methods
Name | Return | Description |
---|---|---|
getData() |
string | Value of the input, this is useful to get the value even in editmode. |
isEmpty() |
boolean | Whether the editable is empty or not |
Example
Basic usage
<h2>
<?= $this->input("myHeadline"); ?>
</h2>
<h2>
{{ pimcore_input("myHeadline") }}
</h2>
The above code generates an editable area which you can fill with the text, see:
Advanced usage
You could also specify other parameters, like the size:
<h2>
<?= $this->input("myHeadline", ["width" => 540]); ?>
</h2>
<h2>
{{ pimcore_input("headerLine", {'width': 540}) }}
</h2>
Validation
To validate the input you have to add validator
parameter to the configuration array.
<h2>
<?= $this->input("myHeadline", [
"validator" => new Zend_Json_Expr('
function(value){
return value.match(/\d.*/) !== null;
}'
)
]); ?>
</h2>
At the moment, the validation has only a visual effect, user can still save an incorrect value.