Table of contents
| Table of Contents |
|---|
HelperForm
This helper is used to generate an edition form for an object of type ObjectModel. Example: editing the client's profile.
Form declaration
Fields inside [brackets] are optional as per the HTML standard.
Values between {curly braces} list the possible values for this field.
| Code Block |
|---|
$this->fields_form = array(
'legend' => array(
'title' => $this->l('Edit carrier'), // This is the name of the fieldset, which can contain many option fields
'image' => '../img/admin/icon_to_display.gif' // The icon must, if there is one, must be of the size 16*16
),
'input' => array(
array(
'type' => {'text', 'select', 'textarea', 'radio', 'checkbox', 'file', 'shop', 'asso_shop', 'free', 'color'},
['label'] => $this->l('Shipping method'), // Theoretically optional, but in reality each field has to have a label
'name' => 'shipping_method', // The name of the object property from which we get the value
['required'] => {true, false}, // If true, PrestaShop will add a red star next to the field
['desc'] => $this->l('Description displayed under the field'),
['hint'] => $this->l('Invalid characters:').' <>;=#{}' // This is displayed when the mouse hovers the field.
['suffix'] => 'kg' // This is displayed after the field (ie. to indicate the unit of measure)
['options'] => array( // This is only useful if type == select
'query' => $array_of_rows, // $array_of_rows must contain an array of arrays, inner arrays (rows) being mode of many fields
'id' => 'id_carrier', // The key that will be used for each option "value" attribute
),
['values'] => array( // This is only useful if type == radio
array(
'id' => 'active_on',
'value' => 1,
'label' => $this->l('Enabled')
),
array(
'id' => 'active_off',
'value' => 0,
'label' => $this->l('Disabled')
)
),
[is_bool] => {true, false}, // This is only useful if type == radio. It display a "yes or no" choice.
['empty_message'] => $this->l('To be displayed when the field is empty'),
['lang'] => {true, false}, // isIs the field multilang?
),
array(
//another field
),
),
'submit' => array(
'title' => $this->l(' Save '), // This is the button that saves the whole fieldset.
'class' => 'button'
)
); |
...
This specific code generates this HTML code (simplifier simplified here for readability reasons):
| Code Block |
|---|
<form id="_form">
<fieldset id="fieldset_main_conf">
<legend>
<img alt="Edit carrier" src="../img/admin/icon_to_display.gif">Edit carrier
</legend>
<div class="margin-form">
<input type="text" class="" value="" id="shipping_method" name="shipping_method">
</div>
<div class="clear"></div>
<div class="margin-form">
<input type="submit" class="button" name="" value="Save" id="_form_submit_btn">
</div>
</fieldset>
</form> |
...
The content of the selector is stored in the $options variables variable, which is an array of arrays.
...
...but of course, you would be better of off generating such an array of arrays yourself, from the data stored in PrestaShop. For instance, here is how to display a gender (social title) selector:
| Code Block |
|---|
foreach (Gender::getGenders((int)Context::getContext()->language->id) as $gender)
{
$genders[] = array(
"id" => (int)$gender->id,
"name" => $gender->name,
);
} |
Check boxes
Here is how to generate a <input> of type "checkbox":
| Code Block |
|---|
array(
'name' => 'options',
'type' => 'checkbox',
'label' => $this->l('Options'),
'values' => array(
'query' => $options,
'id' => 'id_option',
'name' => 'name',
),
'desc' => $this->l('Choose options.')
), |
Just like selectorsas for a selector input, check boxes take an array of arrays as the value of $options.
...
Note that you have to use the "t" CSS class to on your radio buttons in order to have the proper styling (but you can redefine that class using the "class" variable).
Other HTML elements
The type variable of the element declaration makes it possible to generate just about any kind of HTML <input> element: text, select, textarea, radio, checkbox, file. And the and many others! See the list of available types here: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Input
You can also use some PrestaShop specific: shop, asso_shop, free, color. Try them out!