{requiredNote}
EOT;
$renderer->setRequiredNoteTemplate($noteTemplate);
}
/**
* @return string
*/
public function getFormTemplate()
{
return '
{icon}
{element}
{label_2}
{error}
{label_3}
');
$this->addHtml(
'
');
$this->addHtml('
');
$this->addHtml('
');
}
/**
* Adds a HTML-editor to the form.
*
* @param string $name
* @param string|array $label The label for the form-element
* @param bool $required (optional) Is the form-element required (default=true)
* @param bool $fullPage (optional) When it is true, the editor loads completed html code for a full page
* @param array $config (optional) Configuration settings for the online editor
*/
public function addHtmlEditor(
$name,
$label,
$required = true,
$fullPage = false,
$config = []
) {
$attributes = [];
$attributes['rows'] = isset($config['rows']) ? $config['rows'] : 15;
$attributes['cols'] = isset($config['cols']) ? $config['cols'] : 80;
$attributes['cols-size'] = isset($config['cols-size']) ? $config['cols-size'] : [];
$attributes['class'] = isset($config['class']) ? $config['class'] : [];
$this->addElement('html_editor', $name, $label, $attributes, $config);
$this->applyFilter($name, 'trim');
if ($required) {
$this->addRule($name, get_lang('ThisFieldIsRequired'), 'required');
}
/** @var HtmlEditor $element */
$element = $this->getElement($name);
$config['style'] = isset($config['style']) ? $config['style'] : false;
if ($fullPage) {
$config['fullPage'] = true;
// Adds editor_content.css in ckEditor
$config['style'] = true;
}
if ($element->editor) {
$element->editor->processConfig($config);
}
}
/**
* Adds a Google Maps Geolocalization field to the form.
*
* @param $name
* @param $label
* @param bool $hideGeoLocalizationDetails
*/
public function addGeoLocationMapField($name, $label, $dataValue, $hideGeoLocalizationDetails = false)
{
$gMapsPlugin = GoogleMapsPlugin::create();
$geolocalization = $gMapsPlugin->get('enable_api') === 'true';
if ($geolocalization && $gMapsPlugin->javascriptIncluded === false) {
$gmapsApiKey = $gMapsPlugin->get('api_key');
$url = '//maps.googleapis.com/maps/api/js?key='.$gmapsApiKey;
$this->addHtml('');
$gMapsPlugin->javascriptIncluded = true;
}
$this->addElement(
'text',
$name,
$label,
['id' => $name]
);
$this->addHidden(
$name.'_coordinates',
'',
['id' => $name.'_coordinates']
);
$this->applyFilter($name, 'stripslashes');
$this->applyFilter($name, 'trim');
$this->addHtml(Extrafield::getLocalizationJavascript($name, $dataValue));
if ($hideGeoLocalizationDetails) {
$this->addHtml('');
}
}
/**
* @param string $name
* @param string $label
*
* @return mixed
*/
public function addButtonAdvancedSettings($name, $label = '')
{
$label = !empty($label) ? $label : get_lang('AdvancedParameters');
return $this->addElement('advanced_settings', $name, $label);
}
/**
* Adds a progress loading image to the form.
*/
public function addProgress($delay = 2, $label = '')
{
if (empty($label)) {
$label = get_lang('PleaseStandBy');
}
$this->with_progress_bar = true;
$id = $this->getAttribute('id');
$this->updateAttributes("onsubmit=\"javascript: addProgress('".$id."')\"");
$this->addHtml('');
}
/**
* This function has been created for avoiding changes directly within QuickForm class.
* When we use it, the element is threated as 'required' to be dealt during validation.
*
* @param array $elements The array of elements
* @param string $message The message displayed
*/
public function add_multiple_required_rule($elements, $message)
{
$this->_required[] = $elements[0];
$this->addRule($elements, $message, 'multiple_required');
}
/**
* Displays the form.
* If an element in the form didn't validate, an error message is showed
* asking the user to complete the form.
*/
public function display()
{
echo $this->returnForm();
}
/**
* Returns the HTML code of the form.
*
* @return string $return_value HTML code of the form
*/
public function returnForm()
{
$returnValue = '';
/** @var HTML_QuickForm_element $element */
foreach ($this->_elements as $element) {
$elementError = parent::getElementError($element->getName());
if (!is_null($elementError)) {
$returnValue .= Display::return_message($elementError, 'warning').'
');
foreach ($groupList as $groupName => $group) {
// Add group array
if (!empty($groupName) && is_array($group)) {
$this->addGroup($group, '', $groupName);
}
// Add element
if ($group instanceof HTML_QuickForm_element) {
$this->addElement($group);
}
}
$this->addHtml('
'; break; } } $returnValue .= parent::toHtml(); // Add div-element which is to hold the progress bar $id = $this->getAttribute('id'); if (isset($this->with_progress_bar) && $this->with_progress_bar) { // Deprecated // $icon = Display::return_icon('progress_bar.gif'); // @todo improve UI $returnValue .= '
'; } return $returnValue; } /** * Returns the HTML code of the form. * If an element in the form didn't validate, an error message is showed * asking the user to complete the form. * * @return string $return_value HTML code of the form * * @author Patrick Cool
'.get_lang('ClickToSelectOrDragAndDropMultipleFilesOnTheUploadField').'