Разработка:moodleQuickForm

Материал из DOF
Версия от 15:11, 4 июня 2009; Ilya (обсуждение | вклад) (→‎Описание стандартных методов moodleform: Добавлено описание метода disabledif)
Перейти к: навигация, поиск

Содержание

Общие сведения

Библиотека moodleQuickForm (она же moodleform) построена на основе библиотеки PEAR HTML_QuickForm. Описание работы всех функций moodleQuickForm следует искать именно по этой ссылке.

При помощи moodleQuickForm можно описать большинство стандартных форм. Эта библиотека значительно облегчает время и силы, потраченные на разработку формы.

Перечисление всего того, что доступно в moodleQuickForm заняло бы слишком много места, поэтому перечислим только те задачи, которые при помощи этой библиотеки решить нельзя:

  • создать форму в виде таблицы, в которой более 2-х столбцов
  • создать длинную горизонтальную форму

Для всех остальных случаев построения форм следует использовать именно эту библиотеку.

Внешний вид

Внешне все формы класса moodleform выглядят одинаково: это таблица из 2-х столбцов, и некоторого количества строк:

Правила объявления формы

Установка всех элементов формы происходит либо в функции definition() (для статических форм), либо в функции definition_after_data() (для динамических форм).

Описание стандартных методов moodleform

__construct($action, $customdata, $method, $target, $attributes, $editable)

Этот метод вызывается когда вы создаете новый объект формы.

Параметры:

  • $action - какая страница будет обрабатывать данные это формы. Работает аналогично <form action="...">. По умолчанию - адрес той страницы, на которой находится форма.
  • $customdata - дополнительные данные для формы. Эти параметры будут записаны во внутреннюю переменную $this->_customdata доступны из всех внутренних методов формы. Передать можно все что угодно, никаних ограничений нет, тип переменной - на ваше усмотрение, но если вам нужно передать несколько значений, то рекомендуется использовать объект. По умолчанию null.
  • $method - метод формы, GET или POST. По умолчанию POST.
  • $target - только для фреймов. Имя фрейма, обрабатывающего эту форму. Используется крайне редко. По умолчанию null.
  • $attributes - строка атрибутов для тега <form>. Будет добавлена внутрь тега. Разрешены любые атрибуты, предусмотренные стандартом HTML 4.01. По умолчанию пустая строка.
  • $editable - доступна ли форма для редактирования. По умолчанию true (в противном случае все поля в форме будут неактивными).
definition()

Этот абстрактный метод обязательно должен быть переопределен. В нем содержится всё объявление формы.

Существует несколько основных правил, которых следует придерживаться при написании функции definition():

  • Описание каждой формы должно начинаться со ссылки на HTML_QuickForm:
  • Если используются глобальные переменные - их объявление также происходит в начале.
    class myform extends dof_modlib_widgets_form
    {
        function definition()
        {
            // делаем глобальные переменные видимыми
            global $DOF;
            // создаем ссылку на HTML_QuickForm
            $mform =& $this->_form;
            ...
        }
    }
  • При использовании этого метода все данные собираются ДО объявления формы. Сама форма только отображает и отправляет данные.
  • В случае, если необходимо создать динамическую форму следует воспользоваться методом definition_after_data()
definition_after_data()

Этот метод следует использовать в случае, если вам требуется создать динамическую форму, т. е. форму, которая конструируется в зависимости от различных исходных данных. Этот метод вызывается после definition(), отправки данных в форму и set_data(), но до display(). Этот метод работает также как и definition(), но используется для динамических форм, в случаях, когда вам нужно добавить дополнительные поля в форму после отправки данных пользователем.

elementExists($name)

Только для использования внутри definition_after_data(). Проверяет существование элемента с указанным именем в форме.

  • $elementName - имя элемента для проверки
removeElement($name)

Только для использования внутри definition_after_data(). Удалить ранее созданный элемент с указанным именем из формы.

  • $elementName - имя элемента для удаления
getElementValue($name)

Только для использования внутри definition_after_data(). Получить введенное значение из указанного элемента формы.

  • $elementName - имя элемента, значение из которого вы хотите получить
getElement($name)

Только для использования внутри definition_after_data(). Получить объект уже ранее созданного элемента формы для изменения. Используется для того, чтобы записать новые значения в форму после отправки данных пользователем.

Пример 1: Установка нового значения поля после отправки данных пользователем. 

   // получаем новое значение
   $newvalue = 'foo';
   // получаем ранее созданный элемент (например типа "text")
   $element =& $mform->getElement('my_element');
   // устанавливаем в него новое значение
   $element->setValue($newvalue);

Пример 2: установка новых вариантов в поле select после отправки данных пользователем. 

   // создаем новые варианты для элемента
   $options = array();
   $options[-1] = 'Новый вариант1';
   $options[-2] = 'Новый вариант2';
   // получаем ранее созданный элемент типа "select"
   $element =& $mform->getElement('my_element');
   // загружаем новые данные в элемент
   $element->load($options);
display()

Вывести форму на экран. Вызывается непосредственно в том месте, где должна быть форма.

get_data($slashed)

Получить данные формы после всех проверок на стороне клиента и сервера. Данные получаются в виде объекта, именами полей которого являются имена заданных в функции definition() объектов, а значениями - значения полей в форме (по умолчанию или введенные). Любой другой способ получения данных, кроме как через эту функцию, не допускается.

  • $slashed - экранировать кавычки. По умолчанию true.

Пример: 

   $data = $form->get_data();
set_data($data)

Добавить в форму значения по умолчанию для всех перечисленных полей. Значения полей по умолчанию также можно передать в параметре конструктора $customdata, если вы имеете дело с динамической формой. Любой другой способ передачи значений по умолчанию в форму не допускается.

  • $data - объект вида (имя_поля -> значение)

Пример: 

   $data = new Object();
   // заполняем объект значениями по умолчанию
   $data->field1 = 'value1';
   $data->field2 = 'value2';
   // Отправляем значения в форму
   $form->set_data($data);
get_submitted_data($slashed)

Получить данные из формы, к которым еще не применены никакие проверки.

  • $slashed - экранировать кавычки. По умолчанию true.
add_element($type, $name, $description, $attributes, $options)

Добавить элемент в форму. Наиболее часто используемая функция при построении формы. $type - Тип элемента $name - Имя элемента в форме. Только латинские буквы. $description - Описание элемента. Выведется слева от него. $attributes - строка с параметрами, вставляемая в html-тег элемента. $options - массив с дополнительными параметрами. Назначение параметров зависит от типа элемента.

Поведение самой функции add_element также зависит от типа добавляемого элемента. Подробнее об этом - см. раздел Элементы формы.

create_element($type, $name, $description, $attributes, $options)

Этот метод используется для добавления группы элементов. Созданные элементы добавляются в массив. Отличие этой функции от add_element() состоит в том, что add_element() добавляет уже полностью готовый элемент в форму, а create_element() только создает элемент в памяти для последующего добавления. Назначение аргументов этой функции аналогично функции add_element().

Обращение к функции создания элемента происходит по ссылке для ускорения быстродействия.

Способ интерпретации входных параметров и поведение этой функции также зависят от указанного типа элемента. Подробнее об этом - см. раздел Элементы формы.

Пример: 

   // создаем массив
   $objs = array();
   // Создаем элементы формы
   $objs[] =& $mform->createElement('text', 'testname1', 'Пояснение к полю 1');
   $objs[] =& $mform->createElement('text', 'testname2', 'Пояснение к полю 2');
   $objs[] =& $mform->createElement('text', 'testname3', 'Пояснение к полю 3');
   // добавляем элементы в форму
   $grp =& $mform->addElement('group', 'groupname', 'Пояснение для группы элементов', $objs);
insertElementBefore($element, $nameAfter)

Вставляет элемент перед уже ранее добавленным функцией add_element(). Этот метод полезно применять в динамических формах, внутри функции definition() или definition_after_data().

  • $element - Объект вставляемого элемента. Для создания объекта используйте функцию create_element();
  • $nameAfter - Имя элемента перед которым будет вставлен элемент

Помните, что имя каждого элемента в форме должно быть уникальным (кроме элементов типа radio).

Пример: 

   // создаем элемент
   $element =& $mform->createElement('text', 'my_new_text', 'Пояснение к текстовому полю');
   // добавляем его перед уже ранее созданным элементом
   $mform->insertElementBefore($element, 'my_old_text');
addRule($element, $message, $type, $format, $validation, $reset, $force)

Добавить правило для отдельного поля. Эту функцию следует использовать для проверок на стороне клиента и простых проверок на стороне сервера. Для сложных проверок данных (например с использованием обращения к БД) используйте функцию validation().

  • $element - имя элемента, к которому применяется проверка
  • $message - сообщение, в случае если проверка не пройдена
  • $type - тип правила проверки (см. таблицу ниже)
  • $format - дополнительные данные, требующиеся для некоторых проверок. По умолчанию null.
  • $validation - на какой стороне производить проверку. Возможные значения:
    • server - на стороне сервера (по умолчанию)
    • client - на стороне клиента
  • $reset - используется при проверке на стороне клиента. Сбрасывать ли данные в этом поле на значение по умолчанию, если введены неправильные данные? по умолчанию false (не сбрасывать).
  • $force - применять ли проверку даже если проверяемый элемент не существует? По умолчанию false (не применять). Этот параметр используется для проверок в динамических формах.
Таблица типов правил для полей формы
Имя Описание Пример кода
required Обязательное поле 
$mform->addRule('testname','Это поле является обязательным', 'required',null,'client');
minlength Минимальная длина значения в поле. 
$mform->addRule('testname','Слишком короткое значение', 'minlength', 10,'client');
maxlength Максимальная длина значения в поле. 
$mform->addRule('testname','Слишком длинное значение', 'maxlength', 256,'client');
rangelength Проверка длины значения с обеих сторон: например не больше 5 и не меньше 7. Параметры задаются массивом из двух элементов. В данном примере от 111 до 222. 
$mform->addRule('testname','Слишком длинное значение', 'rangelength', array(111, 222),'client');
email Проверка email-адреса 
$mform->addRule('testname','неправильный email', 'email',null,'client');
regex Проверка данных регулярными выражениями. Используется редко, в случае, когда обычных проверок недостаточно.
lettersonly Только латинские буквы. 
$mform->addRule('testname','Ошибка', 'lettersonly', null,'client');
alphanumeric Только латинские буквы и цифры 
$mform->addRule('testname','Ошибка', 'alphanumeric', null,'client');
numeric Целое или дробное число 
$mform->addRule('testname', 'В этом поле разрешены только числа', 'numeric', null, 'client');
nopunctuation В строке не должны присутствовать специальные символы. Список: ()./*^?#!@$%+=,"'><~[]{} 
$mform->addRule('testname', 'В этом поле разрешены только числа', 'nopunctuation', null, 'client');
nonzero Ненулевое значение 
$mform->addRule('testname', 'Только ненулевые значения', 'nonzero', null, 'client');
callback Использовать пользовательскую функцию для проверки данных. Используется крайне редко, если у вас есть сложные проверки - то лучше используйте для них функцию validation().
compare Сравнить два значения. Может использоваться для сравнения чисел и строк. Операторы, используемые для сравнения:
  • == равно
  • != не равно
  • > больше
  • >= больше или равно
  • < меньше
  • <= меньше или равно
 





uploadedfile








maxfilesize

Проверка максимального значения файла для конкретного поля






mimetype

Проверка mime-типа загруженного файла.






filename

Проверка имени файла. Убираются все потенциально опасные символы.





setDefault($elementName, $defaultValue, $slashed)


Установить значение по умолчанию для выбранного элемента.



  •  $elementName - имя элемента
    • 

  •  $defaultValue - значение по умолчанию
    • 

  •  $slashed - в указанном значении экранированы кавычки. По умолчанию false.


is_submitted()


Возвращает true если форма подтверждена, и false в противном случае.



is_cancelled()


Возвращает true если форма отменена, и false в противном случае.



setAdvanced($elementName, $advanced)


Устанавливает поля формы как "дополнительные" - то есть они по умолчанию скрыты, и появляются по щелчку на кнопке "показать дополнительные".



  •  $elementName - имя элемента, который вы хотите пометить как дополнительные
    • 

  •  $advanced - включить/отключить признак дополнительности. Полезно при построении динамических форм: если в зависимости от какого-либо параметра поля должны быть обязательными или необязательными.


setShowAdvanced($showadvancedNow)


Используется как дополнение к методу setAdvanced(). Изменить текст на кнопке с "Показать дополнительные" на что-нибудь более оригинальное.



  •  $showadvancedNow - Тип:строка, текст который вы хотите поместить на кнопке


add_action_buttons($cancel, $submitlabel)


Показывает две кнопки "Сохранить изменения" и "Отменить".



  •  $cancel - показывать ли кнопку "отменить". По умолчанию true.
    • 

  •  $submitlabel - Надпись на кнопке сохранения данных. Значение переменной по умолчанию - null. Надпись по умолчанию "Сохранить изменения".


add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue)


Добавляет переключатель (ссылку или кнопку), контролирующий состояние нескольких элементов типа advcheckbox. 



  •  $groupid - id группы элементов типа advcheckbox, которую контролирует этот переключатель
    • 

  •  $buttontext - текст на кнопке переключателя. По умолчанию "выделеть все".
    • 

  •  $attributes - ассоциативный массив html-атрибутов для тега, описывающего переключатель
    • 

  •  $originalValue - Возможные состояния: 0 или 1. Изначальное состояние всех переключателей контролируемой группы. По умолчанию 0 (все галочки сняты).


setType($elementname, $paramtype)


Отвечает за первичную проверку значений, которые вы получаете из формы. Всегда используйте этот метод при получении данных из формы.



  •  $elementname - имя элемента в форме
    • 

  •  $paramtype - ожидаемый тип получаемых данных


Список возможных значений для $paramtype можно посмотреть в статье константы типов данных



validation($data, $files)


Вызывается автоматически, после отправки данных на сервер. Не вызывайте эту функцию вручную. 

Используется для дополнительной проверки данных на стороне сервера. Все необходимые сложные проверки должны быть проведены именно здесь. Для простых проверок (на тип данных, проверка email-адреса и т. п.) используйте функцию  addRule()



  •  $data - массив вида array('имя_поля' => 'значение') из отправленных данных
    • 

  •  $files - массив загруженных в форму файлов. Имеет вид array('имя_поля' => 'путь_к_временному_файлу')


Должен возвращать массив вида array('имя_поля' => 'текст_сообщения_об_ошибке'). По умолчанию возвращает пустой массив.



disabledIf($elementName, $dependentOn, $condition, $value)


Эта функция используется для того чтобы установить зависимости между полями формы. До тех пор пока в одном по



  •  $elementName - имя зависимого элемента.
    • 

  •  $dependentOn - имя элемента, чье состояние должно быть проверено условием $condition.
    • 

  •  $condition -  по умолчанию 'notchecked'.
    • 

  •  $value - значение, используемое для проверки условия. По умолчанию "1".


Элементы формы


Во всех приведенных примерах переменная $form обозначает ссылку на объект HTML_QuickForm. Подробнее об этом в описании функции definition().

Во всех текстовых полях (кроме кнопок) можно использовать html-теги форматирования.




Таблица типов элементов в moodleform:



Описание

Имя

Код для вставки




Заголовок формы.

Этот заголовок будет говорить об общем содержании данных в форме. Также он используется в случае, когда вам нужно разбить форму на несколько частей.



header


$mform->addElement('header','testname', 'Текст заголовка');





Стандартный html-элемент checkbox.

checkbox


$mform->addElement('checkbox', 'testname', 'Текст_перед_галочкой', 'Текст_после галочки');





Стандартное диалоговое окно загрузки файла.

file


$mform->addElement('file', 'userfile', 'Текст перед окном загрузки файла');





Добавление группы элементов. Для того, чтобы добавить группу элементов, их нужно предварительно создать при помощи функции create_element()

group


    // создаем массив
    $objs = array();
    // Создаем элементы формы
    $objs[] =& $mform->createElement('text', 'testname1', 'Пояснение к полю 1');
    $objs[] =& $mform->createElement('text', 'testname2', 'Пояснение к полю 2');
    $objs[] =& $mform->createElement('text', 'testname3', 'Пояснение к полю 3');
    // добавляем элементы в форму
    $grp =& $mform->addElement('group', 'groupname', 'Пояснение для группы элементов', $objs);





Стандартный html-элемент password

password


mform->addElement('password', 'testname', 'Текст перед окном с паролем');





Тоже самое, что и элемент password, но с дополнительной галочкой "отобразить пароль".

passwordunmask


$mform->addElement('passwordunmask', 'testname', 'Текст перед окном с паролем');





Стандартный html-элемент radio

radio


$mform->addElement('radio', 'testname', 'Текст до переключателем', 'Текст после переключателя', 'Значение');





Стандартный html-элемент select. Массив $choices содержит варианты для оператора select. Значениями массива являются текстовые надписи в списке выбора, а ключами - значения этих вариантов.

select


// создаем массив с вариантами выбора
$choices = array('a' => 'Текст варианта 1', 'b' => 'Текст варианта 2');

// Добавляем элемент формы
$mform->addElement('select', 'testname', 'Пояснение для строки выбора', $choices);







selectgroups









submitlink







Стандартный html-элемент text. Последний параметр - строка html-атрибутов. В данном примере длина поля задана 33 символа.

text


$mform->addElement('text', 'testname', 'Пояснение для текстового поля', ' length="33" ');





Стандартный html-элемент textarea. Значения ширины и высоты задаются в виде массива, последним аргументом.

textarea


$mform->addElement('textarea', 'testname', 'Пояснение:', array('cols'=>80, 'rows'=>20));





Диалоговое окно с выбором даты. Обратите внимание, что при получении данных через get_data() значение этого поля автоматически трансформируется в метку unixtime на 12:00:00 дня выбранной даты. По умолчанию выставляется текущая дата и время. Другое начальное значение может быть задано при помощи функции setDefault().

date_selector


$mform->addElement('date_selector', 'testname', 'Пояснение для поля даты');





Этот элемент аналогичен элементу date_selector, только добавлены параметры часов и минут. Полученные данные также трансформируются в unixtime, но уже для выбранных значений часов и минут. По умолчанию выставляется текущая дата и время. Другое начальное значение может быть задано при помощи функции setDefault().

date_time_selector


$mform->addElement('date_time_selector', 'testname', 'Пояснение для поля даты');





Полноценный html-редактор для редактирования страниц. Его вид (обычный или расширенный) настраивается индивидуально каждым пользователем для себя. Обратите внимание, что в качестве дополнительных параметров можно массивом передать значения ширины и высоты текстового поля.

htmleditor


$mform->addElement('htmleditor', 'testname', 'Пояснение:', array('cols'=>80, 'rows'=>20)





Выбор формата для редактирования сообщения. Полезно использовать вместе со встроенным html-редактором.

format


$mform->addElement('format', 'testname', 'Текст пояснения');





Обычное текстовое поле, не передает никаких данных. Полезно использовать для различных пояснений и отображения текущей информации о каком-либо объекте. Вы также можете использовать этот элемент для разбиения формы на небольшие смысловые блоки, не разрывая рамку формы. Для более явного разбиения используйте элемент header.

static


$mform->addElement('static', 'testname', 'Пояснение:', 'Само текстовое значение');





Стандартный html-элемент hidden, скрытое поле для передачи служебных id, адресов для перенаправления и т. д. Помните о необходимости проверки значений из этого поля.

hidden


$mform->addElement('hidden','testname', 'Значение скрытого поля');





Установить модуль видимым/скрытым. Только для использования внутри Mooodle.

modvisible






Элемент с двумя стандартными radio-кнопками выбора: да и нет.

selectyesno


$mform->addElement('selectyesno', 'testname', 'Текст пояснения');
       // установить значение по умолчанию "да"
       $mform->setDefault('stoponerror', 1);





Шкала выставление оценки за задание. Только для использования внутри Moodle.

modgrade






Кнопка "отменить форму". При нажатии на нее происходит отмена всех произведенных в форме действий.

cancel


$mform->addElement('cancel', 'testname', 'Надпись на кнопке'); 





Элемент аналогичен кнопке типа submit, но при использовании button пропускается проверка данных на стороне клиента.

button


$mform->addElement('button', 'testname', 'Надпись на кнопке');





Выбрать файл из курса. Только для использования внутри курса Moodle.

choosecoursefile






Кнопка отправки данных из формы. Обязательно ставьте ее в конце, иначе все введенные данные нельзя будет отправить. Существует также альтернативный способ задать такую кнопку - это функция get_data()

submit


$mform->addElement('submit', 'testname', 'Текст на кнопке');





Выбрать вопрос из категории. Только при редактировании теста и только внутри курса Moodle.

questioncategory








Элемент checkbox c расширенными функциями - такие элементы можно объединять в группы и устанавливать им контрольный переключатель (делает либо все галочки поставлеными либо снятыми) при помощи функции add_checkbox_controller().

Поскольку таких галочек всегда задается несколько - то целесообразно в указании имени элемента использовать квадратные скобки, чтобы собрать значения всех элементов в один массив. Последним аргументом задается группа, к которой принадлежит созданный элемент. Именно это значение должно быть указано в первом параметре функции add_checkbox_controller().



advcheckbox


$mform->addElement('advcheckbox', 'testname[1]', 'Описание:',
'Текст за галочкой', array('group' => 'id_группы'));

$mform->addElement('advcheckbox', 'testname[2]', 'Описание:', 
'Текст за галочкой', array('group' => 'id_группы'));







Окно с картинкой для использования Capcha проверки. Обратите внимание, что для того чтобы использовать этот элемент вы сначала должны получить уникальный ключ с на сайте http://recaptcha.net/api/getkey.

recaptcha


$mform->addElement('recaptcha', 'testname', 'Текст с пояснением');




Решение наиболее распространенных задач


Установка обязательных полей


Установка обязательных полей происходит при помощи функции addRule().

Пример: 



   // устанавливаем поле "город"
   $mform->addElement('text', 'city', 'Город :', 'maxlength="100" size="30"');
   // делаем поле обязательным
   $mform->addRule('city','Это поле является обязательным', 'required',null,'client');



Установка дополнительных полей


Установка дополнительных полей производится при помощи функции setAdvanced(). Необязательные элементы должны располагаться один за другим. 



Установка проверки на стороне клиента или сервера


По умолчанию все данные из формы подлежат проверке на стороне сервера. Существует возможность добавить проверку на стороне клиента. Не забывайте при этом, что эти данные нужно потом все равно еще раз проверить на стороне сервера, так как всегда существует возможность послать данные в обход формы.



Проверка на стороне сервера


Если вам требуется дополнительная проверка данных на стороне клиента, то используйте стандартный метод  validation(). Любые другие способы проверки данных после формы должны использоваться только в исключительных случаях.



Проверка на стороне клиента


Все малозначимые проверки желательно производить на стороне клиента для увеличения быстродействия приложения. Все проверки на стороне клиента производятся при помощи функции addRule().

В параметре validation обязательно нужно указать 'client'.

Пример:



   // устанавливаем поле "фамилия"
   $mform->addElement('text', 'lastname', 'Фамилия :', 'size="20"');
   // делаем его обязательным
   $mform->addRule('lastname','Это поле является обязательным', 'required',null,'client');



Установка зависимых полей


Ссылки






					

						Источник — «http://docs.deansoffice.ru/wiki/index.php?title=Разработка:moodleQuickForm&oldid=897»