tag
* @param string $layout
* @param bool $trackSubmit (optional) Whether to track if the form was
* submitted by adding a special hidden field (default = true)
*/
public function __construct(
$name,
$method = 'post',
$action = '',
$target = '',
$attributes = [],
$layout = self::LAYOUT_HORIZONTAL,
$trackSubmit = true
) {
// Default form class.
if (is_array($attributes) && !isset($attributes['class']) || empty($attributes)) {
$attributes['class'] = 'form-horizontal';
}
if (isset($attributes['class']) && strpos($attributes['class'], 'form-search') !== false) {
$layout = 'inline';
}
$this->setLayout($layout);
switch ($layout) {
case self::LAYOUT_HORIZONTAL:
$attributes['class'] = 'form-horizontal';
break;
case self::LAYOUT_INLINE:
case self::LAYOUT_BOX:
$attributes['class'] = 'form-inline';
break;
}
parent::__construct($name, $method, $action, $target, $attributes, $trackSubmit);
// Modify the default templates
$renderer = &$this->defaultRenderer();
// Form template
$formTemplate = $this->getFormTemplate();
$renderer->setFormTemplate($formTemplate);
// Element template
if (isset($attributes['class']) && $attributes['class'] == 'form-inline') {
$elementTemplate = ' {label} {element} ';
$renderer->setElementTemplate($elementTemplate);
} elseif (isset($attributes['class']) && $attributes['class'] == 'form-search') {
$elementTemplate = ' {label} {element} ';
$renderer->setElementTemplate($elementTemplate);
} else {
$renderer->setElementTemplate($this->getDefaultElementTemplate());
// Display a gray div in the buttons
$templateSimple = '
{label} {element}
';
$renderer->setElementTemplate($templateSimple, 'submit_in_actions');
//Display a gray div in the buttons + makes the button available when scrolling
$templateBottom = '
{label} {element}
';
$renderer->setElementTemplate($templateBottom, 'submit_fixed_in_bottom');
//When you want to group buttons use something like this
/* $group = array();
$group[] = $form->createElement('button', 'mark_all', get_lang('Select all'));
$group[] = $form->createElement('button', 'unmark_all', get_lang('Unselect all'));
$form->addGroup($group, 'buttons_in_action');
*/
$renderer->setElementTemplate($templateSimple, 'buttons_in_action');
$templateSimpleRight = '
EOT;
$renderer->setRequiredNoteTemplate($noteTemplate);
}
/**
* @return string
*/
public function getFormTemplate()
{
return '
{hidden}
';
}
/**
* @todo this function should be added in the element class
*
* @return string
*/
public function getDefaultElementTemplate()
{
return '
{icon}
{element}
{label_2}
{error}
{label_3}
';
}
/**
* @return string
*/
public function getLayout()
{
return $this->layout;
}
/**
* @param string $layout
*/
public function setLayout($layout)
{
$this->layout = $layout;
}
/**
* Adds a text field to the form.
* A trim-filter is attached to the field.
*
* @param string|array $label The label for the form-element
* @param string $name The element name
* @param bool $required (optional) Is the form-element required (default=true)
* @param array $attributes (optional) List of attributes for the form-element
*
* @return HTML_QuickForm_text
*/
public function addText($name, $label, $required = true, $attributes = [], $createElement = false)
{
if ($createElement) {
$element = $this->createElement('text', $name, $label, $attributes);
} else {
$element = $this->addElement('text', $name, $label, $attributes);
}
$this->applyFilter($name, 'trim');
if ($required) {
$this->addRule($name, get_lang('Required field'), 'required');
}
return $element;
}
/**
* Add hidden course params.
*/
public function addCourseHiddenParams()
{
$this->addHidden('cidReq', api_get_course_id());
$this->addHidden('id_session', api_get_session_id());
}
/**
* The "date_range_picker" element creates 2 hidden fields
* "elementName" + "_start" and "elementName" + "_end"
* For example if the name is "range", you will have 2 new fields
* when executing $form->getSubmitValues()
* "range_start" and "range_end".
*
* @param string $name
* @param string $label
* @param bool $required
* @param array $attributes
*/
public function addDateRangePicker($name, $label, $required = true, $attributes = [])
{
$this->addElement('date_range_picker', $name, $label, $attributes);
$this->addElement('hidden', $name.'_start');
$this->addElement('hidden', $name.'_end');
if ($required) {
$this->addRule($name, get_lang('Required field'), 'required');
}
}
/**
* @param string $name
* @param string $label
* @param array $attributes
*
* @return mixed
*/
public function addDatePicker($name, $label, $attributes = [])
{
return $this->addElement('DatePicker', $name, $label, $attributes);
}
/**
* @param string $name
* @param string $label
* @param array $attributes
*
* @return mixed
*/
public function addSelectLanguage($name, $label, $options = [], $attributes = [])
{
return $this->addElement('SelectLanguage', $name, $label, $options, $attributes);
}
/**
* @param string $name
* @param string $label
* @param array $options
* @param array $attributes
*
* @throws Exception
*
* @return HTML_QuickForm_element
*/
public function addSelectAjax($name, $label, $options = [], $attributes = [])
{
if (!isset($attributes['url'])) {
throw new \Exception('select_ajax needs an URL');
}
return $this->addElement(
'select_ajax',
$name,
$label,
$options,
$attributes
);
}
/**
* @param string $name
* @param string|array $label
* @param array $attributes
*
* @return DateTimePicker
*/
public function addDateTimePicker($name, $label, $attributes = [])
{
return $this->addElement('DateTimePicker', $name, $label, $attributes);
}
/**
* @param string $name
* @param string|array $label
* @param array $attributes
*
* @return DateTimeRangePicker
*/
public function addDateTimeRangePicker($name, $label, $attributes = [])
{
return $this->addElement('DateTimeRangePicker', $name, $label, $attributes);
}
/**
* @param string $name
* @param string $value
* @param array $attributes
*/
public function addHidden($name, $value, $attributes = [])
{
$this->addElement('hidden', $name, $value, $attributes);
}
/**
* @param string $name
* @param string|array $label
* @param array $attributes
* @param bool $required
*
* @return HTML_QuickForm_textarea
*/
public function addTextarea($name, $label, $attributes = [], $required = false)
{
$element = $this->addElement('textarea', $name, $label, $attributes);
if ($required) {
$this->addRule($name, get_lang('Required field'), 'required');
}
return $element;
}
/**
* @param string $name
* @param string $label
* @param string $icon font-awesome
* @param string $style default|primary|success|info|warning|danger|link
* @param string $size large|default|small|extra-small
* @param string $class Example plus is transformed to icon fa fa-plus
* @param array $attributes
* @param bool $createElement
*
* @return HTML_QuickForm_button
*/
public function addButton(
$name,
$label,
$icon = 'check',
$style = 'default',
$size = 'default',
$class = null,
$attributes = [],
$createElement = false
) {
if ($createElement) {
return $this->createElement(
'button',
$name,
$label,
$icon,
$style,
$size,
$class,
$attributes
);
}
return $this->addElement(
'button',
$name,
$label,
$icon,
$style,
$size,
$class,
$attributes
);
}
/**
* Returns a button with the primary color and a check mark.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
* @param array $attributes
*
* @return HTML_QuickForm_button
*/
public function addButtonSave($label, $name = 'submit', $createElement = false, $attributes = [])
{
return $this->addButton(
$name,
$label,
'check',
'primary',
null,
null,
$attributes,
$createElement
);
}
/**
* Returns a cancel button.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonCancel($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'times',
'danger',
null,
null,
[],
$createElement
);
}
/**
* Returns a button with the primary color and a "plus" icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
* @param array $attributes Additional attributes
*
* @return HTML_QuickForm_button
*/
public function addButtonCreate($label, $name = 'submit', $createElement = false, $attributes = [])
{
return $this->addButton(
$name,
$label,
'plus',
'primary',
null,
null,
$attributes,
$createElement
);
}
/**
* Returns a button with the primary color and a pencil icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonUpdate($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'pencil',
'primary',
null,
null,
[],
$createElement
);
}
/**
* Returns a button with the danger color and a trash icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonDelete($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'trash',
'danger',
null,
null,
[],
$createElement
);
}
/**
* Returns a move style button.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonMove($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'arrow-circle-right',
'primary',
null,
null,
[],
$createElement
);
}
/**
* Returns a button with the primary color and a paper-plane icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
* @param array $attributes
*
* @return HTML_QuickForm_button
*/
public function addButtonSend($label, $name = 'submit', $createElement = false, $attributes = [])
{
return $this->addButton(
$name,
$label,
'paper-plane',
'primary',
null,
null,
$attributes,
$createElement
);
}
/**
* Returns a button with the default (grey?) color and a magnifier icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
*
* @return HTML_QuickForm_button
*/
public function addButtonSearch($label = null, $name = 'submit')
{
if (empty($label)) {
$label = get_lang('Search');
}
return $this->addButton($name, $label, 'search', 'primary');
}
/**
* Returns a button with the primary color and a right-pointing arrow icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param array $attributes Additional attributes
*
* @return HTML_QuickForm_button
*/
public function addButtonNext($label, $name = 'submit', $attributes = [])
{
return $this->addButton(
$name,
$label,
'arrow-right',
'primary',
null,
null,
$attributes
);
}
/**
* Returns a button with the primary color and a check mark icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonImport($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'check',
'primary',
null,
null,
[],
$createElement
);
}
/**
* Returns a button with the primary color and a check-mark icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonExport($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'check',
'primary',
null,
null,
[],
$createElement
);
}
/**
* Shortcut to filter button.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonFilter($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'filter',
'primary',
null,
null,
[],
$createElement
);
}
/**
* Shortcut to reset button.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonReset($label, $name = 'reset', $createElement = false)
{
$icon = 'eraser';
$style = 'default';
$size = 'default';
$class = null;
$attributes = [];
if ($createElement) {
return $this->createElement(
'reset',
$name,
$label,
$icon,
$style,
$size,
$class,
$attributes
);
}
return $this->addElement(
'reset',
$name,
$label,
$icon,
$style,
$size,
$class,
$attributes
);
}
/**
* Returns a button with the primary color and an upload icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonUpload($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'upload',
'primary',
null,
null,
[],
$createElement
);
}
/**
* Returns a button with the primary color and a download icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonDownload($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'download',
'primary',
null,
null,
[],
$createElement
);
}
/**
* Returns a button with the primary color and a magnifier icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonPreview($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'search',
'primary',
null,
null,
[],
$createElement
);
}
/**
* Returns a button with the primary color and a copy (double sheet) icon.
*
* @param string $label Text appearing on the button
* @param string $name Element name (for form treatment purposes)
* @param bool $createElement Whether to use the create or add method
*
* @return HTML_QuickForm_button
*/
public function addButtonCopy($label, $name = 'submit', $createElement = false)
{
return $this->addButton(
$name,
$label,
'copy',
'primary',
null,
null,
[],
$createElement
);
}
/**
* @param string $name
* @param string $label
* @param string $text
* @param array $attributes
*
* @return HTML_QuickForm_checkbox
*/
public function addCheckBox($name, $label, $text = '', $attributes = [])
{
return $this->addElement('checkbox', $name, $label, $text, $attributes);
}
/**
* @param string $name
* @param string $label
* @param array $options
* @param array $attributes
*
* @return HTML_QuickForm_group
*/
public function addCheckBoxGroup($name, $label, $options = [], $attributes = [])
{
$group = [];
foreach ($options as $value => $text) {
$attributes['value'] = $value;
$group[] = $this->createElement(
'checkbox',
$value,
null,
$text,
$attributes
);
}
return $this->addGroup($group, $name, $label);
}
/**
* @param string $name
* @param string $label
* @param array $options
* @param array $attributes
*
* @return HTML_QuickForm_group
*/
public function addRadio($name, $label, $options = [], $attributes = [])
{
$group = [];
foreach ($options as $key => $value) {
$group[] = $this->createElement('radio', null, null, $value, $key, $attributes);
}
return $this->addGroup($group, $name, $label);
}
/**
* @param string $name
* @param string $label
* @param array $options
* @param array $attributes
*
* @return HTML_QuickForm_select
*/
public function addSelect($name, $label, $options = [], $attributes = [])
{
return $this->addElement('select', $name, $label, $options, $attributes);
}
/**
* @param $name
* @param $label
* @param $collection
* @param array $attributes
* @param bool $addNoneOption
* @param string $textCallable set a function getStringValue() by default __toString()
*
* @return HTML_QuickForm_element
*/
public function addSelectFromCollection(
$name,
$label,
$collection,
$attributes = [],
$addNoneOption = false,
$textCallable = ''
) {
$options = [];
if ($addNoneOption) {
$options[0] = get_lang('None');
}
if (!empty($collection)) {
foreach ($collection as $item) {
$text = $item;
if (!empty($textCallable)) {
$text = $item->$textCallable();
}
$options[$item->getId()] = $text;
}
}
return $this->addElement('select', $name, $label, $options, $attributes);
}
/**
* @param string $label
* @param string $text
* @param bool $createElement
*
* @return HTML_QuickForm_Element
*/
public function addLabel($label, $text, $createElement = false)
{
if ($createElement) {
return $this->createElement(
'label',
$label,
$text
);
}
return $this->addElement('label', $label, $text);
}
/**
* @param string $text
*/
public function addHeader($text)
{
if (!empty($text)) {
$this->addElement('header', $text);
}
}
/**
* @param string $name
* @param string $label
* @param array $attributes
*
* @throws Exception if the file doesn't have an id
*
* @return HTML_QuickForm_file
*/
public function addFile($name, $label, $attributes = [])
{
try {
$element = $this->addElement('file', $name, $label, $attributes);
if (isset($attributes['crop_image'])) {
$id = $element->getAttribute('id');
if (empty($id)) {
throw new Exception('If you use the crop functionality the element must have an id');
}
$this->addHtml(
'
'
);
$this->addHidden($id.'_crop_result', '');
$this->addHidden($id.'_crop_image_base_64', '');
}
} catch (HTML_Quick | Form_Error $e) {
var_dump($e->getMessage());
}
return $element;
}
/**
* @param string $snippet
*/
public function addHtml($snippet)
{
$this->addElement('html', $snippet);
}
/**
* Draws a panel of options see the course_info/infocours.php page.
*
* @param string $name internal name
* @param string $title visible title
* @param array $groupList list of group or elements
*/
public function addPanelOption($name, $title, $groupList, $icon, $open = false, $parent)
{
$html = '
';
$this->addHtml($html);
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('
');
}
/**
* 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
* @param array $attributes
*
* @throws Exception
* @throws HTML_QuickForm_Error
*/
public function addHtmlEditor(
$name,
$label,
$required = true,
$fullPage = false,
$config = [],
$attributes = []
) {
$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'] : [];
$attributes['id'] = isset($config['id']) ? $config['id'] : '';
if (empty($attributes['id'])) {
$attributes['id'] = $name;
}
$this->addElement('html_editor', $name, $label, $attributes, $config);
$this->applyFilter($name, 'trim');
if ($required) {
$this->addRule($name, get_lang('Required field'), '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('
');
}
$this->addHtml(
Extrafield::getLocalizationInput($name, $label)
);
if ($hideGeoLocalizationDetails) {
$this->addHtml('
');
}
}
/**
* @param string $name
* @param string $label
*
* @return mixed
*/
public function addButtonAdvancedSettings($name, $label = '')
{
$label = !empty($label) ? $label : get_lang('Advanced settings');
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('Please stand by...');
}
$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').' ';
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 , Ghent University, august 2006
* @author Julio Montoya
*
* @deprecated use returnForm()
*/
public function return_form()
{
return $this->returnForm();
}
/**
* @return HTML_QuickForm_Renderer_Default
*/
public static function getDefaultRenderer()
{
return
isset($GLOBALS['_HTML_QuickForm_default_renderer']) ?
$GLOBALS['_HTML_QuickForm_default_renderer'] : null;
}
/**
* Adds a input of type url to the form.
*
* @param string $name The label for the form-element
* @param string $label The element name
* @param bool $required Optional. Is the form-element required (default=true)
* @param array $attributes Optional. List of attributes for the form-element
*/
public function addUrl($name, $label, $required = true, $attributes = [])
{
$this->addElement('url', $name, $label, $attributes);
$this->applyFilter($name, 'trim');
$this->addRule($name, get_lang('Insert a valid URL'), 'url');
if ($required) {
$this->addRule($name, get_lang('Required field'), 'required');
}
}
/**
* Adds a text field for letters to the form.
* A trim-filter is attached to the field.
*
* @param string $name The element name
* @param string $label The label for the form-element
* @param bool $required Optional. Is the form-element required (default=true)
* @param array $attributes Optional. List of attributes for the form-element
*/
public function addTextLettersOnly(
$name,
$label,
$required = false,
$attributes = []
) {
$attributes = array_merge(
$attributes,
[
'pattern' => '[a-zA-ZñÑ]+',
'title' => get_lang('Only letters'),
]
);
$this->addElement(
'text',
$name,
[
$label,
get_lang('Only letters'),
],
$attributes
);
$this->applyFilter($name, 'trim');
if ($required) {
$this->addRule($name, get_lang('Required field'), 'required');
}
$this->addRule(
$name,
get_lang('Only letters'),
'regex',
'/^[a-zA-ZñÑ]+$/'
);
}
/**
* Adds a text field for alphanumeric characters to the form.
* A trim-filter is attached to the field.
*
* @param string $name The element name
* @param string $label The label for the form-element
* @param bool $required Optional. Is the form-element required (default=true)
* @param array $attributes Optional. List of attributes for the form-element
*/
public function addTextAlphanumeric(
$name,
$label,
$required = false,
$attributes = []
) {
$attributes = array_merge(
$attributes,
[
'pattern' => '[a-zA-Z0-9ñÑ]+',
'title' => get_lang('Only lettersAndNumbers'),
]
);
$this->addElement(
'text',
$name,
[
$label,
get_lang('Only lettersAndNumbers'),
],
$attributes
);
$this->applyFilter($name, 'trim');
if ($required) {
$this->addRule($name, get_lang('Required field'), 'required');
}
$this->addRule(
$name,
get_lang('Only lettersAndNumbers'),
'regex',
'/^[a-zA-Z0-9ÑÑ]+$/'
);
}
/**
* @param string $name
* @param $label
* @param bool $required
* @param array $attributes
* @param bool $allowNegative
* @param int $minValue
* @param null $maxValue
*/
public function addFloat(
$name,
$label,
$required = false,
$attributes = [],
$allowNegative = false,
$minValue = null,
$maxValue = null
) {
$this->addElement(
'FloatNumber',
$name,
$label,
$attributes
);
$this->applyFilter($name, 'trim');
if ($required) {
$this->addRule($name, get_lang('Required field'), 'required');
}
// Rule allows "," and "."
/*$this->addRule(
$name,
get_lang('Only numbers'),
'regex',
'/(^-?\d\d*\.\d*$)|(^-?\d\d*$)|(^-?\.\d\d*$)|(^-?\d\d*\,\d*$)|(^-?\,\d\d*$)/'
);*/
if ($allowNegative == false) {
$this->addRule(
$name,
get_lang('Negative value'),
'compare',
'>=',
'server',
false,
false,
0
);
}
if (!is_null($minValue)) {
$this->addRule(
$name,
get_lang('Under the minimum.'),
'compare',
'>=',
'server',
false,
false,
$minValue
);
}
if (!is_null($maxValue)) {
$this->addRule(
$name,
get_lang('Value exceeds score.'),
'compare',
'<=',
'server',
false,
false,
$maxValue
);
}
}
/**
* Adds a text field for letters and spaces to the form.
* A trim-filter is attached to the field.
*
* @param string $name The element name
* @param string $label The label for the form-element
* @param bool $required Optional. Is the form-element required (default=true)
* @param array $attributes Optional. List of attributes for the form-element
*/
public function addTextLettersAndSpaces(
$name,
$label,
$required = false,
$attributes = []
) {
$attributes = array_merge(
$attributes,
[
'pattern' => '[a-zA-ZñÑ\s]+',
'title' => get_lang('Only lettersAndSpaces'),
]
);
$this->addElement(
'text',
$name,
[
$label,
get_lang('Only lettersAndSpaces'),
],
$attributes
);
$this->applyFilter($name, 'trim');
if ($required) {
$this->addRule($name, get_lang('Required field'), 'required');
}
$this->addRule(
$name,
get_lang('Only lettersAndSpaces'),
'regex',
'/^[a-zA-ZñÑ\s]+$/'
);
}
/**
* Adds a text field for alphanumeric and spaces characters to the form.
* A trim-filter is attached to the field.
*
* @param string $name The element name
* @param string $label The label for the form-element
* @param bool $required Optional. Is the form-element required (default=true)
* @param array $attributes Optional. List of attributes for the form-element
*/
public function addTextAlphanumericAndSpaces(
$name,
$label,
$required = false,
$attributes = []
) {
$attributes = array_merge(
$attributes,
[
'pattern' => '[a-zA-Z0-9ñÑ\s]+',
'title' => get_lang('Only lettersAndNumbersAndSpaces'),
]
);
$this->addElement(
'text',
$name,
[
$label,
get_lang('Only lettersAndNumbersAndSpaces'),
],
$attributes
);
$this->applyFilter($name, 'trim');
if ($required) {
$this->addRule($name, get_lang('Required field'), 'required');
}
$this->addRule(
$name,
get_lang('Only lettersAndNumbersAndSpaces'),
'regex',
'/^[a-zA-Z0-9ñÑ\s]+$/'
);
}
/**
* @param string $url
* @param string $urlToRedirect after upload redirect to this page
*/
public function addMultipleUpload($url, $urlToRedirect = '')
{
$inputName = 'input_file_upload';
$this->addMultipleUploadJavascript($url, $inputName, $urlToRedirect);
$this->addHtml('
'.get_lang('Click on the box below to select files from your computer (you can use CTRL + clic to select various files at a time), or drag and drop some files from your desktop directly over the box below. The system will handle the rest!').'
'.get_lang('Add files').'
'.get_lang('Click or drag and drop files here to upload them').'
');
}
/**
* @param string $elementName
* @param string $groupName if element is inside a group
*
* @throws Exception
*/
public function addPasswordRule($elementName, $groupName = '')
{
if (api_get_setting('security.check_password') == 'true') {
$message = get_lang('this password is too simple. Use a pass like this').': '.api_generate_password();
if (!empty($groupName)) {
$groupObj = $this->getElement($groupName);
if ($groupObj instanceof HTML_QuickForm_group) {
$elementName = $groupObj->getElementName($elementName);
if ($elementName === false) {
throw new Exception("The $groupName doesn't have the element $elementName");
}
$this->_rules[$elementName][] = [
'type' => 'callback',
'format' => 'api_check_password',
'message' => $message,
'validation' => '',
'reset' => false,
'group' => $groupName,
];
}
} else {
$this->addRule(
$elementName,
$message,
'callback',
'api_check_password'
);
}
}
}
/**
* Add an element with user ID and avatar to the form.
* It needs a Chamilo\UserBundle\Entity\User as value. The exported value is the Chamilo\UserBundle\Entity\User ID.
*
* @see \UserAvatar
*
* @param string $name
* @param string $label
* @param string $imageSize Optional. Small, medium or large image
* @param string $subtitle Optional. The subtitle for the field
*
* @return \UserAvatar
*/
public function addUserAvatar($name, $label, $imageSize = 'small', $subtitle = '')
{
return $this->addElement('UserAvatar', $name, $label, ['image_size' => $imageSize, 'sub_title' => $subtitle]);
}
/**
* @param array $typeList
*/
public function addEmailTemplate($typeList)
{
$mailManager = new MailTemplateManager();
foreach ($typeList as $type) {
$list = $mailManager->get_all(
['where' => ['type = ? AND url_id = ?' => [$type, api_get_current_access_url_id()]]]
);
$options = [get_lang('Select')];
$name = $type;
$defaultId = '';
foreach ($list as $item) {
$options[$item['id']] = $item['name'];
$name = $item['name'];
if (empty($defaultId)) {
$defaultId = $item['default_template'] == 1 ? $item['id'] : '';
}
}
$url = api_get_path(WEB_AJAX_PATH).'mail.ajax.php?a=select_option';
$typeNoDots = 'email_template_option_'.str_replace('.tpl', '', $type);
$this->addSelect(
'email_template_option['.$type.']',
$name,
$options,
['id' => $typeNoDots]
);
$templateNoDots = 'email_template_'.str_replace('.tpl', '', $type);
$templateNoDotsBlock = 'email_template_block_'.str_replace('.tpl', '', $type);
$this->addHtml('