DOF - Вклад участника [ru]

Разработка:modlibs/widgets

2012-03-06T13:34:58Z

Dido86: /* notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') */

{{Infobox_Plugin
| name = widgets
| type = modlibs
}}
== Описание ==
В этом плагине располагаются все виджеты - дополнительные средства визуального оформления интерфейса.
=== Структура папок ===
Для каждого виджета в папке widgets создается отдельная папка с его названием. Внутри этой папки должен лежать файл lib.php, в котором содержится класс виджета. Все дополнительные файлы, относящиеся к этому виджету (если они требуются) - должны лежать в этой же папке.
=== Стандарт именования классов ===
Все классы виджетов должны называться по схеме '''dof_modlib_widgets'''_''<название_виджета>''.
== API ==
=== webform() ===
Инициализировать библиотеку форм.
Этот метод отвечает за подключение библиотеки moodleQuickForm. Если вы хотите использовать moodleQuickForm, то она подключается только при помощи этого метода. Подключение класса moodleQuickForm (или moodleform) напрямую не допускается.
=== form_classname() ===
Аналог метода webform. В настоящее время '''не используется'''. Он оставлен только для совместимости, не используйте его в новых функциях.
=== progressbar($name, $percent, $width, $process, $auto_create) ===
Эта функция пригодится, если вам понадобится вывести прогрессбар - полоску, которая в реальном времени отображает ход выполнения какого-либо долгого процесса.

Возвращает экземпляр класса ''dof_modlib_widgets_progress_bar''.
Параметры:

''$name'' - имя html-элемента. Если прогрессбаров несколько на странице, то имена не должны повторяться.

''$percent'' - начальное процентное значение.

''$width'' - длина в пикселях.

''$process'' - название процесса, который выполняется в текущий момент (загрузка... сохранение... и т. п.)

''$auto_create'' - для этого формата возможны два значения:

true - сразу же отправить html-код прогрессбара в выходной поток.
false - только создать объект, не выводя progressbar.
По умолчанию true.

=== pages_navigation() === - подключает класс pages_navigation. Служит для отображения ссылок на страницы при постраничном выводе списка данных.

''$code'' - код плагина, для которого будут созданы ссылки на страницы.

''$recordscount'' - общее количество записей на всех страницах

''$limitnum'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице)

''$limitfrom'' - начиная с какой записи начать выводить список.

=== notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') ===

Выводит сообщение подтверждение да/нет для дальнейшей работы с пользователем

* $message - сообщение при выборе действия(Пр: Вы действительно хотите это удалить ???)

* $linkyes - url для перехода(redirect) при нажатии на кнопку "ДА"

* $linkno - url для перехода(redirect) при нажатии на кнопку "НЕТ"

* $optionsyes - да возможность показать на уведомления при yes

* $optionsno - да возможность показать на уведомления при no

* $methodyes - метод передачи данных для кноки ДА(по умолчанию "POST")

* $methodno - метод передачи данных для кноки НЕТ(по умолчанию "POST")

=== print_table($table, $return=false) ===

Распечатывает хорошо отформатированную таблицу, использующую текущую тему оформления moodle

Параметры:

''$table'' - стандартный объект со следующими свойствами
* $table->head - Массив заголовков таблицы. (если не задан - выведутся только данные)
* $table->align - Массив, который хранит параметры горизонтального выравнивания текста в колонках
* $table->size - Массив размеров колонок
* $table->wrap - Массив, отвечающий за возможность переноса текста внутри колонки. Возможные значения:
** wrap (переносить)
** nowrap (не переносить)
* $table->data[] - Массив, каждый элемент которого является массивом значений строки таблицы
* $table->width - ширина таблицы в пикселях или процентах
* $table->tablealign - Расположение всей таблицы
* $table->cellpadding - html-параметр cellpadding
* $table->cellspacing - html-параметр cellspacing
* $table->class - html-параметр "class", отвечающий за то, какой
** стиль должен быть сопоставлен этой таблице
* $table->id - html-параметр "id" для использования getElementById()
* $table->rowclass[] - массив названий css-классов для добавления их к специальным рядам
* $table->summary - общее описание содержимого таблицы.

''$return'' - если true, то таблица не будет распечатана, а будет возвращен только ее код

=== print_box_start($classes='generalbox', $ids=' ', $return=false) ===

Распечатывает начало блока (запуск окна с помощью дива)

Параметры:

''$classes'' - имена классов через пробел(по умолчанию generalbox)

''$ids'' - имена id через пробел

''$return'' - возвращает как строку или просто распечатывает его

Возвращает смешанную строку или ничего

=== print_box_end($return=false) ===

Распечатывает конец блока

Параметры:

''$return'' - возвращает как строку или просто распечатывает его

Возвращает смешанную строку или ничего

=== js_init() ===
Подключить js-библиотеку (вместе со стилями) или набор скриптов, по переданному коду. Все виждеты, которые используют javascript должны использовать эту функцию для подключения своих скриптов.

Параметры:

- $code - код библиотеки которую следует подключить

В качестве кода используется собственное название библиотеки внутри FDO, например "jquery". Функция по коду определяет, какой именно список скриптов и стилей нужно подключить.

=== ifield() ===
Получить объект интерактивно редактируемого поля. То есть текст, на который кликаешь, а он становится полем редактирования и через ajax отправляет сохраненные данные.

Параметры:
* $plugintype - тип плагина, который будет предоставлять и сохранять данные
* $plugincode - код плагина, который будет предоставлять и сохранять данные
* $queryname - тип запроса (тип запроса - как правило имя поля)
* $objectid - id объекта, который редактируется
* $type - тип элемента. Это параметра type для тега input. Допустимые значения: text, textarea, select
* $text - текст, который отображается на элементе до редактирования
* $options - массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования. По умолчанию null.

При обращении к этому методу также автоматически подключаются все js-библиотеки, которые нужны для отображения и работы этого элемента, поэтому его следует вызывать до вывода заголовка (print_header)

=== save_ifield() ===
Сохранить данные при inline-редактировании. Сохраняет одно поле. Ищет в переданном плагине функцию '''widgets_save_field''', и передает в нее тип запроса ($querytype), id объекта ($objectid) и новое значение поля ($data). Если такой функции нет - возвращает ошибку.

Функция '''widgets_save_field''' должна вернуть либо новое, измененное значение поля, либо html-код ошибки.

* $plugintype - тип плагина, который отвечает за сохранение поля
* $plugincode - код плагина, который отвечает за редактирование поля
* $querytype - уникальный код запроса внутри плагина. Как правило - имя сохраняемого поля
* $objectid - id объекта, поля которого редактируются
* $data - данные в формате json (или просто строка), пришедшие из формы редактирования объекта.

Возвращает новое, обновленное значение параметра из базы, или html-код ошибки.

=== load_ifield() ===
Загрузить данные для inline-редактирования поля. Этот метод вызывается непосредственно перед редактированием поля, загружая значения из базы, для того чтобы пользователю, который редактирует данные, предоставлялась максимально актуальная информация. Ищет в плагине функцию '''widgets_load_field''' , и передает в нее название поля ($querytype), id объекта ($objectid) и новое значение поля ($data). Если такой функции нет - возвращает ошибку.

Функция '''widgets_load_field''' должна вернуть либо значение поля, либо html-код ошибки.

* $plugintype - тип плагина, который отвечает за редактироване поля
* $plugincode - код плагина, который отвечает за редактироване поля
* $fieldname - поле объекта, которое нужно запросить
* $objectid - id объекта, который редактируется
* $data - дополнительные данные для загрузки объекта

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

== Дополнительные классы ==
=== dof_modlib_widgets_progress_bar ===
* '''__construct'''($name, $percent, $width, $process, $auto_create)
Параметры:

''$name'' - имя html-элемента. Если прогрессбаров несколько на странице, то имена не должны повторяться.

''$percent'' - начальное процентное значение.

''$width'' - длина в пикселях.

''$process'' - название процесса, который выполняется в текущий момент (загрузка... сохранение... и т. п.)

''$auto_create'' - для этого формата возможны два значения:

true - сразу же отправить html-код прогрессбара в выходной поток.
false - только создать объект, не выводя progressbar.
По умолчанию true.
* '''create'''() - вывести html-код прогрессбара в браузер. Эту функцию не нужно использовать, в случае если в конструкторе $auto_create стоит true.
* '''set_name'''($name) - установить имя html-элемента, которым является прогрессбар. Внутренний метод, вызывается из конструктора.
* '''set_percent'''($percent) - установить начальное процентное значение для полоски прогрессбара.
$percent - количество начальных процентов, от 0 до 100.
* '''set_percent_adv'''($cur_amount,$max_amount) - увеличить полоску прогрессбара. Полоска увеличивается в зависимости от того, сколько задач уже выполнено, а сколько еще осталось.

''$cur_amount'' - количество уже выполненных задач

''$max_amount'' - общее количество задач, которое надо выполнить.
* '''set_width'''($width) - установить длину прогрессбара в пикселях. Внутренний метод, используется из конструктора.

=== dof_modlib_widgets_form ===
Класс, наследующий moodleform. Имеет собственные методы, предназначенные для работы с нашими модулями Подробнее об использовании moodleQuickForm можно прочитать в разделе [[Разработка:Стандарт_кодирования#Работа с moodleQuickForm|Работа с moodleQuickForm]].

==== dof_get_select_values() ====

Получить массив, пригодный для составления элементов select и hierselect.

''Параметры''
* $records - массив записей из storage. Ожидаемый формат данных - массив объектов. По умолчанию false.
* $firstelm - (по умолчанию - true) задать первый элемент списка. Возможные значения:
** true - нужен стандартый первый элемент array(0 => '--- Выбрать ---')
** false - первый элемент не нужен
** массив в формате "ключ"=>"значение" из одного, или нескольких элементов, которые нужно добавить в начало списка
* $key - какое поле БД использовать в качестве ключа (это значение отправится формой). По умолчанию 'id'
* $namefields - одно или несколько полей, которые будут видны пользователю в списке. Каждое последующее поле после первого будет заключено в квадратные скобки. По умолчанию 'name'. Формат:
** строка: если отобразить нужно только одно поле
** массив, с названиями полей - если полей нужно несколько. Поля выведутся именно в том порядке, в котором вы их указали

''Возвращаемые значения:''
* array - массив для составления select-элемента
* bool - false в случае ошибки. Возможные ошибки:
** В переданном списке у объектов нет нужных полей
** Для ключа массива есть неуникальные значения

=== dof_modlib_widgets_pages_navigation ===
* '''__construct'''($dof, $code, $count, $limitnum=NULL, $limitfrom) - конструктор класса. Осуществляет все проверки данных.
** ''$dof'' - объект класса [[Разработка:lib/dof.php|dof_control]]
** ''$code'' - код плагина, для которого будут созданы ссылки на страницы.
** ''$count'' - общее количество записей на всех страницах
** ''$limitnum'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице).
** ''$limitfrom'' - начиная с какой записи начать выводить список.
* '''get_navpages_list'''($adds, $vars) - Возвращает html-строку навигации, разбивая ленту таблицы или списка на страницы. Нумерация страница всегда начинается с единицы
** ''$adds'' - дополнительный путь внутри плагина, и список дополнительных параметров для ссылки в виде строки
** ''$vars'' - список дополнительных параметров для ссылки в виде массива в формате '' "ключ" => "значение" ''
* '''get_page_link'''($pagenum, $limitfrom, $adds, $vars) - Возвращает ссылку на страницу или страницу без ссылки, если она является текущей.
** $pagenum - номер страницы
** $limitfrom - номер записи, с которой начинается просмотр
** $adds - дополнительный путь внутри плагина, и список дополнительных параметров для ссылки в виде строки
** $vars - список дополнительных параметров для ссылки в виде массива в формате '' "ключ" => "значение" ''
* '''get_current_page'''() - Получить номер страницы по номеру текущей записи, и количеству записей на странице
* '''get_total_pages'''() - Возвращает общее количество страниц для отображения
* '''get_current_limitfrom'''() - Возвращает исходный параметр номера записи, с которого начинается просмотр
* '''get_current_limitnum'''() - Возвращает исходный параметр минимального количества записей на странице

=== dof_modlib_widgets_addremove ===
Класс для составления стандартного элемента "добавить\удалить". Элемент представляет собой двусторонний список с двумя html-элементами Select. Используется для автоматизации процесса добавления и удаления элементов из какой-либо категории или группы. Позволяет одновременно передавать несколько элементов.
* '''__construct'''($DOF, $action='', $formid='dof_modlib_widgets_addremove') - конструктор класса.
** $DOF объект класса dof_control
** $action - ссылка на страницу-обработчик формы. По умолчанию - эта же страница.
** $formid - id html-элемента на странице. Используется для скрипта, который делает кнопки "добавить" или "удалить" неактивными, в зависимости от того, какое из полей select выбрано.
* '''set_default_strings'''($values)
* '''set_add_list'''($options, $extradata=null)
* '''set_remove_list'''($options, $extradata=null)
* '''set_complex_add_list'''($options)
* '''set_complex_remove_list'''($options)
* '''check_add_remove_array'''($data) - проверить пришедший из формы массив элементов для добавления или удаления.
** $data - массив элементов, пришедший из $_POST
** Возвращаемое значение: (array) - массив числовых значений идентификаторов.
* '''print_html'''() - распечатать html-код элемента.
* '''get_html'''() - получить html-код элемента для последующей распечатки.
* '''assemble_templater_data'''() - Внутренний метод.
* '''get_complex_options_template_data'''($groups, $type) - Внутренний метод.
* '''get_simple_options_template_data'''($options, $extradata=null) - Внутренний метод.
* '''get_search_default_strings'''() - Внутренний метод.
* '''get_form_default_strings'''() - Внутренний метод.

=== dof_modlib_widgets_ifield ===
Класс, отвечающий за элемент inline-редактирования. Создает элемент, который при помощи AJAX-запросов

==== __construct() ====

Параметры
* $dof - объект класса dof_control
* $plugintype - тип плагина, который будет предоставлять и сохранять данные
* $plugincode - код плагина, который будет предоставлять и сохранять данные
* $queryname - тип запроса (тип запроса - как правило имя поля)
* $objectid - id объекта, который редактируется
* $type - тип элемента. Это параметра type для тега input. Допустимые значения: text, textarea, select
* $text - текст, который отображается на элементе до редактирования
* $options - массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования. По умолчанию null.

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

==== get_html() ====
Получить html-код элемента. После создания объекта этот метод можно вызывать несколько раз, каждый раз указывая новый id. Все нужные параметры (текст скрипта, и т. п.) будут пересчитаны автоматически.

Параметры
* $objectid - id редактируемого объекта
* $text - текст, который отображается вместо элемента, пока не нажата кнопка "редактировать". Разрешено html-форматирование
* $options - Массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования.

==== display() ====
Вывести элемент. После создания объекта этот метод можно вызывать несколько раз, каждый раз указывая новый id. Все нужные параметры (текст скрипта, и т. п.) будут пересчитаны автоматически.

Параметры
* $objectid - id редактируемого объекта
* $text - текст, который отображается вместо элемента, пока не нажата кнопка "редактировать". Разрешено html-форматирование
* $options - Массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования.

==== set_options() ====
Метод для установки параметров класса вручную. Используется в том случае, когда всех приведенных выше методов недостаточно.

Параметры:
* $options - массив свойств класса в формате ключ-значение.

== Примеры кода ==
==== Стандартные формы ====
Здесь будут приведены примеры работы с классов dof_modlib_widgets_form. Этот класс наследует находящийся в moodle класс moodleform. Подробнее о нем можно посмотреть в разделе: [[Разработка:moodleQuickForm]]
===== Подключение библиотеки форм =====
$DOF->modlib('widgets')->'''webform'''();
===== Получение массива нужного формата для составления select-элементов =====

''// получаем список всех учебных периодов из нашей таблицы "ages"
// Отсортированных по названию''
$ages = $this->dof->storage('ages')->get_list(null, null, "name ASC")
''// задаем массив из нескольких собственных первых элементов для списка:
// они добавятся в начало''
$firstelms = array(54 => 'Элемент 1', 'abc' => 'Элемент 2');
''// указываем, какое поле из массива объектов нужно брать в качестве ключа
// (значения должны быть уникальными!)''
$idfield = 'id';
''// указываем, какие поля БД нужно выводить пользователю''
$showfields = array('name', 'eduweeks');
''// получаем массив нужной структуры для составления select-элемента.''
$selectdata = $this->'''dof_get_select_values'''($ages, $firstelms, $idfield, $showfields);

==== Использование прогрессбара ====

1. Устанавливаем параметры
$name = 'pbar'; ''// имя html-элемента, только латинские буквы''
$percent = 1; ''// начинаем с отметки 1%''
$width = 200; ''// длинна полоски 200 пикселей''
$process = 'Идет сохранение...'; ''// какой процесс происходит''
$auto_create = true; ''// вывести прогрессбар сразу же после создания объекта''
2. Создаем нужный объект
$progressbar = $DOF->modlib('widgets')->'''progressbar'''($name, $percent, $width, $process, $auto_create)
3. Вставляем прогрессбар внутрь цикла с выполняемым процессом
for ($i=1; $i<=333; $i++)
{
''// номер текущей выполняемой задачи''
$cur_task = $i;
''// общее количество задач, которое надо выполнить их количество можно менять в ходе выполнения процесса''
''(например, если сразу неясно сколько точно шагов будет у цикла)''
$num_tasks = 333;
''// внутри цикла производим все трудоемкие операции...''

...

sleep(0.1);''// '''для теста''': чтобы было видно как ползет полоска''
''// после того как проведены все операции увеличиваем длину полоски на чуть-чуть''
$progressbar->'''set_percent_adv'''($cur_task,$num_tasks);
}

Разработка:modlibs/widgets

2012-03-06T13:30:34Z

Dido86: /* notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') */

{{Infobox_Plugin
| name = widgets
| type = modlibs
}}
== Описание ==
В этом плагине располагаются все виджеты - дополнительные средства визуального оформления интерфейса.
=== Структура папок ===
Для каждого виджета в папке widgets создается отдельная папка с его названием. Внутри этой папки должен лежать файл lib.php, в котором содержится класс виджета. Все дополнительные файлы, относящиеся к этому виджету (если они требуются) - должны лежать в этой же папке.
=== Стандарт именования классов ===
Все классы виджетов должны называться по схеме '''dof_modlib_widgets'''_''<название_виджета>''.
== API ==
=== webform() ===
Инициализировать библиотеку форм.
Этот метод отвечает за подключение библиотеки moodleQuickForm. Если вы хотите использовать moodleQuickForm, то она подключается только при помощи этого метода. Подключение класса moodleQuickForm (или moodleform) напрямую не допускается.
=== form_classname() ===
Аналог метода webform. В настоящее время '''не используется'''. Он оставлен только для совместимости, не используйте его в новых функциях.
=== progressbar($name, $percent, $width, $process, $auto_create) ===
Эта функция пригодится, если вам понадобится вывести прогрессбар - полоску, которая в реальном времени отображает ход выполнения какого-либо долгого процесса.

Возвращает экземпляр класса ''dof_modlib_widgets_progress_bar''.
Параметры:

''$name'' - имя html-элемента. Если прогрессбаров несколько на странице, то имена не должны повторяться.

''$percent'' - начальное процентное значение.

''$width'' - длина в пикселях.

''$process'' - название процесса, который выполняется в текущий момент (загрузка... сохранение... и т. п.)

''$auto_create'' - для этого формата возможны два значения:

true - сразу же отправить html-код прогрессбара в выходной поток.
false - только создать объект, не выводя progressbar.
По умолчанию true.

=== pages_navigation() === - подключает класс pages_navigation. Служит для отображения ссылок на страницы при постраничном выводе списка данных.

''$code'' - код плагина, для которого будут созданы ссылки на страницы.

''$recordscount'' - общее количество записей на всех страницах

''$limitnum'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице)

''$limitfrom'' - начиная с какой записи начать выводить список.

=== notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') ===

Выводит сообщение подтверждение да/нет для дальнейшей работы с пользователем

* $message - сообщение при выборе действия(Пр: Вы действительно хотите это удалить ???)

* $linkyes - url для перехода(redirect) при нажатии на кнопку "ДА"

* $linkno - url для перехода(redirect) при нажатии на кнопку "НЕТ"

* $optionsyes - начиная с какой записи начать выводить список.

* $optionsno - общее количество записей на всех страницах

* $methodyes - метод передачи данных для кноки ДА(по умолчанию "POST")

* $methodno - метод передачи данных для кноки НЕТ(по умолчанию "POST")

=== print_table($table, $return=false) ===

Распечатывает хорошо отформатированную таблицу, использующую текущую тему оформления moodle

Параметры:

''$table'' - стандартный объект со следующими свойствами
* $table->head - Массив заголовков таблицы. (если не задан - выведутся только данные)
* $table->align - Массив, который хранит параметры горизонтального выравнивания текста в колонках
* $table->size - Массив размеров колонок
* $table->wrap - Массив, отвечающий за возможность переноса текста внутри колонки. Возможные значения:
** wrap (переносить)
** nowrap (не переносить)
* $table->data[] - Массив, каждый элемент которого является массивом значений строки таблицы
* $table->width - ширина таблицы в пикселях или процентах
* $table->tablealign - Расположение всей таблицы
* $table->cellpadding - html-параметр cellpadding
* $table->cellspacing - html-параметр cellspacing
* $table->class - html-параметр "class", отвечающий за то, какой
** стиль должен быть сопоставлен этой таблице
* $table->id - html-параметр "id" для использования getElementById()
* $table->rowclass[] - массив названий css-классов для добавления их к специальным рядам
* $table->summary - общее описание содержимого таблицы.

''$return'' - если true, то таблица не будет распечатана, а будет возвращен только ее код

=== print_box_start($classes='generalbox', $ids=' ', $return=false) ===

Распечатывает начало блока (запуск окна с помощью дива)

Параметры:

''$classes'' - имена классов через пробел(по умолчанию generalbox)

''$ids'' - имена id через пробел

''$return'' - возвращает как строку или просто распечатывает его

Возвращает смешанную строку или ничего

=== print_box_end($return=false) ===

Распечатывает конец блока

Параметры:

''$return'' - возвращает как строку или просто распечатывает его

Возвращает смешанную строку или ничего

=== js_init() ===
Подключить js-библиотеку (вместе со стилями) или набор скриптов, по переданному коду. Все виждеты, которые используют javascript должны использовать эту функцию для подключения своих скриптов.

Параметры:

- $code - код библиотеки которую следует подключить

В качестве кода используется собственное название библиотеки внутри FDO, например "jquery". Функция по коду определяет, какой именно список скриптов и стилей нужно подключить.

=== ifield() ===
Получить объект интерактивно редактируемого поля. То есть текст, на который кликаешь, а он становится полем редактирования и через ajax отправляет сохраненные данные.

Параметры:
* $plugintype - тип плагина, который будет предоставлять и сохранять данные
* $plugincode - код плагина, который будет предоставлять и сохранять данные
* $queryname - тип запроса (тип запроса - как правило имя поля)
* $objectid - id объекта, который редактируется
* $type - тип элемента. Это параметра type для тега input. Допустимые значения: text, textarea, select
* $text - текст, который отображается на элементе до редактирования
* $options - массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования. По умолчанию null.

При обращении к этому методу также автоматически подключаются все js-библиотеки, которые нужны для отображения и работы этого элемента, поэтому его следует вызывать до вывода заголовка (print_header)

=== save_ifield() ===
Сохранить данные при inline-редактировании. Сохраняет одно поле. Ищет в переданном плагине функцию '''widgets_save_field''', и передает в нее тип запроса ($querytype), id объекта ($objectid) и новое значение поля ($data). Если такой функции нет - возвращает ошибку.

Функция '''widgets_save_field''' должна вернуть либо новое, измененное значение поля, либо html-код ошибки.

* $plugintype - тип плагина, который отвечает за сохранение поля
* $plugincode - код плагина, который отвечает за редактирование поля
* $querytype - уникальный код запроса внутри плагина. Как правило - имя сохраняемого поля
* $objectid - id объекта, поля которого редактируются
* $data - данные в формате json (или просто строка), пришедшие из формы редактирования объекта.

Возвращает новое, обновленное значение параметра из базы, или html-код ошибки.

=== load_ifield() ===
Загрузить данные для inline-редактирования поля. Этот метод вызывается непосредственно перед редактированием поля, загружая значения из базы, для того чтобы пользователю, который редактирует данные, предоставлялась максимально актуальная информация. Ищет в плагине функцию '''widgets_load_field''' , и передает в нее название поля ($querytype), id объекта ($objectid) и новое значение поля ($data). Если такой функции нет - возвращает ошибку.

Функция '''widgets_load_field''' должна вернуть либо значение поля, либо html-код ошибки.

* $plugintype - тип плагина, который отвечает за редактироване поля
* $plugincode - код плагина, который отвечает за редактироване поля
* $fieldname - поле объекта, которое нужно запросить
* $objectid - id объекта, который редактируется
* $data - дополнительные данные для загрузки объекта

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

== Дополнительные классы ==
=== dof_modlib_widgets_progress_bar ===
* '''__construct'''($name, $percent, $width, $process, $auto_create)
Параметры:

''$name'' - имя html-элемента. Если прогрессбаров несколько на странице, то имена не должны повторяться.

''$percent'' - начальное процентное значение.

''$width'' - длина в пикселях.

''$process'' - название процесса, который выполняется в текущий момент (загрузка... сохранение... и т. п.)

''$auto_create'' - для этого формата возможны два значения:

true - сразу же отправить html-код прогрессбара в выходной поток.
false - только создать объект, не выводя progressbar.
По умолчанию true.
* '''create'''() - вывести html-код прогрессбара в браузер. Эту функцию не нужно использовать, в случае если в конструкторе $auto_create стоит true.
* '''set_name'''($name) - установить имя html-элемента, которым является прогрессбар. Внутренний метод, вызывается из конструктора.
* '''set_percent'''($percent) - установить начальное процентное значение для полоски прогрессбара.
$percent - количество начальных процентов, от 0 до 100.
* '''set_percent_adv'''($cur_amount,$max_amount) - увеличить полоску прогрессбара. Полоска увеличивается в зависимости от того, сколько задач уже выполнено, а сколько еще осталось.

''$cur_amount'' - количество уже выполненных задач

''$max_amount'' - общее количество задач, которое надо выполнить.
* '''set_width'''($width) - установить длину прогрессбара в пикселях. Внутренний метод, используется из конструктора.

=== dof_modlib_widgets_form ===
Класс, наследующий moodleform. Имеет собственные методы, предназначенные для работы с нашими модулями Подробнее об использовании moodleQuickForm можно прочитать в разделе [[Разработка:Стандарт_кодирования#Работа с moodleQuickForm|Работа с moodleQuickForm]].

==== dof_get_select_values() ====

Получить массив, пригодный для составления элементов select и hierselect.

''Параметры''
* $records - массив записей из storage. Ожидаемый формат данных - массив объектов. По умолчанию false.
* $firstelm - (по умолчанию - true) задать первый элемент списка. Возможные значения:
** true - нужен стандартый первый элемент array(0 => '--- Выбрать ---')
** false - первый элемент не нужен
** массив в формате "ключ"=>"значение" из одного, или нескольких элементов, которые нужно добавить в начало списка
* $key - какое поле БД использовать в качестве ключа (это значение отправится формой). По умолчанию 'id'
* $namefields - одно или несколько полей, которые будут видны пользователю в списке. Каждое последующее поле после первого будет заключено в квадратные скобки. По умолчанию 'name'. Формат:
** строка: если отобразить нужно только одно поле
** массив, с названиями полей - если полей нужно несколько. Поля выведутся именно в том порядке, в котором вы их указали

''Возвращаемые значения:''
* array - массив для составления select-элемента
* bool - false в случае ошибки. Возможные ошибки:
** В переданном списке у объектов нет нужных полей
** Для ключа массива есть неуникальные значения

=== dof_modlib_widgets_pages_navigation ===
* '''__construct'''($dof, $code, $count, $limitnum=NULL, $limitfrom) - конструктор класса. Осуществляет все проверки данных.
** ''$dof'' - объект класса [[Разработка:lib/dof.php|dof_control]]
** ''$code'' - код плагина, для которого будут созданы ссылки на страницы.
** ''$count'' - общее количество записей на всех страницах
** ''$limitnum'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице).
** ''$limitfrom'' - начиная с какой записи начать выводить список.
* '''get_navpages_list'''($adds, $vars) - Возвращает html-строку навигации, разбивая ленту таблицы или списка на страницы. Нумерация страница всегда начинается с единицы
** ''$adds'' - дополнительный путь внутри плагина, и список дополнительных параметров для ссылки в виде строки
** ''$vars'' - список дополнительных параметров для ссылки в виде массива в формате '' "ключ" => "значение" ''
* '''get_page_link'''($pagenum, $limitfrom, $adds, $vars) - Возвращает ссылку на страницу или страницу без ссылки, если она является текущей.
** $pagenum - номер страницы
** $limitfrom - номер записи, с которой начинается просмотр
** $adds - дополнительный путь внутри плагина, и список дополнительных параметров для ссылки в виде строки
** $vars - список дополнительных параметров для ссылки в виде массива в формате '' "ключ" => "значение" ''
* '''get_current_page'''() - Получить номер страницы по номеру текущей записи, и количеству записей на странице
* '''get_total_pages'''() - Возвращает общее количество страниц для отображения
* '''get_current_limitfrom'''() - Возвращает исходный параметр номера записи, с которого начинается просмотр
* '''get_current_limitnum'''() - Возвращает исходный параметр минимального количества записей на странице

=== dof_modlib_widgets_addremove ===
Класс для составления стандартного элемента "добавить\удалить". Элемент представляет собой двусторонний список с двумя html-элементами Select. Используется для автоматизации процесса добавления и удаления элементов из какой-либо категории или группы. Позволяет одновременно передавать несколько элементов.
* '''__construct'''($DOF, $action='', $formid='dof_modlib_widgets_addremove') - конструктор класса.
** $DOF объект класса dof_control
** $action - ссылка на страницу-обработчик формы. По умолчанию - эта же страница.
** $formid - id html-элемента на странице. Используется для скрипта, который делает кнопки "добавить" или "удалить" неактивными, в зависимости от того, какое из полей select выбрано.
* '''set_default_strings'''($values)
* '''set_add_list'''($options, $extradata=null)
* '''set_remove_list'''($options, $extradata=null)
* '''set_complex_add_list'''($options)
* '''set_complex_remove_list'''($options)
* '''check_add_remove_array'''($data) - проверить пришедший из формы массив элементов для добавления или удаления.
** $data - массив элементов, пришедший из $_POST
** Возвращаемое значение: (array) - массив числовых значений идентификаторов.
* '''print_html'''() - распечатать html-код элемента.
* '''get_html'''() - получить html-код элемента для последующей распечатки.
* '''assemble_templater_data'''() - Внутренний метод.
* '''get_complex_options_template_data'''($groups, $type) - Внутренний метод.
* '''get_simple_options_template_data'''($options, $extradata=null) - Внутренний метод.
* '''get_search_default_strings'''() - Внутренний метод.
* '''get_form_default_strings'''() - Внутренний метод.

=== dof_modlib_widgets_ifield ===
Класс, отвечающий за элемент inline-редактирования. Создает элемент, который при помощи AJAX-запросов

==== __construct() ====

Параметры
* $dof - объект класса dof_control
* $plugintype - тип плагина, который будет предоставлять и сохранять данные
* $plugincode - код плагина, который будет предоставлять и сохранять данные
* $queryname - тип запроса (тип запроса - как правило имя поля)
* $objectid - id объекта, который редактируется
* $type - тип элемента. Это параметра type для тега input. Допустимые значения: text, textarea, select
* $text - текст, который отображается на элементе до редактирования
* $options - массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования. По умолчанию null.

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

==== get_html() ====
Получить html-код элемента. После создания объекта этот метод можно вызывать несколько раз, каждый раз указывая новый id. Все нужные параметры (текст скрипта, и т. п.) будут пересчитаны автоматически.

Параметры
* $objectid - id редактируемого объекта
* $text - текст, который отображается вместо элемента, пока не нажата кнопка "редактировать". Разрешено html-форматирование
* $options - Массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования.

==== display() ====
Вывести элемент. После создания объекта этот метод можно вызывать несколько раз, каждый раз указывая новый id. Все нужные параметры (текст скрипта, и т. п.) будут пересчитаны автоматически.

Параметры
* $objectid - id редактируемого объекта
* $text - текст, который отображается вместо элемента, пока не нажата кнопка "редактировать". Разрешено html-форматирование
* $options - Массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования.

==== set_options() ====
Метод для установки параметров класса вручную. Используется в том случае, когда всех приведенных выше методов недостаточно.

Параметры:
* $options - массив свойств класса в формате ключ-значение.

== Примеры кода ==
==== Стандартные формы ====
Здесь будут приведены примеры работы с классов dof_modlib_widgets_form. Этот класс наследует находящийся в moodle класс moodleform. Подробнее о нем можно посмотреть в разделе: [[Разработка:moodleQuickForm]]
===== Подключение библиотеки форм =====
$DOF->modlib('widgets')->'''webform'''();
===== Получение массива нужного формата для составления select-элементов =====

''// получаем список всех учебных периодов из нашей таблицы "ages"
// Отсортированных по названию''
$ages = $this->dof->storage('ages')->get_list(null, null, "name ASC")
''// задаем массив из нескольких собственных первых элементов для списка:
// они добавятся в начало''
$firstelms = array(54 => 'Элемент 1', 'abc' => 'Элемент 2');
''// указываем, какое поле из массива объектов нужно брать в качестве ключа
// (значения должны быть уникальными!)''
$idfield = 'id';
''// указываем, какие поля БД нужно выводить пользователю''
$showfields = array('name', 'eduweeks');
''// получаем массив нужной структуры для составления select-элемента.''
$selectdata = $this->'''dof_get_select_values'''($ages, $firstelms, $idfield, $showfields);

==== Использование прогрессбара ====

1. Устанавливаем параметры
$name = 'pbar'; ''// имя html-элемента, только латинские буквы''
$percent = 1; ''// начинаем с отметки 1%''
$width = 200; ''// длинна полоски 200 пикселей''
$process = 'Идет сохранение...'; ''// какой процесс происходит''
$auto_create = true; ''// вывести прогрессбар сразу же после создания объекта''
2. Создаем нужный объект
$progressbar = $DOF->modlib('widgets')->'''progressbar'''($name, $percent, $width, $process, $auto_create)
3. Вставляем прогрессбар внутрь цикла с выполняемым процессом
for ($i=1; $i<=333; $i++)
{
''// номер текущей выполняемой задачи''
$cur_task = $i;
''// общее количество задач, которое надо выполнить их количество можно менять в ходе выполнения процесса''
''(например, если сразу неясно сколько точно шагов будет у цикла)''
$num_tasks = 333;
''// внутри цикла производим все трудоемкие операции...''

...

sleep(0.1);''// '''для теста''': чтобы было видно как ползет полоска''
''// после того как проведены все операции увеличиваем длину полоски на чуть-чуть''
$progressbar->'''set_percent_adv'''($cur_task,$num_tasks);
}

Разработка:modlibs/widgets

2012-03-06T13:29:11Z

Dido86: /* notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') */

{{Infobox_Plugin
| name = widgets
| type = modlibs
}}
== Описание ==
В этом плагине располагаются все виджеты - дополнительные средства визуального оформления интерфейса.
=== Структура папок ===
Для каждого виджета в папке widgets создается отдельная папка с его названием. Внутри этой папки должен лежать файл lib.php, в котором содержится класс виджета. Все дополнительные файлы, относящиеся к этому виджету (если они требуются) - должны лежать в этой же папке.
=== Стандарт именования классов ===
Все классы виджетов должны называться по схеме '''dof_modlib_widgets'''_''<название_виджета>''.
== API ==
=== webform() ===
Инициализировать библиотеку форм.
Этот метод отвечает за подключение библиотеки moodleQuickForm. Если вы хотите использовать moodleQuickForm, то она подключается только при помощи этого метода. Подключение класса moodleQuickForm (или moodleform) напрямую не допускается.
=== form_classname() ===
Аналог метода webform. В настоящее время '''не используется'''. Он оставлен только для совместимости, не используйте его в новых функциях.
=== progressbar($name, $percent, $width, $process, $auto_create) ===
Эта функция пригодится, если вам понадобится вывести прогрессбар - полоску, которая в реальном времени отображает ход выполнения какого-либо долгого процесса.

Возвращает экземпляр класса ''dof_modlib_widgets_progress_bar''.
Параметры:

''$name'' - имя html-элемента. Если прогрессбаров несколько на странице, то имена не должны повторяться.

''$percent'' - начальное процентное значение.

''$width'' - длина в пикселях.

''$process'' - название процесса, который выполняется в текущий момент (загрузка... сохранение... и т. п.)

''$auto_create'' - для этого формата возможны два значения:

true - сразу же отправить html-код прогрессбара в выходной поток.
false - только создать объект, не выводя progressbar.
По умолчанию true.

=== pages_navigation() === - подключает класс pages_navigation. Служит для отображения ссылок на страницы при постраничном выводе списка данных.

''$code'' - код плагина, для которого будут созданы ссылки на страницы.

''$recordscount'' - общее количество записей на всех страницах

''$limitnum'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице)

''$limitfrom'' - начиная с какой записи начать выводить список.

=== notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') ===

Выводит сообщение подтверждение да/нет для дальнейшей работы с пользователем

''$message'' - сообщение при выборе действия(Пр: Вы действительно хотите это удалить ???)

''$linkyes'' - url для перехода(redirect) при нажатии на кнопку "ДА"

''$linkno'' - url для перехода(redirect) при нажатии на кнопку "НЕТ"

''$optionsyes'' - начиная с какой записи начать выводить список.

''$optionsno'' - общее количество записей на всех страницах

''$methodyes'' - метод передачи данных для кноки ДА(по умолчанию "POST")

''$methodno'' - метод передачи данных для кноки НЕТ(по умолчанию "POST")

=== print_table($table, $return=false) ===

Распечатывает хорошо отформатированную таблицу, использующую текущую тему оформления moodle

Параметры:

''$table'' - стандартный объект со следующими свойствами
* $table->head - Массив заголовков таблицы. (если не задан - выведутся только данные)
* $table->align - Массив, который хранит параметры горизонтального выравнивания текста в колонках
* $table->size - Массив размеров колонок
* $table->wrap - Массив, отвечающий за возможность переноса текста внутри колонки. Возможные значения:
** wrap (переносить)
** nowrap (не переносить)
* $table->data[] - Массив, каждый элемент которого является массивом значений строки таблицы
* $table->width - ширина таблицы в пикселях или процентах
* $table->tablealign - Расположение всей таблицы
* $table->cellpadding - html-параметр cellpadding
* $table->cellspacing - html-параметр cellspacing
* $table->class - html-параметр "class", отвечающий за то, какой
** стиль должен быть сопоставлен этой таблице
* $table->id - html-параметр "id" для использования getElementById()
* $table->rowclass[] - массив названий css-классов для добавления их к специальным рядам
* $table->summary - общее описание содержимого таблицы.

''$return'' - если true, то таблица не будет распечатана, а будет возвращен только ее код

=== print_box_start($classes='generalbox', $ids=' ', $return=false) ===

Распечатывает начало блока (запуск окна с помощью дива)

Параметры:

''$classes'' - имена классов через пробел(по умолчанию generalbox)

''$ids'' - имена id через пробел

''$return'' - возвращает как строку или просто распечатывает его

Возвращает смешанную строку или ничего

=== print_box_end($return=false) ===

Распечатывает конец блока

Параметры:

''$return'' - возвращает как строку или просто распечатывает его

Возвращает смешанную строку или ничего

=== js_init() ===
Подключить js-библиотеку (вместе со стилями) или набор скриптов, по переданному коду. Все виждеты, которые используют javascript должны использовать эту функцию для подключения своих скриптов.

Параметры:

- $code - код библиотеки которую следует подключить

В качестве кода используется собственное название библиотеки внутри FDO, например "jquery". Функция по коду определяет, какой именно список скриптов и стилей нужно подключить.

=== ifield() ===
Получить объект интерактивно редактируемого поля. То есть текст, на который кликаешь, а он становится полем редактирования и через ajax отправляет сохраненные данные.

Параметры:
* $plugintype - тип плагина, который будет предоставлять и сохранять данные
* $plugincode - код плагина, который будет предоставлять и сохранять данные
* $queryname - тип запроса (тип запроса - как правило имя поля)
* $objectid - id объекта, который редактируется
* $type - тип элемента. Это параметра type для тега input. Допустимые значения: text, textarea, select
* $text - текст, который отображается на элементе до редактирования
* $options - массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования. По умолчанию null.

При обращении к этому методу также автоматически подключаются все js-библиотеки, которые нужны для отображения и работы этого элемента, поэтому его следует вызывать до вывода заголовка (print_header)

=== save_ifield() ===
Сохранить данные при inline-редактировании. Сохраняет одно поле. Ищет в переданном плагине функцию '''widgets_save_field''', и передает в нее тип запроса ($querytype), id объекта ($objectid) и новое значение поля ($data). Если такой функции нет - возвращает ошибку.

Функция '''widgets_save_field''' должна вернуть либо новое, измененное значение поля, либо html-код ошибки.

* $plugintype - тип плагина, который отвечает за сохранение поля
* $plugincode - код плагина, который отвечает за редактирование поля
* $querytype - уникальный код запроса внутри плагина. Как правило - имя сохраняемого поля
* $objectid - id объекта, поля которого редактируются
* $data - данные в формате json (или просто строка), пришедшие из формы редактирования объекта.

Возвращает новое, обновленное значение параметра из базы, или html-код ошибки.

=== load_ifield() ===
Загрузить данные для inline-редактирования поля. Этот метод вызывается непосредственно перед редактированием поля, загружая значения из базы, для того чтобы пользователю, который редактирует данные, предоставлялась максимально актуальная информация. Ищет в плагине функцию '''widgets_load_field''' , и передает в нее название поля ($querytype), id объекта ($objectid) и новое значение поля ($data). Если такой функции нет - возвращает ошибку.

Функция '''widgets_load_field''' должна вернуть либо значение поля, либо html-код ошибки.

* $plugintype - тип плагина, который отвечает за редактироване поля
* $plugincode - код плагина, который отвечает за редактироване поля
* $fieldname - поле объекта, которое нужно запросить
* $objectid - id объекта, который редактируется
* $data - дополнительные данные для загрузки объекта

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

== Дополнительные классы ==
=== dof_modlib_widgets_progress_bar ===
* '''__construct'''($name, $percent, $width, $process, $auto_create)
Параметры:

''$name'' - имя html-элемента. Если прогрессбаров несколько на странице, то имена не должны повторяться.

''$percent'' - начальное процентное значение.

''$width'' - длина в пикселях.

''$process'' - название процесса, который выполняется в текущий момент (загрузка... сохранение... и т. п.)

''$auto_create'' - для этого формата возможны два значения:

true - сразу же отправить html-код прогрессбара в выходной поток.
false - только создать объект, не выводя progressbar.
По умолчанию true.
* '''create'''() - вывести html-код прогрессбара в браузер. Эту функцию не нужно использовать, в случае если в конструкторе $auto_create стоит true.
* '''set_name'''($name) - установить имя html-элемента, которым является прогрессбар. Внутренний метод, вызывается из конструктора.
* '''set_percent'''($percent) - установить начальное процентное значение для полоски прогрессбара.
$percent - количество начальных процентов, от 0 до 100.
* '''set_percent_adv'''($cur_amount,$max_amount) - увеличить полоску прогрессбара. Полоска увеличивается в зависимости от того, сколько задач уже выполнено, а сколько еще осталось.

''$cur_amount'' - количество уже выполненных задач

''$max_amount'' - общее количество задач, которое надо выполнить.
* '''set_width'''($width) - установить длину прогрессбара в пикселях. Внутренний метод, используется из конструктора.

=== dof_modlib_widgets_form ===
Класс, наследующий moodleform. Имеет собственные методы, предназначенные для работы с нашими модулями Подробнее об использовании moodleQuickForm можно прочитать в разделе [[Разработка:Стандарт_кодирования#Работа с moodleQuickForm|Работа с moodleQuickForm]].

==== dof_get_select_values() ====

Получить массив, пригодный для составления элементов select и hierselect.

''Параметры''
* $records - массив записей из storage. Ожидаемый формат данных - массив объектов. По умолчанию false.
* $firstelm - (по умолчанию - true) задать первый элемент списка. Возможные значения:
** true - нужен стандартый первый элемент array(0 => '--- Выбрать ---')
** false - первый элемент не нужен
** массив в формате "ключ"=>"значение" из одного, или нескольких элементов, которые нужно добавить в начало списка
* $key - какое поле БД использовать в качестве ключа (это значение отправится формой). По умолчанию 'id'
* $namefields - одно или несколько полей, которые будут видны пользователю в списке. Каждое последующее поле после первого будет заключено в квадратные скобки. По умолчанию 'name'. Формат:
** строка: если отобразить нужно только одно поле
** массив, с названиями полей - если полей нужно несколько. Поля выведутся именно в том порядке, в котором вы их указали

''Возвращаемые значения:''
* array - массив для составления select-элемента
* bool - false в случае ошибки. Возможные ошибки:
** В переданном списке у объектов нет нужных полей
** Для ключа массива есть неуникальные значения

=== dof_modlib_widgets_pages_navigation ===
* '''__construct'''($dof, $code, $count, $limitnum=NULL, $limitfrom) - конструктор класса. Осуществляет все проверки данных.
** ''$dof'' - объект класса [[Разработка:lib/dof.php|dof_control]]
** ''$code'' - код плагина, для которого будут созданы ссылки на страницы.
** ''$count'' - общее количество записей на всех страницах
** ''$limitnum'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице).
** ''$limitfrom'' - начиная с какой записи начать выводить список.
* '''get_navpages_list'''($adds, $vars) - Возвращает html-строку навигации, разбивая ленту таблицы или списка на страницы. Нумерация страница всегда начинается с единицы
** ''$adds'' - дополнительный путь внутри плагина, и список дополнительных параметров для ссылки в виде строки
** ''$vars'' - список дополнительных параметров для ссылки в виде массива в формате '' "ключ" => "значение" ''
* '''get_page_link'''($pagenum, $limitfrom, $adds, $vars) - Возвращает ссылку на страницу или страницу без ссылки, если она является текущей.
** $pagenum - номер страницы
** $limitfrom - номер записи, с которой начинается просмотр
** $adds - дополнительный путь внутри плагина, и список дополнительных параметров для ссылки в виде строки
** $vars - список дополнительных параметров для ссылки в виде массива в формате '' "ключ" => "значение" ''
* '''get_current_page'''() - Получить номер страницы по номеру текущей записи, и количеству записей на странице
* '''get_total_pages'''() - Возвращает общее количество страниц для отображения
* '''get_current_limitfrom'''() - Возвращает исходный параметр номера записи, с которого начинается просмотр
* '''get_current_limitnum'''() - Возвращает исходный параметр минимального количества записей на странице

=== dof_modlib_widgets_addremove ===
Класс для составления стандартного элемента "добавить\удалить". Элемент представляет собой двусторонний список с двумя html-элементами Select. Используется для автоматизации процесса добавления и удаления элементов из какой-либо категории или группы. Позволяет одновременно передавать несколько элементов.
* '''__construct'''($DOF, $action='', $formid='dof_modlib_widgets_addremove') - конструктор класса.
** $DOF объект класса dof_control
** $action - ссылка на страницу-обработчик формы. По умолчанию - эта же страница.
** $formid - id html-элемента на странице. Используется для скрипта, который делает кнопки "добавить" или "удалить" неактивными, в зависимости от того, какое из полей select выбрано.
* '''set_default_strings'''($values)
* '''set_add_list'''($options, $extradata=null)
* '''set_remove_list'''($options, $extradata=null)
* '''set_complex_add_list'''($options)
* '''set_complex_remove_list'''($options)
* '''check_add_remove_array'''($data) - проверить пришедший из формы массив элементов для добавления или удаления.
** $data - массив элементов, пришедший из $_POST
** Возвращаемое значение: (array) - массив числовых значений идентификаторов.
* '''print_html'''() - распечатать html-код элемента.
* '''get_html'''() - получить html-код элемента для последующей распечатки.
* '''assemble_templater_data'''() - Внутренний метод.
* '''get_complex_options_template_data'''($groups, $type) - Внутренний метод.
* '''get_simple_options_template_data'''($options, $extradata=null) - Внутренний метод.
* '''get_search_default_strings'''() - Внутренний метод.
* '''get_form_default_strings'''() - Внутренний метод.

=== dof_modlib_widgets_ifield ===
Класс, отвечающий за элемент inline-редактирования. Создает элемент, который при помощи AJAX-запросов

==== __construct() ====

Параметры
* $dof - объект класса dof_control
* $plugintype - тип плагина, который будет предоставлять и сохранять данные
* $plugincode - код плагина, который будет предоставлять и сохранять данные
* $queryname - тип запроса (тип запроса - как правило имя поля)
* $objectid - id объекта, который редактируется
* $type - тип элемента. Это параметра type для тега input. Допустимые значения: text, textarea, select
* $text - текст, который отображается на элементе до редактирования
* $options - массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования. По умолчанию null.

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

==== get_html() ====
Получить html-код элемента. После создания объекта этот метод можно вызывать несколько раз, каждый раз указывая новый id. Все нужные параметры (текст скрипта, и т. п.) будут пересчитаны автоматически.

Параметры
* $objectid - id редактируемого объекта
* $text - текст, который отображается вместо элемента, пока не нажата кнопка "редактировать". Разрешено html-форматирование
* $options - Массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования.

==== display() ====
Вывести элемент. После создания объекта этот метод можно вызывать несколько раз, каждый раз указывая новый id. Все нужные параметры (текст скрипта, и т. п.) будут пересчитаны автоматически.

Параметры
* $objectid - id редактируемого объекта
* $text - текст, который отображается вместо элемента, пока не нажата кнопка "редактировать". Разрешено html-форматирование
* $options - Массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования.

==== set_options() ====
Метод для установки параметров класса вручную. Используется в том случае, когда всех приведенных выше методов недостаточно.

Параметры:
* $options - массив свойств класса в формате ключ-значение.

== Примеры кода ==
==== Стандартные формы ====
Здесь будут приведены примеры работы с классов dof_modlib_widgets_form. Этот класс наследует находящийся в moodle класс moodleform. Подробнее о нем можно посмотреть в разделе: [[Разработка:moodleQuickForm]]
===== Подключение библиотеки форм =====
$DOF->modlib('widgets')->'''webform'''();
===== Получение массива нужного формата для составления select-элементов =====

''// получаем список всех учебных периодов из нашей таблицы "ages"
// Отсортированных по названию''
$ages = $this->dof->storage('ages')->get_list(null, null, "name ASC")
''// задаем массив из нескольких собственных первых элементов для списка:
// они добавятся в начало''
$firstelms = array(54 => 'Элемент 1', 'abc' => 'Элемент 2');
''// указываем, какое поле из массива объектов нужно брать в качестве ключа
// (значения должны быть уникальными!)''
$idfield = 'id';
''// указываем, какие поля БД нужно выводить пользователю''
$showfields = array('name', 'eduweeks');
''// получаем массив нужной структуры для составления select-элемента.''
$selectdata = $this->'''dof_get_select_values'''($ages, $firstelms, $idfield, $showfields);

==== Использование прогрессбара ====

1. Устанавливаем параметры
$name = 'pbar'; ''// имя html-элемента, только латинские буквы''
$percent = 1; ''// начинаем с отметки 1%''
$width = 200; ''// длинна полоски 200 пикселей''
$process = 'Идет сохранение...'; ''// какой процесс происходит''
$auto_create = true; ''// вывести прогрессбар сразу же после создания объекта''
2. Создаем нужный объект
$progressbar = $DOF->modlib('widgets')->'''progressbar'''($name, $percent, $width, $process, $auto_create)
3. Вставляем прогрессбар внутрь цикла с выполняемым процессом
for ($i=1; $i<=333; $i++)
{
''// номер текущей выполняемой задачи''
$cur_task = $i;
''// общее количество задач, которое надо выполнить их количество можно менять в ходе выполнения процесса''
''(например, если сразу неясно сколько точно шагов будет у цикла)''
$num_tasks = 333;
''// внутри цикла производим все трудоемкие операции...''

...

sleep(0.1);''// '''для теста''': чтобы было видно как ползет полоска''
''// после того как проведены все операции увеличиваем длину полоски на чуть-чуть''
$progressbar->'''set_percent_adv'''($cur_task,$num_tasks);
}

Разработка:modlibs/widgets

2012-03-06T13:23:13Z

Dido86: /* notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') */

{{Infobox_Plugin
| name = widgets
| type = modlibs
}}
== Описание ==
В этом плагине располагаются все виджеты - дополнительные средства визуального оформления интерфейса.
=== Структура папок ===
Для каждого виджета в папке widgets создается отдельная папка с его названием. Внутри этой папки должен лежать файл lib.php, в котором содержится класс виджета. Все дополнительные файлы, относящиеся к этому виджету (если они требуются) - должны лежать в этой же папке.
=== Стандарт именования классов ===
Все классы виджетов должны называться по схеме '''dof_modlib_widgets'''_''<название_виджета>''.
== API ==
=== webform() ===
Инициализировать библиотеку форм.
Этот метод отвечает за подключение библиотеки moodleQuickForm. Если вы хотите использовать moodleQuickForm, то она подключается только при помощи этого метода. Подключение класса moodleQuickForm (или moodleform) напрямую не допускается.
=== form_classname() ===
Аналог метода webform. В настоящее время '''не используется'''. Он оставлен только для совместимости, не используйте его в новых функциях.
=== progressbar($name, $percent, $width, $process, $auto_create) ===
Эта функция пригодится, если вам понадобится вывести прогрессбар - полоску, которая в реальном времени отображает ход выполнения какого-либо долгого процесса.

Возвращает экземпляр класса ''dof_modlib_widgets_progress_bar''.
Параметры:

''$name'' - имя html-элемента. Если прогрессбаров несколько на странице, то имена не должны повторяться.

''$percent'' - начальное процентное значение.

''$width'' - длина в пикселях.

''$process'' - название процесса, который выполняется в текущий момент (загрузка... сохранение... и т. п.)

''$auto_create'' - для этого формата возможны два значения:

true - сразу же отправить html-код прогрессбара в выходной поток.
false - только создать объект, не выводя progressbar.
По умолчанию true.

=== pages_navigation() === - подключает класс pages_navigation. Служит для отображения ссылок на страницы при постраничном выводе списка данных.

''$code'' - код плагина, для которого будут созданы ссылки на страницы.

''$recordscount'' - общее количество записей на всех страницах

''$limitnum'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице)

''$limitfrom'' - начиная с какой записи начать выводить список.

=== notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') ===

Выводит сообщение подтверждение да/нет для дальнейшей работы с пользователем

''$message'' - код плагина, для которого будут созданы ссылки на страницы.

''$linkyes'' - общее количество записей на всех страницах

''$linkno'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице)

''$optionsyes'' - начиная с какой записи начать выводить список.

''$optionsno'' - общее количество записей на всех страницах

''$methodyes'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице)

''$methodno'' - начиная с какой записи начать выводить список.

=== print_table($table, $return=false) ===

Распечатывает хорошо отформатированную таблицу, использующую текущую тему оформления moodle

Параметры:

''$table'' - стандартный объект со следующими свойствами
* $table->head - Массив заголовков таблицы. (если не задан - выведутся только данные)
* $table->align - Массив, который хранит параметры горизонтального выравнивания текста в колонках
* $table->size - Массив размеров колонок
* $table->wrap - Массив, отвечающий за возможность переноса текста внутри колонки. Возможные значения:
** wrap (переносить)
** nowrap (не переносить)
* $table->data[] - Массив, каждый элемент которого является массивом значений строки таблицы
* $table->width - ширина таблицы в пикселях или процентах
* $table->tablealign - Расположение всей таблицы
* $table->cellpadding - html-параметр cellpadding
* $table->cellspacing - html-параметр cellspacing
* $table->class - html-параметр "class", отвечающий за то, какой
** стиль должен быть сопоставлен этой таблице
* $table->id - html-параметр "id" для использования getElementById()
* $table->rowclass[] - массив названий css-классов для добавления их к специальным рядам
* $table->summary - общее описание содержимого таблицы.

''$return'' - если true, то таблица не будет распечатана, а будет возвращен только ее код

=== print_box_start($classes='generalbox', $ids=' ', $return=false) ===

Распечатывает начало блока (запуск окна с помощью дива)

Параметры:

''$classes'' - имена классов через пробел(по умолчанию generalbox)

''$ids'' - имена id через пробел

''$return'' - возвращает как строку или просто распечатывает его

Возвращает смешанную строку или ничего

=== print_box_end($return=false) ===

Распечатывает конец блока

Параметры:

''$return'' - возвращает как строку или просто распечатывает его

Возвращает смешанную строку или ничего

=== js_init() ===
Подключить js-библиотеку (вместе со стилями) или набор скриптов, по переданному коду. Все виждеты, которые используют javascript должны использовать эту функцию для подключения своих скриптов.

Параметры:

- $code - код библиотеки которую следует подключить

В качестве кода используется собственное название библиотеки внутри FDO, например "jquery". Функция по коду определяет, какой именно список скриптов и стилей нужно подключить.

=== ifield() ===
Получить объект интерактивно редактируемого поля. То есть текст, на который кликаешь, а он становится полем редактирования и через ajax отправляет сохраненные данные.

Параметры:
* $plugintype - тип плагина, который будет предоставлять и сохранять данные
* $plugincode - код плагина, который будет предоставлять и сохранять данные
* $queryname - тип запроса (тип запроса - как правило имя поля)
* $objectid - id объекта, который редактируется
* $type - тип элемента. Это параметра type для тега input. Допустимые значения: text, textarea, select
* $text - текст, который отображается на элементе до редактирования
* $options - массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования. По умолчанию null.

При обращении к этому методу также автоматически подключаются все js-библиотеки, которые нужны для отображения и работы этого элемента, поэтому его следует вызывать до вывода заголовка (print_header)

=== save_ifield() ===
Сохранить данные при inline-редактировании. Сохраняет одно поле. Ищет в переданном плагине функцию '''widgets_save_field''', и передает в нее тип запроса ($querytype), id объекта ($objectid) и новое значение поля ($data). Если такой функции нет - возвращает ошибку.

Функция '''widgets_save_field''' должна вернуть либо новое, измененное значение поля, либо html-код ошибки.

* $plugintype - тип плагина, который отвечает за сохранение поля
* $plugincode - код плагина, который отвечает за редактирование поля
* $querytype - уникальный код запроса внутри плагина. Как правило - имя сохраняемого поля
* $objectid - id объекта, поля которого редактируются
* $data - данные в формате json (или просто строка), пришедшие из формы редактирования объекта.

Возвращает новое, обновленное значение параметра из базы, или html-код ошибки.

=== load_ifield() ===
Загрузить данные для inline-редактирования поля. Этот метод вызывается непосредственно перед редактированием поля, загружая значения из базы, для того чтобы пользователю, который редактирует данные, предоставлялась максимально актуальная информация. Ищет в плагине функцию '''widgets_load_field''' , и передает в нее название поля ($querytype), id объекта ($objectid) и новое значение поля ($data). Если такой функции нет - возвращает ошибку.

Функция '''widgets_load_field''' должна вернуть либо значение поля, либо html-код ошибки.

* $plugintype - тип плагина, который отвечает за редактироване поля
* $plugincode - код плагина, который отвечает за редактироване поля
* $fieldname - поле объекта, которое нужно запросить
* $objectid - id объекта, который редактируется
* $data - дополнительные данные для загрузки объекта

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

== Дополнительные классы ==
=== dof_modlib_widgets_progress_bar ===
* '''__construct'''($name, $percent, $width, $process, $auto_create)
Параметры:

''$name'' - имя html-элемента. Если прогрессбаров несколько на странице, то имена не должны повторяться.

''$percent'' - начальное процентное значение.

''$width'' - длина в пикселях.

''$process'' - название процесса, который выполняется в текущий момент (загрузка... сохранение... и т. п.)

''$auto_create'' - для этого формата возможны два значения:

true - сразу же отправить html-код прогрессбара в выходной поток.
false - только создать объект, не выводя progressbar.
По умолчанию true.
* '''create'''() - вывести html-код прогрессбара в браузер. Эту функцию не нужно использовать, в случае если в конструкторе $auto_create стоит true.
* '''set_name'''($name) - установить имя html-элемента, которым является прогрессбар. Внутренний метод, вызывается из конструктора.
* '''set_percent'''($percent) - установить начальное процентное значение для полоски прогрессбара.
$percent - количество начальных процентов, от 0 до 100.
* '''set_percent_adv'''($cur_amount,$max_amount) - увеличить полоску прогрессбара. Полоска увеличивается в зависимости от того, сколько задач уже выполнено, а сколько еще осталось.

''$cur_amount'' - количество уже выполненных задач

''$max_amount'' - общее количество задач, которое надо выполнить.
* '''set_width'''($width) - установить длину прогрессбара в пикселях. Внутренний метод, используется из конструктора.

=== dof_modlib_widgets_form ===
Класс, наследующий moodleform. Имеет собственные методы, предназначенные для работы с нашими модулями Подробнее об использовании moodleQuickForm можно прочитать в разделе [[Разработка:Стандарт_кодирования#Работа с moodleQuickForm|Работа с moodleQuickForm]].

==== dof_get_select_values() ====

Получить массив, пригодный для составления элементов select и hierselect.

''Параметры''
* $records - массив записей из storage. Ожидаемый формат данных - массив объектов. По умолчанию false.
* $firstelm - (по умолчанию - true) задать первый элемент списка. Возможные значения:
** true - нужен стандартый первый элемент array(0 => '--- Выбрать ---')
** false - первый элемент не нужен
** массив в формате "ключ"=>"значение" из одного, или нескольких элементов, которые нужно добавить в начало списка
* $key - какое поле БД использовать в качестве ключа (это значение отправится формой). По умолчанию 'id'
* $namefields - одно или несколько полей, которые будут видны пользователю в списке. Каждое последующее поле после первого будет заключено в квадратные скобки. По умолчанию 'name'. Формат:
** строка: если отобразить нужно только одно поле
** массив, с названиями полей - если полей нужно несколько. Поля выведутся именно в том порядке, в котором вы их указали

''Возвращаемые значения:''
* array - массив для составления select-элемента
* bool - false в случае ошибки. Возможные ошибки:
** В переданном списке у объектов нет нужных полей
** Для ключа массива есть неуникальные значения

=== dof_modlib_widgets_pages_navigation ===
* '''__construct'''($dof, $code, $count, $limitnum=NULL, $limitfrom) - конструктор класса. Осуществляет все проверки данных.
** ''$dof'' - объект класса [[Разработка:lib/dof.php|dof_control]]
** ''$code'' - код плагина, для которого будут созданы ссылки на страницы.
** ''$count'' - общее количество записей на всех страницах
** ''$limitnum'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице).
** ''$limitfrom'' - начиная с какой записи начать выводить список.
* '''get_navpages_list'''($adds, $vars) - Возвращает html-строку навигации, разбивая ленту таблицы или списка на страницы. Нумерация страница всегда начинается с единицы
** ''$adds'' - дополнительный путь внутри плагина, и список дополнительных параметров для ссылки в виде строки
** ''$vars'' - список дополнительных параметров для ссылки в виде массива в формате '' "ключ" => "значение" ''
* '''get_page_link'''($pagenum, $limitfrom, $adds, $vars) - Возвращает ссылку на страницу или страницу без ссылки, если она является текущей.
** $pagenum - номер страницы
** $limitfrom - номер записи, с которой начинается просмотр
** $adds - дополнительный путь внутри плагина, и список дополнительных параметров для ссылки в виде строки
** $vars - список дополнительных параметров для ссылки в виде массива в формате '' "ключ" => "значение" ''
* '''get_current_page'''() - Получить номер страницы по номеру текущей записи, и количеству записей на странице
* '''get_total_pages'''() - Возвращает общее количество страниц для отображения
* '''get_current_limitfrom'''() - Возвращает исходный параметр номера записи, с которого начинается просмотр
* '''get_current_limitnum'''() - Возвращает исходный параметр минимального количества записей на странице

=== dof_modlib_widgets_addremove ===
Класс для составления стандартного элемента "добавить\удалить". Элемент представляет собой двусторонний список с двумя html-элементами Select. Используется для автоматизации процесса добавления и удаления элементов из какой-либо категории или группы. Позволяет одновременно передавать несколько элементов.
* '''__construct'''($DOF, $action='', $formid='dof_modlib_widgets_addremove') - конструктор класса.
** $DOF объект класса dof_control
** $action - ссылка на страницу-обработчик формы. По умолчанию - эта же страница.
** $formid - id html-элемента на странице. Используется для скрипта, который делает кнопки "добавить" или "удалить" неактивными, в зависимости от того, какое из полей select выбрано.
* '''set_default_strings'''($values)
* '''set_add_list'''($options, $extradata=null)
* '''set_remove_list'''($options, $extradata=null)
* '''set_complex_add_list'''($options)
* '''set_complex_remove_list'''($options)
* '''check_add_remove_array'''($data) - проверить пришедший из формы массив элементов для добавления или удаления.
** $data - массив элементов, пришедший из $_POST
** Возвращаемое значение: (array) - массив числовых значений идентификаторов.
* '''print_html'''() - распечатать html-код элемента.
* '''get_html'''() - получить html-код элемента для последующей распечатки.
* '''assemble_templater_data'''() - Внутренний метод.
* '''get_complex_options_template_data'''($groups, $type) - Внутренний метод.
* '''get_simple_options_template_data'''($options, $extradata=null) - Внутренний метод.
* '''get_search_default_strings'''() - Внутренний метод.
* '''get_form_default_strings'''() - Внутренний метод.

=== dof_modlib_widgets_ifield ===
Класс, отвечающий за элемент inline-редактирования. Создает элемент, который при помощи AJAX-запросов

==== __construct() ====

Параметры
* $dof - объект класса dof_control
* $plugintype - тип плагина, который будет предоставлять и сохранять данные
* $plugincode - код плагина, который будет предоставлять и сохранять данные
* $queryname - тип запроса (тип запроса - как правило имя поля)
* $objectid - id объекта, который редактируется
* $type - тип элемента. Это параметра type для тега input. Допустимые значения: text, textarea, select
* $text - текст, который отображается на элементе до редактирования
* $options - массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования. По умолчанию null.

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

==== get_html() ====
Получить html-код элемента. После создания объекта этот метод можно вызывать несколько раз, каждый раз указывая новый id. Все нужные параметры (текст скрипта, и т. п.) будут пересчитаны автоматически.

Параметры
* $objectid - id редактируемого объекта
* $text - текст, который отображается вместо элемента, пока не нажата кнопка "редактировать". Разрешено html-форматирование
* $options - Массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования.

==== display() ====
Вывести элемент. После создания объекта этот метод можно вызывать несколько раз, каждый раз указывая новый id. Все нужные параметры (текст скрипта, и т. п.) будут пересчитаны автоматически.

Параметры
* $objectid - id редактируемого объекта
* $text - текст, который отображается вместо элемента, пока не нажата кнопка "редактировать". Разрешено html-форматирование
* $options - Массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования.

==== set_options() ====
Метод для установки параметров класса вручную. Используется в том случае, когда всех приведенных выше методов недостаточно.

Параметры:
* $options - массив свойств класса в формате ключ-значение.

== Примеры кода ==
==== Стандартные формы ====
Здесь будут приведены примеры работы с классов dof_modlib_widgets_form. Этот класс наследует находящийся в moodle класс moodleform. Подробнее о нем можно посмотреть в разделе: [[Разработка:moodleQuickForm]]
===== Подключение библиотеки форм =====
$DOF->modlib('widgets')->'''webform'''();
===== Получение массива нужного формата для составления select-элементов =====

''// получаем список всех учебных периодов из нашей таблицы "ages"
// Отсортированных по названию''
$ages = $this->dof->storage('ages')->get_list(null, null, "name ASC")
''// задаем массив из нескольких собственных первых элементов для списка:
// они добавятся в начало''
$firstelms = array(54 => 'Элемент 1', 'abc' => 'Элемент 2');
''// указываем, какое поле из массива объектов нужно брать в качестве ключа
// (значения должны быть уникальными!)''
$idfield = 'id';
''// указываем, какие поля БД нужно выводить пользователю''
$showfields = array('name', 'eduweeks');
''// получаем массив нужной структуры для составления select-элемента.''
$selectdata = $this->'''dof_get_select_values'''($ages, $firstelms, $idfield, $showfields);

==== Использование прогрессбара ====

1. Устанавливаем параметры
$name = 'pbar'; ''// имя html-элемента, только латинские буквы''
$percent = 1; ''// начинаем с отметки 1%''
$width = 200; ''// длинна полоски 200 пикселей''
$process = 'Идет сохранение...'; ''// какой процесс происходит''
$auto_create = true; ''// вывести прогрессбар сразу же после создания объекта''
2. Создаем нужный объект
$progressbar = $DOF->modlib('widgets')->'''progressbar'''($name, $percent, $width, $process, $auto_create)
3. Вставляем прогрессбар внутрь цикла с выполняемым процессом
for ($i=1; $i<=333; $i++)
{
''// номер текущей выполняемой задачи''
$cur_task = $i;
''// общее количество задач, которое надо выполнить их количество можно менять в ходе выполнения процесса''
''(например, если сразу неясно сколько точно шагов будет у цикла)''
$num_tasks = 333;
''// внутри цикла производим все трудоемкие операции...''

...

sleep(0.1);''// '''для теста''': чтобы было видно как ползет полоска''
''// после того как проведены все операции увеличиваем длину полоски на чуть-чуть''
$progressbar->'''set_percent_adv'''($cur_task,$num_tasks);
}

Разработка:modlibs/widgets

2012-03-06T13:22:25Z

Dido86: /* API */

{{Infobox_Plugin
| name = widgets
| type = modlibs
}}
== Описание ==
В этом плагине располагаются все виджеты - дополнительные средства визуального оформления интерфейса.
=== Структура папок ===
Для каждого виджета в папке widgets создается отдельная папка с его названием. Внутри этой папки должен лежать файл lib.php, в котором содержится класс виджета. Все дополнительные файлы, относящиеся к этому виджету (если они требуются) - должны лежать в этой же папке.
=== Стандарт именования классов ===
Все классы виджетов должны называться по схеме '''dof_modlib_widgets'''_''<название_виджета>''.
== API ==
=== webform() ===
Инициализировать библиотеку форм.
Этот метод отвечает за подключение библиотеки moodleQuickForm. Если вы хотите использовать moodleQuickForm, то она подключается только при помощи этого метода. Подключение класса moodleQuickForm (или moodleform) напрямую не допускается.
=== form_classname() ===
Аналог метода webform. В настоящее время '''не используется'''. Он оставлен только для совместимости, не используйте его в новых функциях.
=== progressbar($name, $percent, $width, $process, $auto_create) ===
Эта функция пригодится, если вам понадобится вывести прогрессбар - полоску, которая в реальном времени отображает ход выполнения какого-либо долгого процесса.

Возвращает экземпляр класса ''dof_modlib_widgets_progress_bar''.
Параметры:

''$name'' - имя html-элемента. Если прогрессбаров несколько на странице, то имена не должны повторяться.

''$percent'' - начальное процентное значение.

''$width'' - длина в пикселях.

''$process'' - название процесса, который выполняется в текущий момент (загрузка... сохранение... и т. п.)

''$auto_create'' - для этого формата возможны два значения:

true - сразу же отправить html-код прогрессбара в выходной поток.
false - только создать объект, не выводя progressbar.
По умолчанию true.

=== pages_navigation() === - подключает класс pages_navigation. Служит для отображения ссылок на страницы при постраничном выводе списка данных.

''$code'' - код плагина, для которого будут созданы ссылки на страницы.

''$recordscount'' - общее количество записей на всех страницах

''$limitnum'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице)

''$limitfrom'' - начиная с какой записи начать выводить список.

=== notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') ===
Выводит сообщение подтверждение да/нет для дальнейшей работы с пользователем
''$message'' - код плагина, для которого будут созданы ссылки на страницы.

''$linkyes'' - общее количество записей на всех страницах

''$linkno'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице)

''$optionsyes'' - начиная с какой записи начать выводить список.

''$optionsno'' - общее количество записей на всех страницах

''$methodyes'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице)

''$methodno'' - начиная с какой записи начать выводить список.

=== print_table($table, $return=false) ===

Распечатывает хорошо отформатированную таблицу, использующую текущую тему оформления moodle

Параметры:

''$table'' - стандартный объект со следующими свойствами
* $table->head - Массив заголовков таблицы. (если не задан - выведутся только данные)
* $table->align - Массив, который хранит параметры горизонтального выравнивания текста в колонках
* $table->size - Массив размеров колонок
* $table->wrap - Массив, отвечающий за возможность переноса текста внутри колонки. Возможные значения:
** wrap (переносить)
** nowrap (не переносить)
* $table->data[] - Массив, каждый элемент которого является массивом значений строки таблицы
* $table->width - ширина таблицы в пикселях или процентах
* $table->tablealign - Расположение всей таблицы
* $table->cellpadding - html-параметр cellpadding
* $table->cellspacing - html-параметр cellspacing
* $table->class - html-параметр "class", отвечающий за то, какой
** стиль должен быть сопоставлен этой таблице
* $table->id - html-параметр "id" для использования getElementById()
* $table->rowclass[] - массив названий css-классов для добавления их к специальным рядам
* $table->summary - общее описание содержимого таблицы.

''$return'' - если true, то таблица не будет распечатана, а будет возвращен только ее код

=== print_box_start($classes='generalbox', $ids=' ', $return=false) ===

Распечатывает начало блока (запуск окна с помощью дива)

Параметры:

''$classes'' - имена классов через пробел(по умолчанию generalbox)

''$ids'' - имена id через пробел

''$return'' - возвращает как строку или просто распечатывает его

Возвращает смешанную строку или ничего

=== print_box_end($return=false) ===

Распечатывает конец блока

Параметры:

''$return'' - возвращает как строку или просто распечатывает его

Возвращает смешанную строку или ничего

=== js_init() ===
Подключить js-библиотеку (вместе со стилями) или набор скриптов, по переданному коду. Все виждеты, которые используют javascript должны использовать эту функцию для подключения своих скриптов.

Параметры:

- $code - код библиотеки которую следует подключить

В качестве кода используется собственное название библиотеки внутри FDO, например "jquery". Функция по коду определяет, какой именно список скриптов и стилей нужно подключить.

=== ifield() ===
Получить объект интерактивно редактируемого поля. То есть текст, на который кликаешь, а он становится полем редактирования и через ajax отправляет сохраненные данные.

Параметры:
* $plugintype - тип плагина, который будет предоставлять и сохранять данные
* $plugincode - код плагина, который будет предоставлять и сохранять данные
* $queryname - тип запроса (тип запроса - как правило имя поля)
* $objectid - id объекта, который редактируется
* $type - тип элемента. Это параметра type для тега input. Допустимые значения: text, textarea, select
* $text - текст, который отображается на элементе до редактирования
* $options - массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования. По умолчанию null.

При обращении к этому методу также автоматически подключаются все js-библиотеки, которые нужны для отображения и работы этого элемента, поэтому его следует вызывать до вывода заголовка (print_header)

=== save_ifield() ===
Сохранить данные при inline-редактировании. Сохраняет одно поле. Ищет в переданном плагине функцию '''widgets_save_field''', и передает в нее тип запроса ($querytype), id объекта ($objectid) и новое значение поля ($data). Если такой функции нет - возвращает ошибку.

Функция '''widgets_save_field''' должна вернуть либо новое, измененное значение поля, либо html-код ошибки.

* $plugintype - тип плагина, который отвечает за сохранение поля
* $plugincode - код плагина, который отвечает за редактирование поля
* $querytype - уникальный код запроса внутри плагина. Как правило - имя сохраняемого поля
* $objectid - id объекта, поля которого редактируются
* $data - данные в формате json (или просто строка), пришедшие из формы редактирования объекта.

Возвращает новое, обновленное значение параметра из базы, или html-код ошибки.

=== load_ifield() ===
Загрузить данные для inline-редактирования поля. Этот метод вызывается непосредственно перед редактированием поля, загружая значения из базы, для того чтобы пользователю, который редактирует данные, предоставлялась максимально актуальная информация. Ищет в плагине функцию '''widgets_load_field''' , и передает в нее название поля ($querytype), id объекта ($objectid) и новое значение поля ($data). Если такой функции нет - возвращает ошибку.

Функция '''widgets_load_field''' должна вернуть либо значение поля, либо html-код ошибки.

* $plugintype - тип плагина, который отвечает за редактироване поля
* $plugincode - код плагина, который отвечает за редактироване поля
* $fieldname - поле объекта, которое нужно запросить
* $objectid - id объекта, который редактируется
* $data - дополнительные данные для загрузки объекта

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

== Дополнительные классы ==
=== dof_modlib_widgets_progress_bar ===
* '''__construct'''($name, $percent, $width, $process, $auto_create)
Параметры:

''$name'' - имя html-элемента. Если прогрессбаров несколько на странице, то имена не должны повторяться.

''$percent'' - начальное процентное значение.

''$width'' - длина в пикселях.

''$process'' - название процесса, который выполняется в текущий момент (загрузка... сохранение... и т. п.)

''$auto_create'' - для этого формата возможны два значения:

true - сразу же отправить html-код прогрессбара в выходной поток.
false - только создать объект, не выводя progressbar.
По умолчанию true.
* '''create'''() - вывести html-код прогрессбара в браузер. Эту функцию не нужно использовать, в случае если в конструкторе $auto_create стоит true.
* '''set_name'''($name) - установить имя html-элемента, которым является прогрессбар. Внутренний метод, вызывается из конструктора.
* '''set_percent'''($percent) - установить начальное процентное значение для полоски прогрессбара.
$percent - количество начальных процентов, от 0 до 100.
* '''set_percent_adv'''($cur_amount,$max_amount) - увеличить полоску прогрессбара. Полоска увеличивается в зависимости от того, сколько задач уже выполнено, а сколько еще осталось.

''$cur_amount'' - количество уже выполненных задач

''$max_amount'' - общее количество задач, которое надо выполнить.
* '''set_width'''($width) - установить длину прогрессбара в пикселях. Внутренний метод, используется из конструктора.

=== dof_modlib_widgets_form ===
Класс, наследующий moodleform. Имеет собственные методы, предназначенные для работы с нашими модулями Подробнее об использовании moodleQuickForm можно прочитать в разделе [[Разработка:Стандарт_кодирования#Работа с moodleQuickForm|Работа с moodleQuickForm]].

==== dof_get_select_values() ====

Получить массив, пригодный для составления элементов select и hierselect.

''Параметры''
* $records - массив записей из storage. Ожидаемый формат данных - массив объектов. По умолчанию false.
* $firstelm - (по умолчанию - true) задать первый элемент списка. Возможные значения:
** true - нужен стандартый первый элемент array(0 => '--- Выбрать ---')
** false - первый элемент не нужен
** массив в формате "ключ"=>"значение" из одного, или нескольких элементов, которые нужно добавить в начало списка
* $key - какое поле БД использовать в качестве ключа (это значение отправится формой). По умолчанию 'id'
* $namefields - одно или несколько полей, которые будут видны пользователю в списке. Каждое последующее поле после первого будет заключено в квадратные скобки. По умолчанию 'name'. Формат:
** строка: если отобразить нужно только одно поле
** массив, с названиями полей - если полей нужно несколько. Поля выведутся именно в том порядке, в котором вы их указали

''Возвращаемые значения:''
* array - массив для составления select-элемента
* bool - false в случае ошибки. Возможные ошибки:
** В переданном списке у объектов нет нужных полей
** Для ключа массива есть неуникальные значения

=== dof_modlib_widgets_pages_navigation ===
* '''__construct'''($dof, $code, $count, $limitnum=NULL, $limitfrom) - конструктор класса. Осуществляет все проверки данных.
** ''$dof'' - объект класса [[Разработка:lib/dof.php|dof_control]]
** ''$code'' - код плагина, для которого будут созданы ссылки на страницы.
** ''$count'' - общее количество записей на всех страницах
** ''$limitnum'' - по сколько записей нужно выводить на одной странице. По умолчанию NULL (вывести все на одной странице).
** ''$limitfrom'' - начиная с какой записи начать выводить список.
* '''get_navpages_list'''($adds, $vars) - Возвращает html-строку навигации, разбивая ленту таблицы или списка на страницы. Нумерация страница всегда начинается с единицы
** ''$adds'' - дополнительный путь внутри плагина, и список дополнительных параметров для ссылки в виде строки
** ''$vars'' - список дополнительных параметров для ссылки в виде массива в формате '' "ключ" => "значение" ''
* '''get_page_link'''($pagenum, $limitfrom, $adds, $vars) - Возвращает ссылку на страницу или страницу без ссылки, если она является текущей.
** $pagenum - номер страницы
** $limitfrom - номер записи, с которой начинается просмотр
** $adds - дополнительный путь внутри плагина, и список дополнительных параметров для ссылки в виде строки
** $vars - список дополнительных параметров для ссылки в виде массива в формате '' "ключ" => "значение" ''
* '''get_current_page'''() - Получить номер страницы по номеру текущей записи, и количеству записей на странице
* '''get_total_pages'''() - Возвращает общее количество страниц для отображения
* '''get_current_limitfrom'''() - Возвращает исходный параметр номера записи, с которого начинается просмотр
* '''get_current_limitnum'''() - Возвращает исходный параметр минимального количества записей на странице

=== dof_modlib_widgets_addremove ===
Класс для составления стандартного элемента "добавить\удалить". Элемент представляет собой двусторонний список с двумя html-элементами Select. Используется для автоматизации процесса добавления и удаления элементов из какой-либо категории или группы. Позволяет одновременно передавать несколько элементов.
* '''__construct'''($DOF, $action='', $formid='dof_modlib_widgets_addremove') - конструктор класса.
** $DOF объект класса dof_control
** $action - ссылка на страницу-обработчик формы. По умолчанию - эта же страница.
** $formid - id html-элемента на странице. Используется для скрипта, который делает кнопки "добавить" или "удалить" неактивными, в зависимости от того, какое из полей select выбрано.
* '''set_default_strings'''($values)
* '''set_add_list'''($options, $extradata=null)
* '''set_remove_list'''($options, $extradata=null)
* '''set_complex_add_list'''($options)
* '''set_complex_remove_list'''($options)
* '''check_add_remove_array'''($data) - проверить пришедший из формы массив элементов для добавления или удаления.
** $data - массив элементов, пришедший из $_POST
** Возвращаемое значение: (array) - массив числовых значений идентификаторов.
* '''print_html'''() - распечатать html-код элемента.
* '''get_html'''() - получить html-код элемента для последующей распечатки.
* '''assemble_templater_data'''() - Внутренний метод.
* '''get_complex_options_template_data'''($groups, $type) - Внутренний метод.
* '''get_simple_options_template_data'''($options, $extradata=null) - Внутренний метод.
* '''get_search_default_strings'''() - Внутренний метод.
* '''get_form_default_strings'''() - Внутренний метод.

=== dof_modlib_widgets_ifield ===
Класс, отвечающий за элемент inline-редактирования. Создает элемент, который при помощи AJAX-запросов

==== __construct() ====

Параметры
* $dof - объект класса dof_control
* $plugintype - тип плагина, который будет предоставлять и сохранять данные
* $plugincode - код плагина, который будет предоставлять и сохранять данные
* $queryname - тип запроса (тип запроса - как правило имя поля)
* $objectid - id объекта, который редактируется
* $type - тип элемента. Это параметра type для тега input. Допустимые значения: text, textarea, select
* $text - текст, который отображается на элементе до редактирования
* $options - массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования. По умолчанию null.

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

==== get_html() ====
Получить html-код элемента. После создания объекта этот метод можно вызывать несколько раз, каждый раз указывая новый id. Все нужные параметры (текст скрипта, и т. п.) будут пересчитаны автоматически.

Параметры
* $objectid - id редактируемого объекта
* $text - текст, который отображается вместо элемента, пока не нажата кнопка "редактировать". Разрешено html-форматирование
* $options - Массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования.

==== display() ====
Вывести элемент. После создания объекта этот метод можно вызывать несколько раз, каждый раз указывая новый id. Все нужные параметры (текст скрипта, и т. п.) будут пересчитаны автоматически.

Параметры
* $objectid - id редактируемого объекта
* $text - текст, который отображается вместо элемента, пока не нажата кнопка "редактировать". Разрешено html-форматирование
* $options - Массив или строка дополнительных html-параметров для div-элемента, содержащего поле редактирования.

==== set_options() ====
Метод для установки параметров класса вручную. Используется в том случае, когда всех приведенных выше методов недостаточно.

Параметры:
* $options - массив свойств класса в формате ключ-значение.

== Примеры кода ==
==== Стандартные формы ====
Здесь будут приведены примеры работы с классов dof_modlib_widgets_form. Этот класс наследует находящийся в moodle класс moodleform. Подробнее о нем можно посмотреть в разделе: [[Разработка:moodleQuickForm]]
===== Подключение библиотеки форм =====
$DOF->modlib('widgets')->'''webform'''();
===== Получение массива нужного формата для составления select-элементов =====

''// получаем список всех учебных периодов из нашей таблицы "ages"
// Отсортированных по названию''
$ages = $this->dof->storage('ages')->get_list(null, null, "name ASC")
''// задаем массив из нескольких собственных первых элементов для списка:
// они добавятся в начало''
$firstelms = array(54 => 'Элемент 1', 'abc' => 'Элемент 2');
''// указываем, какое поле из массива объектов нужно брать в качестве ключа
// (значения должны быть уникальными!)''
$idfield = 'id';
''// указываем, какие поля БД нужно выводить пользователю''
$showfields = array('name', 'eduweeks');
''// получаем массив нужной структуры для составления select-элемента.''
$selectdata = $this->'''dof_get_select_values'''($ages, $firstelms, $idfield, $showfields);

==== Использование прогрессбара ====

1. Устанавливаем параметры
$name = 'pbar'; ''// имя html-элемента, только латинские буквы''
$percent = 1; ''// начинаем с отметки 1%''
$width = 200; ''// длинна полоски 200 пикселей''
$process = 'Идет сохранение...'; ''// какой процесс происходит''
$auto_create = true; ''// вывести прогрессбар сразу же после создания объекта''
2. Создаем нужный объект
$progressbar = $DOF->modlib('widgets')->'''progressbar'''($name, $percent, $width, $process, $auto_create)
3. Вставляем прогрессбар внутрь цикла с выполняемым процессом
for ($i=1; $i<=333; $i++)
{
''// номер текущей выполняемой задачи''
$cur_task = $i;
''// общее количество задач, которое надо выполнить их количество можно менять в ходе выполнения процесса''
''(например, если сразу неясно сколько точно шагов будет у цикла)''
$num_tasks = 333;
''// внутри цикла производим все трудоемкие операции...''

...

sleep(0.1);''// '''для теста''': чтобы было видно как ползет полоска''
''// после того как проведены все операции увеличиваем длину полоски на чуть-чуть''
$progressbar->'''set_percent_adv'''($cur_task,$num_tasks);
}

Разработка:storages/invitems

2012-02-20T12:14:22Z

Dido86: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = invitems
| type = storages
}}

==Таблица в базе данных==
''invitems'' - реестр склада(оборудование). На складе могут быть 2 типа ресурсов: штучный (помещения или ресурсы, имеющие отдельный инвентарный номер), счетный(нет инвентарного(серийного) номера, приходит как правило больше одного. Например 50 картриджей). Одна запись всегда включает только одно наименование ресурса. Каждое оборудование приписано к категории.

===Подробный формат полей в таблице:===
* name - наименование
* code - инвентарный номер(уникум во всей системе)
* serialnum - серийный номер
* type - тип ресурса штучный (unit), счетный одалживаемый (lendable), счетный расходуемый (expendable)
* count - количество штучного ресурса в данной партии
* termofuse - предполагаемый срок полезного использования
* dateentry - дата и время поступления по UTC
* datewriteoff - дата и время списания по UTC
* invcategoryid - категория, к которой приписан объект в таблице [[Разработка:storages/invcategories | invcategories ]].
* departmentid - id подразделение - владельца ресурса в таблице [[Разработка:storages/departments | departments ]]
* invsetid - id комплекта в таблице [[Разработка:storages/invsets | invsets ]] , если 0 - оборудование не в комплекте
* setorderid - id приказа, которым зачислено оборудование
* outorderid - id приказа, которым списано оборудование
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invitems | invitems ]]

===Дополнительные методы:===
* Поступление оборудование. Делается через приказ.
* Списание оборудования. Делается через приказ.
* Список оборудования по категории (если null - не учитывается) и структурному подразделению (если null - берутся все) и статусу : все, доступно, не доступно, в комплекте.
* Поиск по серийному, инвентарному номеру, по названию.

[[Категория:Оборудование]]

Разработка:storages/invitems

2012-02-20T12:13:56Z

Dido86: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = invitems
| type = storages
}}

==Таблица в базе данных==
''invitems'' - реестр склада(оборудование). На складе могут быть 2 типа ресурсов: штучный (помещения или ресурсы, имеющие отдельный инвентарный номер), счетный(нет инвентарного(серийного) номера, приходит как правило больше одного. Например 50 картриджей). Одна запись всегда включает только одно наименование ресурса. Каждое оборудование приписано к категории.

===Подробный формат полей в таблице:===
* name - наименование
* code - инвентарный номер(уникум во всей системе)
* serialnum - серийный номер
* type - тип ресурса штучный (unit), счетный одалживаемый (lendable), счетный расходуемый (expendable)
* count - количество штучного ресурса в данной партии
* termofuse - предполагаемый срок полезного использования
* dateentry - дата и время поступления по UTC
* datewriteoff - дата и время списания по UTC
* invcategoryid - категория, к которой приписан объект в таблице [[Разработка:storages/invcategories | invcategories ]].
* departmentid - id подразделение - владельца ресурса в таблице [[Разработка:storage/departments | departments ]]
* invsetid - id комплекта в таблице [[Разработка:storage/invsets | invsets ]] , если 0 - оборудование не в комплекте
* setorderid - id приказа, которым зачислено оборудование
* outorderid - id приказа, которым списано оборудование
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invitems | invitems ]]

===Дополнительные методы:===
* Поступление оборудование. Делается через приказ.
* Списание оборудования. Делается через приказ.
* Список оборудования по категории (если null - не учитывается) и структурному подразделению (если null - берутся все) и статусу : все, доступно, не доступно, в комплекте.
* Поиск по серийному, инвентарному номеру, по названию.

[[Категория:Оборудование]]

Разработка:storages/invitems

2012-02-20T12:11:56Z

Dido86: /* Дополнительные методы: */

{{Infobox_Plugin
| name = invitems
| type = storages
}}

==Таблица в базе данных==
''invitems'' - реестр склада(оборудование). На складе могут быть 2 типа ресурсов: штучный (помещения или ресурсы, имеющие отдельный инвентарный номер), счетный(нет инвентарного(серийного) номера, приходит как правило больше одного. Например 50 картриджей). Одна запись всегда включает только одно наименование ресурса. Каждое оборудование приписано к категории.

===Подробный формат полей в таблице:===
* name - наименование
* code - инвентарный номер(уникум во всей системе)
* serialnum - серийный номер
* type - тип ресурса штучный (unit), счетный одалживаемый (lendable), счетный расходуемый (expendable)
* count - количество штучного ресурса в данной партии
* termofuse - предполагаемый срок полезного использования
* dateentry - дата и время поступления по UTC
* datewriteoff - дата и время списания по UTC
* invcategoryid - категория, к которой приписан объект в таблице [[Разработка:storage/invcategories | invcategories ]]
* departmentid - id подразделение - владельца ресурса в таблице [[Разработка:storage/departments | departments ]]
* invsetid - id комплекта в таблице [[Разработка:storage/invsets | invsets ]] , если 0 - оборудование не в комплекте
* setorderid - id приказа, которым зачислено оборудование
* outorderid - id приказа, которым списано оборудование
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invitems | invitems ]]

===Дополнительные методы:===
* Поступление оборудование. Делается через приказ.
* Списание оборудования. Делается через приказ.
* Список оборудования по категории (если null - не учитывается) и структурному подразделению (если null - берутся все) и статусу : все, доступно, не доступно, в комплекте.
* Поиск по серийному, инвентарному номеру, по названию.

[[Категория:Оборудование]]

Разработка:storages/invitems

2012-02-20T12:11:44Z

Dido86: /* Дополнительные методы: */

{{Infobox_Plugin
| name = invitems
| type = storages
}}

==Таблица в базе данных==
''invitems'' - реестр склада(оборудование). На складе могут быть 2 типа ресурсов: штучный (помещения или ресурсы, имеющие отдельный инвентарный номер), счетный(нет инвентарного(серийного) номера, приходит как правило больше одного. Например 50 картриджей). Одна запись всегда включает только одно наименование ресурса. Каждое оборудование приписано к категории.

===Подробный формат полей в таблице:===
* name - наименование
* code - инвентарный номер(уникум во всей системе)
* serialnum - серийный номер
* type - тип ресурса штучный (unit), счетный одалживаемый (lendable), счетный расходуемый (expendable)
* count - количество штучного ресурса в данной партии
* termofuse - предполагаемый срок полезного использования
* dateentry - дата и время поступления по UTC
* datewriteoff - дата и время списания по UTC
* invcategoryid - категория, к которой приписан объект в таблице [[Разработка:storage/invcategories | invcategories ]]
* departmentid - id подразделение - владельца ресурса в таблице [[Разработка:storage/departments | departments ]]
* invsetid - id комплекта в таблице [[Разработка:storage/invsets | invsets ]] , если 0 - оборудование не в комплекте
* setorderid - id приказа, которым зачислено оборудование
* outorderid - id приказа, которым списано оборудование
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invitems | invitems ]]

===Дополнительные методы:===
* Поступление оборудование. Делается через приказ.
* Списание оборудования. Делается через приказ.
* Список оборудования по категории (если null - не учитывается) и структурному подразделению (если null - берутся все) и статусу : все, доступно, не доступно, в комплекте.
* поиск по серийному, инвентарному номеру, по названию.

[[Категория:Оборудование]]

Разработка:storages/invitems

2012-02-20T11:06:07Z

Dido86: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = invitems
| type = storages
}}

==Таблица в базе данных==
''invitems'' - реестр склада(оборудование). На складе могут быть 2 типа ресурсов: штучный (помещения или ресурсы, имеющие отдельный инвентарный номер), счетный(нет инвентарного(серийного) номера, приходит как правило больше одного. Например 50 картриджей). Одна запись всегда включает только одно наименование ресурса. Каждое оборудование приписано к категории.

===Подробный формат полей в таблице:===
* name - наименование
* code - инвентарный номер(уникум во всей системе)
* serialnum - серийный номер
* type - тип ресурса штучный (unit), счетный одалживаемый (lendable), счетный расходуемый (expendable)
* count - количество штучного ресурса в данной партии
* termofuse - предполагаемый срок полезного использования
* dateentry - дата и время поступления по UTC
* datewriteoff - дата и время списания по UTC
* invcategoryid - категория, к которой приписан объект в таблице [[Разработка:storage/invcategories | invcategories ]]
* departmentid - id подразделение - владельца ресурса в таблице [[Разработка:storage/departments | departments ]]
* invsetid - id комплекта в таблице [[Разработка:storage/invsets | invsets ]] , если 0 - оборудование не в комплекте
* setorderid - id приказа, которым зачислено оборудование
* outorderid - id приказа, которым списано оборудование
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invitems | invitems ]]

==Дополнительные методы:==

[[Категория:Оборудование]]

Разработка:storages/invitems

2012-02-20T11:03:01Z

Dido86:

{{Infobox_Plugin
| name = invitems
| type = storages
}}

==Таблица в базе данных==
''invitems'' - реестр склада(оборудование). На складе могут быть 2 типа ресурсов: штучный (помещения или ресурсы, имеющие отдельный инвентарный номер), счетный(нет инвентарного(серийного) номера, приходит как правило больше одного. Например 50 картриджей). Одна запись всегда включает только одно наименование ресурса. Каждое оборудование приписано к категории.

===Подробный формат полей в таблице:===
* name - наименование
* code - инвентарный номер
* serialnum - серийный номер
* type - тип ресурса штучный (unit), счетный одалживаемый (lendable), счетный расходуемый (expendable)
* count - количество штучного ресурса в данной партии
* termofuse - предполагаемый срок полезного использования
* dateentry - дата и время поступления по UTC
* datewriteoff - дата и время списания по UTC
* invcategoryid - категория, к которой приписан объект
* departmentid - id подразделение - владельца ресурса
* invsetid - id комплекта, если 0 - оборудование не в комплекте
* setorderid - id приказа, которым зачислено оборудование
* outorderid - id приказа, которым списано оборудование
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invitems | invitems ]]

==Дополнительные методы:==

[[Категория:Оборудование]]

Разработка:storages/invsets

2012-02-20T11:01:49Z

Dido86: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

===Таблица в базе данных===
''invsets'' - комплекты оборудования, минимальная единица, которую можно выдать персоне. Комплект включать в себя штучное оборудование. Все комплекты являются штучными и содержат конкретный перечень оборудования с известными инвентарными номерами.

====Подробный формат полей в таблице:====
* code - код комплекта
* type - возвращаемость комплекта: полностью расходуемый, возвращаемый, штучный
* invcategoryid - категория, к которой приписан объект в таблице [[Разработка:storages/invcategories | invcategories ]].
* departmentid - id подразделение - владельца ресурса в таблице [[Разработка:storages/departments | departments ]].
* personid - персона, ответственная за комплект в таблице [[Разработка:storages/persons | persons ]].
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invsets | invsets ]]
* note - примечание. Заполняется при выдаче/возврате комплекта

==Дополнительные методы:==
* Список комплектов по категории (если null - не учитывается) и структурному подразделению (если null - не учитывается) и статусу : все, выданные, доступные.
* Создать комплект/комплекты (с проверкой достаточности оборудования для формирования комплекта/комплектов)
* Расформировать комплект
* Выдать комплект конкретной персоне
[[Категория:Оборудование]]

Разработка:storages/invsets

2012-02-20T11:01:11Z

Dido86: /* Дополнительные методы: */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

===Таблица в базе данных===
''invsets'' - комплекты оборудования, минимальная единица, которую можно выдать персоне. Комплект включать в себя штучное оборудование. Все комплекты являются штучными и содержат конкретный перечень оборудования с известными инвентарными номерами.

====Подробный формат полей в таблице:====
* code - код комплекта
* type - возвращаемость комплекта: полностью расходуемый, возвращаемый, штучный
* invcategoryid - категория, к которой приписан объект в таблице [[Разработка:storages/invcategories | invcategories ]].
* departmentid - id подразделение - владельца ресурса в таблице i[[Разработка:storages/departments | departments ]].
* personid - персона, ответственная за комплект в таблице i[[Разработка:storages/persons | persons ]].
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invsets | invsets ]]
* note - примечание. Заполняется при выдаче/возврате комплекта

==Дополнительные методы:==
* Список комплектов по категории (если null - не учитывается) и структурному подразделению (если null - не учитывается) и статусу : все, выданные, доступные.
* Создать комплект/комплекты (с проверкой достаточности оборудования для формирования комплекта/комплектов)
* Расформировать комплект
* Выдать комплект конкретной персоне
[[Категория:Оборудование]]

Разработка:storages/invsets

2012-02-20T10:56:49Z

Dido86: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

===Таблица в базе данных===
''invsets'' - комплекты оборудования, минимальная единица, которую можно выдать персоне. Комплект включать в себя штучное оборудование. Все комплекты являются штучными и содержат конкретный перечень оборудования с известными инвентарными номерами.

====Подробный формат полей в таблице:====
* code - код комплекта
* type - возвращаемость комплекта: полностью расходуемый, возвращаемый, штучный
* invcategoryid - категория, к которой приписан объект в таблице [[Разработка:storages/invcategories | invcategories ]].
* departmentid - id подразделение - владельца ресурса в таблице i[[Разработка:storages/departments | departments ]].
* personid - персона, ответственная за комплект в таблице i[[Разработка:storages/persons | persons ]].
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invsets | invsets ]]
* note - примечание. Заполняется при выдаче/возврате комплекта

==Дополнительные методы:==
* Поиск комплекта по коду (второй параметр: только доступные, включая новые и временно недоступные, включая расформированные)
* Список комплектов по категории (если null - не учитывается) и структурному подразделению (если null - не учитывается) и статусу : только доступные, включая новые и временно недоступные, включая расформированные)
* Создать комплект (с проверкой уникальности кода и правомерностью расположения в категории)
* Расформировать комплект
[[Категория:Оборудование]]

Разработка:storages/invcategories

2012-02-20T10:53:23Z

Dido86: /* category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = \'\', $depid 0, $right = \'\' ) */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

==Таблица в базе данных==
''invcategories'' - категории ресурсов, для удобства пользователя: позволяют разместить в древовидном меню комплекты оборудования. Поток расходования - одновременно возможна выдача не более заданного количества ресурса или комплектов из категории. Считается, что если нужен товар родительской категории, то выдать можно из любой дочерней подкатегории.

==Подробный формат полей в таблице:==
* name - название категории
* code - код категории
* parentid - id родительской категории
* path - путь к категории
* depth - глубина вложения категории
* departmentid - id подразделение - владельца ресурса. Если = 0 - то категория видна всем. Если <>0 - то категория видна только в этом подразделении.
* status - нормальный (active), удалена(deleted)

==Дополнительные методы:==
* Список дочерних категорий данной категории
* Вернуть дерево категорий заданного типа (комплекты или ресурсы + пустые) в виде массива, элементы которого - объекты категорий, категории одного уровня отсортированы по алфавиты, подкатегории следуют за своими родительскими категориями
* Пересчитать остаток по категории и обновить информацию о категории

===='''category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = "", $depid 0, $right = "" )'''====

возвращает список подкатегорий(категорий, если id=0) в виде массива или дерева по заданным параметрам

''Аргументы:''
* $id(int) - id категории(если 0, вернет все категории)
* $depth(int) - глубина вложения(по умолчанию 0. Если передана категория - берется по умолчанию глубина переданной категории).
* $path(string) - путь категорий.
* $select(bool) - false-возвратит массив, true - в виде дерева(иеархически, как правило для select-поля).
* $space(string) - разделитель для категорий(2 пробела по умолчанию)
* $depid - id записи из таблицы [[Разработка:storages/departments | departments ]]. Из какого подразделения брать категории(0 - из всех)
* $right(string) - права, на какие права нужно проверить категории
''Возвращаемые значения:''
* $categories - массив результата(полный или пустой)
[[Категория:Оборудование]]

Разработка:storages/invcategories

2012-02-20T10:52:52Z

Dido86: /* category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = , $depid 0, $right = ) */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

==Таблица в базе данных==
''invcategories'' - категории ресурсов, для удобства пользователя: позволяют разместить в древовидном меню комплекты оборудования. Поток расходования - одновременно возможна выдача не более заданного количества ресурса или комплектов из категории. Считается, что если нужен товар родительской категории, то выдать можно из любой дочерней подкатегории.

==Подробный формат полей в таблице:==
* name - название категории
* code - код категории
* parentid - id родительской категории
* path - путь к категории
* depth - глубина вложения категории
* departmentid - id подразделение - владельца ресурса. Если = 0 - то категория видна всем. Если <>0 - то категория видна только в этом подразделении.
* status - нормальный (active), удалена(deleted)

==Дополнительные методы:==
* Список дочерних категорий данной категории
* Вернуть дерево категорий заданного типа (комплекты или ресурсы + пустые) в виде массива, элементы которого - объекты категорий, категории одного уровня отсортированы по алфавиты, подкатегории следуют за своими родительскими категориями
* Пересчитать остаток по категории и обновить информацию о категории

===='''category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = \'\', $depid 0, $right = \'\' )'''====

возвращает список подкатегорий(категорий, если id=0) в виде массива или дерева по заданным параметрам

''Аргументы:''
* $id(int) - id категории(если 0, вернет все категории)
* $depth(int) - глубина вложения(по умолчанию 0. Если передана категория - берется по умолчанию глубина переданной категории).
* $path(string) - путь категорий.
* $select(bool) - false-возвратит массив, true - в виде дерева(иеархически, как правило для select-поля).
* $space(string) - разделитель для категорий(2 пробела по умолчанию)
* $depid - id записи из таблицы [[Разработка:storages/departments | departments ]]. Из какого подразделения брать категории(0 - из всех)
* $right(string) - права, на какие права нужно проверить категории
''Возвращаемые значения:''
* $categories - массив результата(полный или пустой)
[[Категория:Оборудование]]

Разработка:storages/invcategories

2012-02-20T10:52:35Z

Dido86: /* category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = , $depid=0, $right= ) */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

==Таблица в базе данных==
''invcategories'' - категории ресурсов, для удобства пользователя: позволяют разместить в древовидном меню комплекты оборудования. Поток расходования - одновременно возможна выдача не более заданного количества ресурса или комплектов из категории. Считается, что если нужен товар родительской категории, то выдать можно из любой дочерней подкатегории.

==Подробный формат полей в таблице:==
* name - название категории
* code - код категории
* parentid - id родительской категории
* path - путь к категории
* depth - глубина вложения категории
* departmentid - id подразделение - владельца ресурса. Если = 0 - то категория видна всем. Если <>0 - то категория видна только в этом подразделении.
* status - нормальный (active), удалена(deleted)

==Дополнительные методы:==
* Список дочерних категорий данной категории
* Вернуть дерево категорий заданного типа (комплекты или ресурсы + пустые) в виде массива, элементы которого - объекты категорий, категории одного уровня отсортированы по алфавиты, подкатегории следуют за своими родительскими категориями
* Пересчитать остаток по категории и обновить информацию о категории

===='''category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = '', $depid 0, $right = '' )'''====

возвращает список подкатегорий(категорий, если id=0) в виде массива или дерева по заданным параметрам

''Аргументы:''
* $id(int) - id категории(если 0, вернет все категории)
* $depth(int) - глубина вложения(по умолчанию 0. Если передана категория - берется по умолчанию глубина переданной категории).
* $path(string) - путь категорий.
* $select(bool) - false-возвратит массив, true - в виде дерева(иеархически, как правило для select-поля).
* $space(string) - разделитель для категорий(2 пробела по умолчанию)
* $depid - id записи из таблицы [[Разработка:storages/departments | departments ]]. Из какого подразделения брать категории(0 - из всех)
* $right(string) - права, на какие права нужно проверить категории
''Возвращаемые значения:''
* $categories - массив результата(полный или пустой)
[[Категория:Оборудование]]

Разработка:storages/invcategories

2012-02-20T10:52:12Z

Dido86: /* category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = , $depid=0, $right= ) */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

==Таблица в базе данных==
''invcategories'' - категории ресурсов, для удобства пользователя: позволяют разместить в древовидном меню комплекты оборудования. Поток расходования - одновременно возможна выдача не более заданного количества ресурса или комплектов из категории. Считается, что если нужен товар родительской категории, то выдать можно из любой дочерней подкатегории.

==Подробный формат полей в таблице:==
* name - название категории
* code - код категории
* parentid - id родительской категории
* path - путь к категории
* depth - глубина вложения категории
* departmentid - id подразделение - владельца ресурса. Если = 0 - то категория видна всем. Если <>0 - то категория видна только в этом подразделении.
* status - нормальный (active), удалена(deleted)

==Дополнительные методы:==
* Список дочерних категорий данной категории
* Вернуть дерево категорий заданного типа (комплекты или ресурсы + пустые) в виде массива, элементы которого - объекты категорий, категории одного уровня отсортированы по алфавиты, подкатегории следуют за своими родительскими категориями
* Пересчитать остаток по категории и обновить информацию о категории

===='''category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = '', $depid=0, $right='' )'''====

возвращает список подкатегорий(категорий, если id=0) в виде массива или дерева по заданным параметрам

''Аргументы:''
* $id(int) - id категории(если 0, вернет все категории)
* $depth(int) - глубина вложения(по умолчанию 0. Если передана категория - берется по умолчанию глубина переданной категории).
* $path(string) - путь категорий.
* $select(bool) - false-возвратит массив, true - в виде дерева(иеархически, как правило для select-поля).
* $space(string) - разделитель для категорий(2 пробела по умолчанию)
* $depid - id записи из таблицы [[Разработка:storages/departments | departments ]]. Из какого подразделения брать категории(0 - из всех)
* $right(string) - права, на какие права нужно проверить категории
''Возвращаемые значения:''
* $categories - массив результата(полный или пустой)
[[Категория:Оборудование]]

Разработка:storages/invcategories

2012-02-20T10:51:28Z

Dido86: /* category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = , $depid=0, $right= ) */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

==Таблица в базе данных==
''invcategories'' - категории ресурсов, для удобства пользователя: позволяют разместить в древовидном меню комплекты оборудования. Поток расходования - одновременно возможна выдача не более заданного количества ресурса или комплектов из категории. Считается, что если нужен товар родительской категории, то выдать можно из любой дочерней подкатегории.

==Подробный формат полей в таблице:==
* name - название категории
* code - код категории
* parentid - id родительской категории
* path - путь к категории
* depth - глубина вложения категории
* departmentid - id подразделение - владельца ресурса. Если = 0 - то категория видна всем. Если <>0 - то категория видна только в этом подразделении.
* status - нормальный (active), удалена(deleted)

==Дополнительные методы:==
* Список дочерних категорий данной категории
* Вернуть дерево категорий заданного типа (комплекты или ресурсы + пустые) в виде массива, элементы которого - объекты категорий, категории одного уровня отсортированы по алфавиты, подкатегории следуют за своими родительскими категориями
* Пересчитать остаток по категории и обновить информацию о категории

===='''category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = '', $depid=0, $right='' )'''====

возвращает список подкатегорий(категорий, если id=0) в виде массива или дерева по заданным параметрам

''Аргументы:''
* $id(int) - id категории(если 0, вернет все категории) [[Разработка:storages/departments | departments ]].
* $depth(int) - глубина вложения(по умолчанию 0. Если передана категория - берется по умолчанию глубина переданной категории).
* $path(string) - путь категорий.
* $select(bool) - false-возвратит массив, true - в виде дерева(иеархически, как правило для select-поля).
* $space(string) - разделитель для категорий(2 пробела по умолчанию)
* $depid - id записи из таблицы [[Разработка:storages/departments | departments ]]. Из какого подразделения брать категории(0 - из всех)
* $right(strinf) - права, на какие права нужно проверить категории
''Возвращаемые значения:''
* $categories - массив результата(полный или пустой)
[[Категория:Оборудование]]

Разработка:storages/invcategories

2012-02-20T10:50:34Z

Dido86: /* Дополнительные методы: */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

==Таблица в базе данных==
''invcategories'' - категории ресурсов, для удобства пользователя: позволяют разместить в древовидном меню комплекты оборудования. Поток расходования - одновременно возможна выдача не более заданного количества ресурса или комплектов из категории. Считается, что если нужен товар родительской категории, то выдать можно из любой дочерней подкатегории.

==Подробный формат полей в таблице:==
* name - название категории
* code - код категории
* parentid - id родительской категории
* path - путь к категории
* depth - глубина вложения категории
* departmentid - id подразделение - владельца ресурса. Если = 0 - то категория видна всем. Если <>0 - то категория видна только в этом подразделении.
* status - нормальный (active), удалена(deleted)

==Дополнительные методы:==
* Список дочерних категорий данной категории
* Вернуть дерево категорий заданного типа (комплекты или ресурсы + пустые) в виде массива, элементы которого - объекты категорий, категории одного уровня отсортированы по алфавиты, подкатегории следуют за своими родительскими категориями
* Пересчитать остаток по категории и обновить информацию о категории

===='''category_list_subordinated($id = null, $depth = '0', $path = null, $select = false, $space = '', $depid=0, $right='' )'''====

возвращает список подкатегорий(категорий, если id=0) в виде массива или дерева по заданным параметрам

''Аргументы:''
* $id(int) - id категории(если 0, вернет все категории) [[Разработка:storages/departments | departments ]].
* $depth(int) - глубина вложения(по умолчанию 0. Если передана категория - берется по умолчанию глубина переданной категории).
* $path(string) - путь категорий.
* $select(bool) - false-возвратит массив, true - в виде дерева(иеархически, как правило для select-поля).
* $space(string) - разделитель для категорий(2 пробела по умолчанию)
* $depid - id записи из таблицы [[Разработка:storages/departments | departments ]]. Из какого подразделения брать категории(0 - из всех)
* $right(strinf) - права, на какие права нужно проверить категории
[[Категория:Оборудование]]

Разработка:storages/invcategories

2012-02-20T10:26:41Z

Dido86: /* Таблица в базе данных */

Разработка:storages/invcategories

2012-02-20T10:19:54Z

Dido86: /* Подробный формат полей в таблице: */

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

2012-02-20T10:13:14Z

Dido86: /* dof_calendar */

== Общие сведения ==
Библиотека ''moodleQuickForm'' (она же ''moodleform'') построена на основе библиотеки PEAR [http://pear.php.net/package/HTML_QuickForm HTML_QuickForm]. Описание работы всех функций moodleQuickForm следует искать именно по этой ссылке.

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

Перечисление всего того, что доступно в ''moodleQuickForm'' заняло бы слишком много места, поэтому перечислим только те задачи, которые при помощи этой библиотеки решить нельзя:
* создать форму в виде таблицы, в которой более 2-х столбцов
* создать длинную горизонтальную форму
Для всех остальных случаев построения форм следует использовать именно эту библиотеку.
== Внешний вид ==
Внешне все формы класса moodleform выглядят одинаково: это таблица из 2-х столбцов, и некоторого количества строк:

== Правила объявления формы ==
Установка всех элементов формы происходит либо в функции [[Разработка:moodleQuickForm#definition()|definition()]] (для статических форм), либо в функции [[Разработка:moodleQuickForm#definition_after_data()|definition_after_data()]] (для динамических форм).
== Описание стандартных методов moodleform ==
===== __construct($action, $customdata, $method, $target, $attributes, $editable) =====
Этот метод вызывается когда вы создаете новый объект формы.

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

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

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

===== setDefault('elementName', $value) =====
Установить значение ''$value'' по умолчанию для элемента ''elementName''.
$mform->addElement('hidden', 'имяэлемента');
$mform->setDefault('имяэлемента', $value);
В случае, если нужно установить значение по умолчанию для элемента внутри группы, то нужно использовать такой синтаксис
$mform->setDefault('имягруппы[имяэлемента]', $value);
Для элемента ''hierselect'' в качестве второго аргумента нужно указывать массив со значениями по умолчанию для каждого уровня:
$mform->setDefault('имяэлемента', array(14, 2, 8));

===== get_submitted_data($slashed) =====
Получить данные из формы, к которым еще не применены никакие проверки.
* $slashed - экранировать кавычки. По умолчанию true.
===== add_element($type, $name, $description, $attributes, $options) =====
Добавить элемент в форму. Наиболее часто используемая функция при построении формы.
$type - Тип элемента
$name - Имя элемента в форме. Только латинские буквы.
$description - Описание элемента. Выведется слева от него.
$attributes - строка с параметрами, вставляемая в html-тег элемента.
$options - массив с дополнительными параметрами. Назначение параметров зависит от типа элемента.

Поведение самой функции ''add_element'' также зависит от типа добавляемого элемента. Подробнее об этом - см. раздел [[Разработка:moodleQuickForm#Элементы формы|Элементы формы]].

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

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

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

Пример:
// создаем массив
$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) =====
Вставляет элемент перед уже ранее добавленным функцией [[Разработка:moodleQuickForm#add_element($type, $name, $description, $attributes, $options) | add_element()]]. Этот метод полезно применять в динамических формах, внутри функции [[Разработка:moodleQuickForm#definition()|definition()]] или [[Разработка:moodleQuickForm#definition_after_data()|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) =====
Добавить правило для отдельного поля. Эту функцию следует использовать для проверок на стороне клиента и простых проверок на стороне сервера. Для сложных проверок данных (например с использованием обращения к БД) используйте функцию [[Разработка:moodleQuickForm#validation($data, $files) | validation()]].

* $element - имя элемента, к которому применяется проверка
* $message - сообщение, в случае если проверка не пройдена
* $type - тип правила проверки (см. таблицу ниже)
* $format - дополнительные данные, требующиеся для некоторых проверок. По умолчанию null.
* $validation - на какой стороне производить проверку. Возможные значения:
** server - на стороне сервера (по умолчанию)
** client - на стороне клиента
* $reset - используется при проверке на стороне клиента. Сбрасывать ли данные в этом поле на значение по умолчанию, если введены неправильные данные? по умолчанию false (не сбрасывать).
* $force - применять ли проверку даже если проверяемый элемент не существует? По умолчанию false (не применять). Этот параметр используется для проверок в динамических формах.

{| border="1"
|+ Таблица типов правил для полей формы
! Имя
! Описание
! width="50%" |Пример кода
|-
|required
|Обязательное поле
|<pre>$mform->addRule('testname','Это поле является обязательным', 'required',null,'client');</pre>
|-
|minlength
|Минимальная длина значения в поле.
|<pre>$mform->addRule('testname','Слишком короткое значение', 'minlength', 10,'client');</pre>
|-
|maxlength
|Максимальная длина значения в поле.
|<pre>$mform->addRule('testname','Слишком длинное значение', 'maxlength', 256,'client');</pre>
|-
|rangelength
|Проверка длины значения с обеих сторон: например не больше 5 и не меньше 7. Параметры задаются массивом из двух элементов. В данном примере от 111 до 222.
|<pre>$mform->addRule('testname','Длина значения неправильна', 'rangelength', array(111, 222),'client');</pre>
|-
|email
|Проверка email-адреса
|<pre>$mform->addRule('testname','неправильный email', 'email',null,'client');</pre>
|-
|regex
|Проверка данных регулярными выражениями. Используется редко, в случае, когда обычных проверок недостаточно.
|
|-
|lettersonly
|Только латинские буквы.
|<pre>$mform->addRule('testname','Ошибка', 'lettersonly', null,'client');</pre>
|-
|alphanumeric
|Только латинские буквы и цифры
|<pre>$mform->addRule('testname','Ошибка', 'alphanumeric', null,'client');</pre>
|-
|numeric
|Целое или дробное число
|<pre>$mform->addRule('testname', 'В этом поле разрешены только числа', 'numeric', null, 'client');</pre>
|-
|nopunctuation
|В строке не должны присутствовать специальные символы. Список: '''()./*^?#!@$%+=,"'><~[]{}'''
|<pre>$mform->addRule('testname', 'Введены запрещенные символы', 'nopunctuation', null, 'client');</pre>
|-
|nonzero
|Ненулевое значение
|<pre>$mform->addRule('testname', 'Только ненулевые значения', 'nonzero', null, 'client');</pre>
|-
|callback
|Использовать пользовательскую функцию для проверки данных. Используется крайне редко, если у вас есть сложные проверки - то лучше используйте для них функцию [[Разработка:moodleQuickForm#validation($data, $files) | validation()]].
|
|-
|compare
|Сравнить два значения. Может использоваться для сравнения чисел и строк. Операторы, используемые для сравнения:
* '''==''' равно
* '''!=''' не равно
* '''>''' больше
* '''>=''' больше или равно
* '''<''' меньше
* '''<=''' меньше или равно
|<pre></pre>
|-
|uploadedfile
|
|
|-
|maxfilesize
|Проверка максимального значения файла для конкретного поля
|
|-
|mimetype
|Проверка mime-типа загруженного файла.
|
|-
|filename
|Проверка имени файла. Убираются все потенциально опасные символы.
|
|}

===== is_submitted() =====
Возвращает ''true'' если форма подтверждена кнопкой типа "submit", и ''false'' в противном случае. Обратите внимание, что кнопка "отмена" в форме также является кнопкой типа "submit", поэтому используйте для этих целей функцию is_canceled().
Для проверки того, что данные отправлены в форму, и корректно прошли все проверки на стороне сервера и клиента, можно использовать такую конструкцию:
<pre>
if ( $form->is_submitted() AND confirm_sesskey() AND $formdata = $form->get_data() AND ! $form->is_cancelled() )
{//даные переданы и прошли все проверки

....

}elseif( $form->is_cancelled() )
{// ввод данных отменен

....

}
</pre>
Здесь:
* ''$form->is_submitted()'' - проверка того, что данные в форме были отправлены кнопкой типа "submit"
* ''confirm_sesskey()'' - проверка того, что данные отправлены внутри текущей сессии (встроенная функция moodle)
* ''$formdata = $form->get_data()'' - получение данных формы, и одновременное подтверждение того, что данные прошли все проверки, не не нажата кнопка "отмена".

Также возможно сначала проверять is_canceled(), а потом is_submitted().

===== 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 можно посмотреть в статье [[Разработка:Константы_Moodle#Константы типов данных|константы типов данных]]

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

Используется для дополнительной проверки данных на стороне сервера. Все необходимые сложные проверки должны быть проведены именно здесь. Для простых проверок (на тип данных, проверка email-адреса и т. п.) используйте функцию [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force) | addRule()]]
* $data - массив вида array('имя_поля' => 'значение') из отправленных данных
* $files - массив загруженных в форму файлов. Имеет вид array('имя_поля' => 'путь_к_временному_файлу')

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

===== disabledIf($elementName, $dependentOn, $condition, $value) =====
Эта функция используется для того чтобы установить зависимости между полями формы. До тех пор пока одно поле формы не будет выделено, или в него не будет введено нужное значение, другое не станет активным.

К одному элементу формы можно применять несколько правил disabledIf. Несколько элементов могут зависеть от одного поля.
* $elementName - имя зависимого элемента.
* $dependentOn - имя элемента, чье состояние должно быть проверено условием $condition.
* $condition - по умолчанию 'notchecked'.
* $value - значение, используемое для проверки условия. По умолчанию "1".

{| border="1"
|+ Таблица вариантов условий для параметра $condition
! Значение
! Пояснение
|-
|''checked''
|Элемент выделен. Используется для элементов radio и checkbox. Не работает с элементами advcheckbox.
|-
|''notchecked''
|Элемент не выделен. Используется для элементов radio и checkbox. Не работает с элементами advcheckbox.
|-
|''eq''
|Значение указанного элемента равно значению указанному в параметре $value.
|-
|''noteq''
|Значение указанного элемента не равно значению указанному в параметре $value.
|-
|''noitemselected''
|В указанном html-элементе "select" ничего не выбрано.
|}
===== applyFilter($elementName, $functionName); =====
Применить проверку элементу формы.

Параметры
* ''$elementName'' - название элемента внутри формы. В качестве имени можно использовать специальное значение '''__ALL__''' чтобы применить проверку ко всем элементам.
* ''$functionName'' - название функции (без скобок и аргументов), которая должна быть применена к этому элементу

Пример:
// применение проверки ко всем элементам
$mform->applyFilter('__ALL__', 'trim');

// применение проверки к одному элементу
$mform->applyFilter('lastname', 'addslashes');
===== closeHeaderBefore($elementName) =====
Закрыть рамку формы до элемента с указанным именем. Эта функция позволит вам выносить нижние элементы "за пределы" визуальной рамки формы, а также добавлять элементы без заголовка.
Иными словами, эта функция закрывает тег [http://htmlbook.ru/html/fieldset.html <FIELDSET>].
Эта функция должна быть обязательно вызвана ПОСЛЕ добавления элемента, перед которым закрывается рамка формы.

Пример:
// добавляем элемент формы
$mform->addElement('text', 'name', $this->dof->get_string('name','plans').':');
// Выносим его, и следующие элементы за рамку формы
$mform->closeHeaderBefore('name')

== Элементы формы ==
Во всех приведенных примерах переменная $form обозначает ссылку на объект HTML_QuickForm. Подробнее об этом в описании функции [[Разработка:moodleQuickForm#definition() |definition()]]. Во всех текстовых полях (кроме кнопок) можно использовать html-теги форматирования.

=== header ===
Заголовок формы. Этот заголовок будет говорить об общем содержании данных в форме. Также он используется в случае, когда вам нужно разбить форму на несколько частей.
Если вам нужно закрыть рамку заголовка перед каким-либо элементом, используйте функцию [[#closeHeaderBefore($elementName) |closeHeaderBefore()]]
<pre>$mform->addElement('header','testname', 'Текст заголовка');</pre>

=== checkbox ===
Стандартный html-элемент checkbox.
<pre>$mform->addElement('checkbox', 'testname', 'Текст_перед_галочкой', 'Текст_после галочки');</pre>

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

=== group ===
Добавление группы элементов. Для того, чтобы добавить группу элементов, их нужно предварительно создать при помощи функции [[Разработка:moodleQuickForm#create_element($type, $name, $description, $attributes, $options)|create_element()]]
Параметры (в порядке перечисления):
* тип
* название элемента
* пояснение
* массив с элементами
* разделитель для элементов (в примере - тег <br>)
* добавить ли имя группы к имени элемента (true - добавить)
<pre>
// создаем массив
$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, '<br>', true);
</pre>

=== password ===
Стандартный html-элемент password
<pre>mform->addElement('password', 'testname', 'Текст перед окном с паролем');</pre>

=== passwordunmask ===
То же самое, что и элемент password, но с дополнительной галочкой "отобразить пароль".
<pre>$mform->addElement('passwordunmask', 'testname', 'Текст перед окном с паролем');</pre>

=== radio ===
Стандартный html-элемент radio. Единственный элемент в quickform, несколько объектов которого можно добавить, используя одинаковое значение name.
<pre>$mform->addElement('radio', 'testname', 'Текст до переключателя 1',
'Текст после переключателя 1', 'Значение1');
$mform->addElement('radio', 'testname', 'Текст до переключателля 2',
'Текст после переключателя 2', 'Значение2');</pre>

=== select ===
Стандартный html-элемент select. Массив $choices содержит варианты для оператора select. Значениями массива являются текстовые надписи в списке выбора, а ключами - значения этих вариантов.
<pre>
// создаем массив с вариантами выбора
$choices = array('a' => 'Текст варианта 1', 'b' => 'Текст варианта 2');

// Добавляем элемент формы
$mform->addElement('select', 'testname', 'Пояснение для строки выбора', $choices);
</pre>
==== Дополнительные функции ====
Элемент select обладает дополнительными методами, которые
* addOption($text, $value, $attributes=null) - добавить новый вариант к select-элементу, уже после того как он был создан, и в него были установлены значения. Параметры:
** $text - текст, который отображается пользователю
** $value - значение, которое передается из формы
** $attributes - дополнительные html-атрибуты тега OPTION (если требуется). Передаются строкой, либо массивом в формате ключ-значение.
Пример:
<pre>
$select = $mform->getElement('testname');
$select->addOption('Текст для отображения', 555);
</pre>

=== selectgroups ===
=== submitlink ===
=== text ===
Стандартный html-элемент text. Последний параметр - строка html-атрибутов. В данном примере длина поля задана 100%. Это гарантирует, что элемент будет нормально выглядеть и умещаться в форму при любых размерах экрана.
<pre>$mform->addElement('text', 'testname', 'Пояснение для текстового поля', ' width="100%" ');</pre>
=== textarea ===
Стандартный html-элемент textarea. Значения ширины и высоты задаются в виде массива, последним аргументом. Ширину поля также рекомендуется задавать 100%.
<pre>$mform->addElement('textarea', 'testname', 'Пояснение:', array('width'=>'100%', 'height'=>'100px'));</pre>
=== date_selector ===
Диалоговое окно с выбором даты. Обратите внимание, что при получении данных через [[Разработка:moodleQuickForm#get_data($slashed)|get_data()]] значение этого поля автоматически трансформируется в метку unixtime на 12:00:00 дня выбранной даты. По умолчанию выставляется текущая дата и время. Другое начальное значение может быть задано при помощи функции [[Разработка:moodleQuickForm#setDefault($elementName, $defaultValue, $slashed)|setDefault()]].
<pre>
$options = array();// объявляем массив для установки значений по умолчанию
$options['startyear'] = 1980; // устанавливаем год, с которого начинать вывод списка
$options['stopyear'] = 2001; // устанавливаем год, которым заканчивается список
$options['optional'] = false; // убираем галочку, делающую возможным отключение этого поля

$mform->addElement('date_selector', 'testname', 'Пояснение для поля даты', $options);
// устанавливаем время по умолчанию на год вперед
$mform->setDefault('testname', time()+3600*24*365);
</pre>
=== date_time_selector ===
Этот элемент аналогичен элементу date_selector, только добавлены параметры часов и минут. Полученные данные также трансформируются в unixtime, но уже для выбранных значений часов и минут. По умолчанию выставляется текущая дата и время. Другое начальное значение может быть задано при помощи функции [[Разработка:moodleQuickForm#setDefault($elementName, $defaultValue, $slashed)|setDefault()]].
<pre>
$options = array();// объявляем массив для установки значений по умолчанию
$options['startyear'] = 1980; // устанавливаем год, с которого начинать вывод списка
$options['stopyear'] = 2001; // устанавливаем год, которым заканчивается список
$options['optional'] = false; // убираем галочку, делающую возможным отключение этого поля

$mform->addElement('date_time_selector', 'testname', 'Пояснение для поля даты', $options);
</pre>
=== htmleditor ===
Полноценный html-редактор для редактирования страниц. Его вид (обычный или расширенный) настраивается индивидуально каждым пользователем для себя (в настройках профиля moodle). Обратите внимание, что в качестве дополнительных параметров можно массивом передать значения ширины и высоты текстового поля.
<pre>
$mform->addElement('htmleditor', 'testname', 'Пояснение:', array('width'=>'100%', 'height'=>'200px')

</pre>
=== format ===
Выбор формата для редактирования сообщения. Полезно использовать вместе со встроенным html-редактором.
<pre>$mform->addElement('format', 'testname', 'Текст пояснения');</pre>
=== static ===
Обычное текстовое поле, не передает никаких данных. Полезно использовать для различных пояснений и отображения текущей информации о каком-либо объекте. Вы также можете использовать этот элемент для разбиения формы на небольшие смысловые блоки, не разрывая рамку формы. Для более явного разбиения используйте элемент header.
<pre>$mform->addElement('static', 'testname', 'Пояснение:', '<b><i>Само текстовое значение</i></b>');</pre>
=== hidden ===
Стандартный html-элемент hidden, скрытое поле для передачи служебных id, адресов для перенаправления и т. д. Помните о необходимости проверки значений из этого поля.
<pre>$mform->addElement('hidden','testname', 'Значение скрытого поля');</pre>
=== modvisible ===
Установить модуль видимым/скрытым. Только для использования внутри Mooodle.
=== selectyesno ===
Элемент с двумя стандартными select-вариантами выбора: да и нет.
<pre>
$mform->addElement('selectyesno', 'testname', 'Текст пояснения');
// установить значение по умолчанию "да"
$mform->setDefault('stoponerror', 1);
</pre>
=== modgrade ===
Шкала выставление оценки за задание. Только для использования внутри Moodle.
=== cancel ===
Кнопка "отменить форму". При нажатии на нее происходит отмена всех произведенных в форме действий.
<pre>$mform->addElement('cancel', 'testname', 'Надпись на кнопке'); </pre>
=== button ===
Элемент аналогичен кнопке типа submit, но при использовании button пропускается проверка данных на стороне клиента.
<pre>$mform->addElement('button', 'testname', 'Надпись на кнопке');</pre>
=== choosecoursefile ===
Выбрать файл из курса. Только для использования внутри курса Moodle.
=== submit ===
Кнопка отправки данных из формы. Обязательно ставьте ее в конце, иначе все введенные данные нельзя будет отправить. Существует также альтернативный способ задать такую кнопку - это функция [[Разработка:moodleQuickForm#add_action_buttons($cancel, $submitlabel)|get_data()]]
<pre>$mform->addElement('submit', 'testname', 'Текст на кнопке');</pre>
=== questioncategory ===
Выбрать вопрос из категории. Только при редактировании теста и только внутри курса Moodle.
=== advcheckbox ===
Элемент checkbox c расширенными функциями - такие элементы можно объединять в группы и устанавливать им контрольный переключатель (делает либо все галочки поставлеными либо снятыми) при помощи функции [[Разработка:moodleQuickForm#add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue) |add_checkbox_controller()]].

Поскольку таких галочек всегда задается несколько - то целесообразно в указании имени элемента использовать квадратные скобки, чтобы собрать значения всех элементов в один массив. Последним аргументом задается группа, к которой принадлежит созданный элемент. Именно это значение должно быть указано в первом параметре функции [[Разработка:moodleQuickForm#add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue) |add_checkbox_controller()]].

Несовместим с функцией [[Разработка:moodleQuickForm#disabledIf($elementName, $dependentOn, $condition, $value) | disabledIf()]]

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

$mform->addElement('advcheckbox', 'testname[2]', 'Описание:', 'Текст за галочкой', array('group' => 'id_группы'));
</pre>
=== recaptcha ===
Окно с картинкой для использования Capcha проверки. Обратите внимание, что для того чтобы использовать этот элемент вы сначала должны получить уникальный ключ с на сайте <nowiki>http://recaptcha.net/api/getkey</nowiki>.
<pre>$mform->addElement('recaptcha', 'testname', 'Текст с пояснением');</pre>
=== hierselect ===
Несколько зависимых друг от друга html-элементов типа "select". В зависимости от выбранной опции в первом элементе, меняются значения остальных.
При вызове функции addElement в последнем параметре указывается, какими символами разделять операторы select.
<pre>
// для начала создадим два массива - по количеству операторов select
// которые нам предстоит создать

// Первый, главный элемент select
$select1[0] = 'Pop';
$select1[1] = 'Classical';
$select1[2] = 'Funeral doom';

// второй элемент select - его варианты зависят от первого
$select2[0][0] = '--- Artist ---';
$select2[0][1] = 'Red Hot Chil Peppers';
$select2[0][2] = 'The Pixies';

$select2[1][0] = '--- Artist ---';
$select2[1][1] = 'Wagner';
$select2[1][2] = 'Strauss';

$select2[2][0] = '--- Artist ---';
$select2[2][1] = 'Pantheist';
$select2[2][2] = 'Skepticism';

// добавляем новый элемент в форму
$myselect =& $mform->addElement('hierselect', 'testname', 'Текст с пояснением:',null,'<br>');
// устанавливаем для него варианты ответа
$myselect->setOptions(array($select1, $select2));
// устанавливаем значения по умолчанию: 'Funeral doom'->'Pantheist'
$mform->setDefault('testname', array(2, 1));
</pre>
=== html ===
Добавить собственный html-код. Используйте этот тип элементов формы, только в случае, если ни один из перечисленных элементов вам не подходит, или нужно решить какую-либо нетривиальную задачу с форматированием.
Может помочь в случае решения задачи разбиения формы на 3, или более колонок ([http://docs.moodle.org/en/User:Frank_Ralf/Moodle_forms3] [http://moodle.org/mod/forum/discuss.php?d=126935]).
<pre>$mform->addElement('html', '<div class="qheader">');</pre>
=== autocomplete ===
Элемент, который автоматически подсказывает варианты по мере набора текста. Выглядит как обычный элемент text, но имеет встроенный javascript. Значение по умолчанию устанавливается стандартным образом.
<pre>// Создаем массив подсказок
$options = array('апельсин', 'ананас', 'авокадо');
// добавляем новый элемент в форму
$element =& $mform->addElement('autocomplete', 'testname', 'Текст с пояснением:', 'size=12');
// устанавливаем массив подсказок
$element->setOptions($options);
</pre>

=== dof_calendar ===
Элемент, который автоматически отображает 2 календаря для выбора диапазона дат. Календари находятся на одной линии. Под каждым календарем поле-указывает в формате д.м.гг дату, которая выбрана на календаре. В скрытое поле каждого календаря помещается время в unixtime, причем первый календарь (слева) отсчитывает время от 00.00.01, а второй (справа) с 23.59.59. Если на правом и на левом календарях отмечена одна дата, то диапазон, соответственно, равен 00.00.01-23.59.59, что полностью охватывает выбранный день.
Так же, у этого элемента есть возможность удаления тегов, как правил это select-поля(старый вариант выбора дат). Для этого нужно в $options указать имена этих полей

'''Пример:'''
<pre>
// добавляем новый элемент в форму
$element = $mform->addElement('dof_calendar', 'calendarname', 'Текст с пояснением:', $options),где
'Текст с пояснением:' - Текст, который будет выведен выше календарей
$options - массив, с указанием дат(левый и правый календарь)
* $options['date_from'] - с какой даты брать отсчет(левый календарь)(unix time)
* $options['date_to'] - по какую дату брать отсчет(правый календарь)(unix time)
-------------
* $options[] = 'field_from'; (элемент будет удален $mform->addElement('date_selector', 'field_from',$this->dof->modlib('ig')->igs('from'),$options); )
* $options[] = 'field_to'; (элемент будет удален $mform->addElement('date_selector', 'field_to',$this->dof->modlib('ig')->igs('from'),$options); )
</pre>
Если параметр options опущен, то берется текущая дата.
Важно !! При объявлении времени, нужно брать массив именно с этими параметры(date_from, date_to).
Выходные данные имеют вид
<pre>
[calendarname] = Array
[date_from] = ... (unux time)
[date_to] = ... (unux time)
</pre>

=== dof_autocomplete ===
Элемент с выпадающим списком подсказок по мере набора текста. Выглядит как обычный элемент text, но имеет встроенный javascript. В помощь с ним создается автоматически hidden поле, значение которого будет равно индексу выбранного элемента(name="id_autocomplete" id="id_hidden_auto"). В dof_autocomplete есть обязательные параметры, работа без которых не возможна. Записываются они в переменную массив <b>$options</b>. В неё же и помещается массив option(ключ=>значени), это так называемые значения по умолчанию(не обязательные).
*Список обязательных полей для переменной $options:
**plugintype - тип плагина ( например storage)
**plugincode - код плагина ( например plans)
**queryty - тип запроса, именно по нему и определяется, что надо делать( например plans_name ). Этот тип должен совпадать с типом, который будет находиться в этом в плагине в методе widgets_field_variants_list
**sesskey - ключ сессии(чтоб идентифицировать запрос) задается методом sesskey()
**type - тип действия ( например autocomplete ). Есть ещё тип savefield
*Необязательные поля:
**option - массив значений по умолчания( например $a[19]= "primer"), где ключ - это id элемента из бд

<pre> $mform->addElement('dof_autocomplete', $elementName = null, $elementLabel = null, $attributes = null, $options = null)
//Создаем массив входных данных
$options = array();
$options['plugintype'] = "storage";
$options['plugincode'] = "plans";
$options['querytype'] = "plans_name";
$options['sesskey'] = sesskey();
$options['type'] = 'autocomplete';
// установим значение по умолчанию
$mas = array( 19 => 'primer' );
$options['option'] = $mas;

// добавляем новый элемент в форму
$mform->addElement('autocomplete', 'testname', 'Текст перед полем:', 'size=12', $options);
// устаонвка типа
$mform->setType('testname', PARAM_TERXT);
</pre>
*Замечение:
**следует помнить, что элемент autocomplete сам в себе подключает js-библиотеки, и потому, объявление класса на странице должно быть ''раньше'', чем печать шапки страницы
**выходные данные имеют вид
<pre>
[testname] = Array
[testname] = полученное значение
[id_autocomplete] = id значения
</pre>
Необходимые методы:
Плагин, данные которого будут составлять автозаполнение должен иметь метод <b>widgets_field_variants_list($querytype, $data="")</b>, который возвращает массив объектов в формате <pre>
$a = arrya();
a[1] = object[
name = ЗНАЧЕНИЕ_1 ДЛЯ ВЫПАДАЮЩЕГО СПИСКА
id = id элемента_1
];
a[2] = object[
name = ЗНАЧЕНИЕ_2 ВЫПАДАЮЩЕГО СПИСКА
id = id элемента_2
];
...
]
</pre>где $querytype-тип запроса(обрабатывается путем case), $data-вх данные, как правило строка(набранные данные в поле autocomplete)
* Замечание:
** поля name и id обязательны в переданном массиве
** метод должен возвращать с LIMIT 15(не больше), для быстроты работы

=== dof_duration ===
Элемент для задания длительности временного интервала в часах, днях, неделях, и т. п.
<pre>
// задаем возможные единицы измерения: часы и минуты
$options['availableunits'] = array(60 => $this->dof->modlib('ig')->igs('minutes'),
3600 => $this->dof->modlib('ig')->igs('hours'));
// добавляем сам элемент
$mform->addElement('dof_duration', 'testname', 'Текст с пояснением:', $minutesoptions);
</pre>
=== dof_single_use_submit ===
Одноразовая submit-кнопка. Отправляет данные формы и сразу же становится неактивной, для того чтобы избежать повторного нажатия и отправки данных (doubleclick). Имеет дополнительный метод setPleaseWaitText(), при помощи которого можно устанавливать надпись, которая появляется после нажатия на кнопку.
<pre>
// создаем кнопку, с надписью "сохранить"
$submit = &$mform->addElement('dof_single_use_submit', 'testsinglesubmit', $this->dof->modlib('ig')->igs('save'));
// Устанавливаем сообщение после нажатия - "обработка"
$submit->setPleaseWaitText($this->dof->modlib('ig')->igs('processing'));
</pre>

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

=== Установка обязательных полей ===
Установка обязательных полей происходит при помощи функции [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force)|addRule()]].

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

=== Установка дополнительных полей ===
Установка дополнительных полей производится при помощи функции [[Разработка:moodleQuickForm#setAdvanced($elementName, $advanced)|setAdvanced()]]. Необязательные элементы должны располагаться один за другим.

Пример:
// устанавливаем два текстовых поля и делаем их необязательными
$mform->addElement('text', 'my_field1', 'Пояснение :');
$mform->setAdvanced('my_field1');
$mform->addElement('text', 'my_field2', 'Пояснение :');
$mform->setAdvanced('my_field2');

=== Установка проверки на стороне клиента или сервера ===
По умолчанию все данные из формы подлежат проверке на стороне сервера. Существует возможность добавить проверку на стороне клиента. Не забывайте при этом, что эти данные нужно потом все равно еще раз проверить на стороне сервера, так как всегда существует возможность послать данные в обход формы.
==== Проверка на стороне сервера ====
Если вам требуется дополнительная проверка данных на стороне клиента, то используйте стандартный метод [[Разработка:moodleQuickForm#validation($data, $files) | validation()]]. Любые другие способы проверки данных после формы должны использоваться только в исключительных случаях.

==== Проверка на стороне клиента ====
Все малозначимые проверки желательно производить на стороне клиента для увеличения быстродействия приложения. Все проверки на стороне клиента производятся при помощи функции [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force)|addRule()]].

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

Пример:
// устанавливаем поле "фамилия"
$mform->addElement('text', 'lastname', 'Фамилия :');
// делаем его обязательным
$mform->addRule('lastname','Это поле является обязательным', 'required',null,'client');
=== Установка зависимых полей ===
==== Стандартный вариант ====
Установка зависимых полей производится при помощи функции [[Разработка:moodleQuickForm#disabledIf($elementName, $dependentOn, $condition, $value)|disabledIf()]].

Пример:
// Устанавливаем элемент checkbox
$mform->addElement('checkbox', 'my_checkbox', get_string('forcedownload', 'resource'));
// устанавливаем текстовое поле
$mform->addElement('text', 'my_field', 'Пояснение :');
// устанавливаем зависимость
$mform->disabledIf('my_field', 'my_checkbox', 'checked');
==== Расширенный вариант ====
Для html-элеметов "select", есть возможность установить иерархическую зависимость элементов (то есть в зависимости от того, что было выбрано в первом "select", меняются значения в остальных). Синтаксис этого элемента указан в разделе [[Разработка:moodleQuickForm#Элементы формы|Элементы формы]] (в самом конце, он называется hierselect).

== Известные проблемы ==
В этом разделе собраны обнаруженные проблемы с элементами формы и способы их решения.
=== Данные не приходят из поля формы, даже в validation ===
Возможно на странице обработчика формы есть функция optional_param (или required_param) которая называется точно также как поле в форме. Если это так, то указанное поле из данных формы пропадет.
=== text ===
* Поле ввода слишком широкое, слишком узкое, или вылезает за границы заголовка
** Решение: Нужно в свойства элемента добавить style="width:100%;". В этом случае элемент растянется до конца формы, и не будет вылезать за границы формы вне зависимости от того - большой монитор у пользователя или маленький.
** Пример:
<pre>
$mform->addElement('select', 'my_select', 'Description...', $options, ' style="max-width:400px;width:100%;" ');
</pre>
=== textarea ===
* Поле ввода слишком широкое, слишком узкое, или вылезает за границы заголовка
** Решение: Нужно в свойства элемента добавить style="width:100%;". В этом случае элемент растянется до конца формы, и не будет вылезать за границы формы вне зависимости от того - большой монитор у пользователя или маленький.
** Пример:
<pre>
$mform->addElement('textarea', 'name', 'Description...', array('style' => 'width:100%;max-width:400px;height:150px;'));
</pre>
=== hierselect ===
* Не работает Javascript если в качестве значения hierselect используются цифры
** Решение: в списке значений после цифры добавлять пробел, или любой другой символ.
** Пример: array('1' => '''"1 "'''); вместо array('1' => '''"1"''');
* Невозможно отключить только одно поле hierselect не отключая при этом остальные
** Решение: отсутствует.
* При количестве select-элементов 3 или больше портится верстка. Подписи к select-элементам не совпадают с самими элементами.
** Решение: до элемента hierselect вставить html-элемент который содержит div, устанавливающий фиксированный межстрочный интервал (см. пример). После добавления hierselect-элемента закрыть div.
** Пример:
<pre>
// выравниваем строки по высоте
$mform->addElement('html', '<div style=" line-height: 1.9; ">');

// Дальше идет объявление hierselect...
// ...

// закрываем тег выравнивания строк
$mform->addElement('html', '</div>');
</pre>
* При указании строковых ключей массива hierselect не работает. Это происходит из-за того что в Javascript мы можем иметь дело либо с индексированными массивами, либо с объектами. Ассоциативные массивы там не предусмотрены.
** Решение: не использовать ассоциативные ключи массивов при создании элементов hierselect. Если же обойтись без них никак нельзя - то можно закодировать ассоциативные элементы числами ('option1' - 1, 'option2' - 2 и т. д.), а на стороне обработчика раскодировать обратно.
* По неизвестным причинам иногда перестает работать переключение с одной опции на другую.
** Решение: скорее всего в списке дочерних опций присутствуют элементы не для всех родительских опций (см. пример). Для каждой опции верхнего уровня должен присутствовать хотя бы один элемент нижнего уровня.
** Пример:
'''Неправильный код:'''
<pre>
$level1 = array();
$level1[0] = 'option0';
$level1[1] = 'option1';

$level2 = array();
$level2[1][0] = 'option1_0';
$level2[1][1] = 'option1_1';
</pre>
'''Правильный код:'''
<pre>
$level1 = array();
$level1[0] = 'option0';
$level1[1] = 'option1';

$level2 = array();
$level2[0][0] = 'option0_0'; // без этой строки ничего не будет работать
$level2[1][0] = 'option1_0';
$level2[1][1] = 'option1_1';
</pre>
* Данные из поля hierselect передаются вне зависимости от того, было отключено поле или нет.
** Решение: отсутствует.
* При проверке данных в функции validation() нельзя сообщить о том, что ошибка произошла внутри какого-то конкретного select-элемента.
** Решение: отсутствует. Можно указать только указывать сам hierselect-элемент как источник ошибки, и сообщить подробности в сообщении.

=== hidden ===
* Не работает правило disabledif. Невозможно установить значение из hidden-поля для использования disabledif-правила.
** Решение: создать другой элемент (например checkbox), записать в него нужное значение, и в стилях установить ему display:none
** Пример:
<pre>
$mform->addElement('radio', 'hidden_hack', '', '', 'true', 'style' => 'display:none;');
</pre>

== Ссылки ==
* [http://pear.php.net/manual/en/package.html.html-quickform.php Справка по базовым методам класса HTML_QuickForm]
* [http://docs.moodle.org/en/Development:lib/formslib.php_Form_Definition Справки по элементам класса moodleform]
* [http://web.archive.org/web/20080214041550/http://www.midnighthax.com/quickform.php Getting Started Guide по элементам оригинального класса HTML_QuickForm. Некоторые обращения к методам могут отличаться от moodleform.]
* [http://wiki.triangle-solutions.com/index.php/PEAR_HTML_QuickForm] Примеры объявления элементов.

Разработка:storages/invitems

2012-02-17T14:54:25Z

Dido86:

Разработка:im/inventory

2012-02-17T14:54:00Z

Dido86:

Разработка:im/inventory

2012-02-17T14:52:52Z

Dido86: /* Права */

Разработка:im/inventory

2012-02-17T14:45:18Z

Dido86: /* Возврат комплекта */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача комплектов(оборудования) ==
Выдача комплекта происходит с указанием конкретной персоны, кому вручается этот комплект. Все данные сохраняются в приказ.

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат комплекта ==
Осуществляется лишь со страницы просмотра комплекта. Есть форма возврата комплекта с подтверждением(галочка) этого шага. Всё осуществляется одним нажатием на кнопку. Комплект снова принимает статус активно(готово для использования). Данные записываются в приказ.

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

Оборудование из комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

== Списание оборудования ==
Как и поступление, списание производится через приказы. При этом оборудование не должно состоять в комплекте. На стр списания в форме указываются(перечисляются) инвентарные номера. При принятие действия оборудование принимает статус scrapped(списано) и использоваться больше не может.

== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:42:27Z

Dido86: /* Создание дерева категорий */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача комплектов(оборудования) ==
Выдача комплекта происходит с указанием конкретной персоны, кому вручается этот комплект. Все данные сохраняются в приказ.

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат комплекта ==
Осуществляется лишь со страницы просмотра комплекта. Есть форма возврата комплекта с подтверждением(галочка) этого шага. Всё осуществляется одним нажатием на кнопку. Комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

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

Оборудование из комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

== Списание оборудования ==
Как и поступление, списание производится через приказы. При этом оборудование не должно состоять в комплекте. На стр списания в форме указываются(перечисляются) инвентарные номера. При принятие действия оборудование принимает статус scrapped(списано) и использоваться больше не может.

== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:41:36Z

Dido86: /* Списание оборудования */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача комплектов(оборудования) ==
Выдача комплекта происходит с указанием конкретной персоны, кому вручается этот комплект. Все данные сохраняются в приказ.

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат комплекта ==
Осуществляется лишь со страницы просмотра комплекта. Есть форма возврата комплекта с подтверждением(галочка) этого шага. Всё осуществляется одним нажатием на кнопку. Комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

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

Оборудование из комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

== Списание оборудования ==
Как и поступление, списание производится через приказы. При этом оборудование не должно состоять в комплекте. На стр списания в форме указываются(перечисляются) инвентарные номера. При принятие действия оборудование принимает статус scrapped(списано) и использоваться больше не может.

== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:40:58Z

Dido86: /* Списание оборудования */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача комплектов(оборудования) ==
Выдача комплекта происходит с указанием конкретной персоны, кому вручается этот комплект. Все данные сохраняются в приказ.

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат комплекта ==
Осуществляется лишь со страницы просмотра комплекта. Есть форма возврата комплекта с подтверждением(галочка) этого шага. Всё осуществляется одним нажатием на кнопку. Комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

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

Оборудование из комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

== Списание оборудования ==
Как и поступление, списание производится через приказы. При этом оборудование не должно состоять в комплекте. На стр списания в форме указываются(перечисляются) инвентарные номера. При принятие действия оборудование принимает статус scrapped(списано) и использоваться больше не будет.

== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:29:31Z

Dido86: /* Выдача комплектов(ообрудования) */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача комплектов(оборудования) ==
Выдача комплекта происходит с указанием конкретной персоны, кому вручается этот комплект. Все данные сохраняются в приказ.

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат комплекта ==
Осуществляется лишь со страницы просмотра комплекта. Есть форма возврата комплекта с подтверждением(галочка) этого шага. Всё осуществляется одним нажатием на кнопку. Комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

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

Оборудование из комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:29:05Z

Dido86: /* Расформирование комплекта */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача комплектов(ообрудования) ==
Выдача комплекта происходит с указанием конкретной персоны, кому вручается этот комплект. Все данные сохраняются в приказ.

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат комплекта ==
Осуществляется лишь со страницы просмотра комплекта. Есть форма возврата комплекта с подтверждением(галочка) этого шага. Всё осуществляется одним нажатием на кнопку. Комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

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

Оборудование из комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:26:49Z

Dido86:

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача комплектов(ообрудования) ==
Выдача комплекта происходит с указанием конкретной персоны, кому вручается этот комплект. Все данные сохраняются в приказ.

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат комплекта ==
Осуществляется лишь со страницы просмотра комплекта. Есть форма возврата комплекта с подтверждением(галочка) этого шага. Всё осуществляется одним нажатием на кнопку. Комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

== Расформирование комплекта ==

== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:25:26Z

Dido86: /* Создание дерева категорий */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача комплектов(ообрудования) ==
Выдача комплекта происходит с указанием конкретной персоны, кому вручается этот комплект. Все данные сохраняются в приказ.

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат комплекта ==
Осуществляется лишь со страницы просмотра комплекта. Есть форма возврата комплекта с подтверждением(галочка) этого шага. Всё осуществляется одним нажатием на кнопку. Комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:23:43Z

Dido86: /* Выдача оборудования */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача комплектов(ообрудования) ==
Выдача комплекта происходит с указанием конкретной персоны, кому вручается этот комплект. Все данные сохраняются в приказ.

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат комплекта ==
Осуществляется лишь со страницы просмотра комплекта. Есть форма возврата комплекта с подтверждением(галочка) этого шага. Всё осуществляется одним нажатием на кнопку. Комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:23:07Z

Dido86: /* Возврат оборудования */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

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

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат комплекта ==
Осуществляется лишь со страницы просмотра комплекта. Есть форма возврата комплекта с подтверждением(галочка) этого шага. Всё осуществляется одним нажатием на кнопку. Комплекта снова принимает статус активно(готово для использования). Данные записываются в приказ.

== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:19:36Z

Dido86: /* Выдача оборудования */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

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

Комплект можно выдать как со страницы просмотра этого комплекта, так и со спец страницы выдачи комплектов, где выбирается комплект, выбирается персона, указывается нужный комментарий, если необходим, и создается привязка персоны к комплекту.

== Возврат оборудования ==
== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:08:02Z

Dido86: /* Выдача оборудования */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

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

== Возврат оборудования ==
== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:06:49Z

Dido86: /* Формирование комплектов */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласно иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача оборудования ==
== Возврат оборудования ==
== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:06:35Z

Dido86: /* Формирование комплектов */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов.

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

Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласон иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача оборудования ==
== Возврат оборудования ==
== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:05:27Z

Dido86: /* Формирование комплектов */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
Формирование комплектов осуществляется приказом , в котором хранятся все параметры. Сформировать можно как 1 так и несколько комплектов. При формировании 1 комплекта есть возможность вручную задавать оборудование, что очень полезно, когда нужно, чтоб именно это оборудование с этим инвентарным номером было в комплекте. Пользователь указывает число комплектов(сколько нужно сформировать), сколько оборудования будет в 1 комплекте, из каких категории. Система автоматически берет первое свободное оборудование из данной категории и помещает его в комплект. Если оборудования нет - берет из дочерней категории согласон иерархии дерева категорий и т.д. Если хоть 1 комплект не будет полным(не хватит оборудования на n-ное количество комплектов), то система сразу скажет об этом и не будет вовсе их формировать.

== Выдача оборудования ==
== Возврат оборудования ==
== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:01:32Z

Dido86: /* Создание дерева категорий */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
Мебель
Стулья
стулья марки Sunrise
стулья марки Schiva
Столы
Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
== Выдача оборудования ==
== Возврат оборудования ==
== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T14:01:01Z

Dido86: /* Создание дерева категорий */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Категории и имеют иерархическую структуру:
<pre>
-Мебель
--Стелья
---стулья марки Sunrise
---стулья марки Schiva
--Столы
-Компьютеры
</pre>
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
== Выдача оборудования ==
== Возврат оборудования ==
== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:im/inventory

2012-02-17T13:58:04Z

Dido86: /* Создание дерева категорий */

{{Infobox_Plugin
| name = inventory
| type = im
}}

=Ресурсы и инвентарь=
Этот плагин предназначен для учета и отслеживания использования оборудования и других ресурсов, которыми обладает организация.
= Сценарии использования =
Взаимодействие с оборудованием и людьми разбито на несколько стандартных сценариев, которые описаны ниже.
== Создание дерева категорий ==
Каждый комплект или оборудование приписаны к той или иной категории.
Перед тем как начать регистрировать новые ресурсы рекомендуется сначала создать дерево категорий ресурсов, которыми обладает ваша организация. Однако, если вы не нуждаетесь в иерархической структуре хранимого оборудования - то этот шаг можно пропустить: категории также могут быть созданы при поступлении оборудования и создании комплектов.

== Поступление оборудования ==
Единственный способ добавить оборудование в систему - это приказ о приходе, поэтому заполнение системы данными об оборудовании начинается с составления этого приказа.

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

Приказ хранит в себе весь список поступившего оборудования и подписывается цифровой подписью.
После исполнения приказ навсегда остается в системе, и его можно в любой момент просмотреть.
== Формирование комплектов ==
== Выдача оборудования ==
== Возврат оборудования ==
== Списание оборудования ==
== Отчеты ==
* Отчет по использованию оборудования организацией (информация о том, какое количество оборудования есть в наличии, что используется а что нет)
* Отчёт по использованию оборудования людьми (информация о том, какое оборудование когда кем и кому было выдано, и где сейчас находится)
= Права =

Экраны интерфейса пользователя:

* Реестр ресурсов (по подразделению или по всей организации). Отображает список ресурсов из invitems, сгруппированный по дереву категорий. По умолчанию не отображаются ресурсы в статусе "списан": после имени категории идет таблица со списком ресурсов. Ссылки на форму импорта/экспорта ресурсов. На против каждого ресурс - ссылка на экран редактирования партии ресурса.
* Импорт/экспорт ресурсов. Форма для импорта включает поле отправки файла, и выпадающие меню для выбора подразделения (по-умолчанию - все), к которому будут приписаны ресурсы и категории по-умолчанию, если в файле для ресурса не указан код категории. Импортированные ресурсы добавляются в таблицу invitems со статусом "поступил". Форма экспорта включает выподающее меню выбора подразделения (по-умолчанию - все) поля выбора даты начала и конца периода, за который будут отображаться поступившие и списанные в данном промежутке ресурсы, галочку игнорирования периода, выпадающее меню для выбора статуса ресурса (по-умолчанию - все). Для штучных ресурсов отображается название пакета, в который они включены.
* Форма редактирования партии ресурса отображает параметры партии ресурса, список операций по таблице invoperations с данным ресурсом. Форму смены статуса ресурса.
* Список пакетов ресурсов (по подраздалению, либо глобально). Пакеты сгрупированы по дереву категорий. Напротив каждого пакета ссылка "редактировать".
* Форма редактирования параметров и состава пакета ресурса. Редактирование параметров и статуса пакета. Список включенных ресурсов/категорий с полем ввода "количество" напротив каждого из них. Если ресурс является штучным, поле "количество" не доступно для редактирования. Под списком ресурсов кнопка "сохранить изменения количества". Ниже дерева категорий ресурсов, принадлежащих данному структурному подразделению), напротив категорий с несчетными ресурсами и штучных ресурсов ссылки "добавить".
* Дерево категорий. Отображается структурированный список категорий, на против каждой категории ссылки "удалить", "редактировать", "добавить подкатегорию".
* Форма редактирования категории. Редактирование параметров категории, включая родительскую категорию. Список дочерних подкатегорий. Список ресурсов или пакетов, причисленных к категории.
* Заказ пакетов ресурсов. Страница открывается по ссылке содержащей тип события привязки заказа и id собитии (если тип это предполагает). На странице отображается информация о событи привязки, либи форма ввода даты и продолжительности заказа. Ниже отображается список заказанных пакетов и количество для пакетов, допускающих множественный заказ. Ниже располагается дерево категорий, напротив категорий с пакетами, располагается ссылка "заказать" (если заказчика устроит любой пакет из данной категории), напротив каждого пакета так же располагается ссылка "заказать" для выбора предпочтительного пакета с ресурсами. Ссылка на экран просмотра состояния заказа.
* Просмотр состояния заказа. Позволяет просмотреть список исполнений, запланированных по данному заказу.
* Исполнение заказов (по подразделению). Отображает список заказов, подлежащих выдаче, по таблице invexecutions, отсортированных по плановому времени начала использования пакета и список пакетов подлежащих возврату. Напротив каждого из них ссылка "отметить".
* Отметка об исполнении заказа. Позволяет выбрать конкретный выдаваемый пакет и одобрить его состав, если заказ предполагает вариации. Так же на этом экране возможно указать причину неисполнения или невозврата и реквизиты сопутствующих документов.
* История движения ресурсов (по id подразделения, id ресурса или id категории).
[[Категория:Оборудование]]

Разработка:storages/invsets

2012-02-17T13:02:08Z

Dido86: /* Таблица в базе данных */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

===Таблица в базе данных===
''invsets'' - комплекты оборудования, минимальная единица, которую можно выдать персоне. Комплект включать в себя штучное оборудование. Все комплекты являются штучными и содержат конкретный перечень оборудования с известными инвентарными номерами.

====Подробный формат полей в таблице:====
* code - код комплекта
* type - возвращаемость комплекта: полностью расходуемый, возвращаемый, штучный
* invcategoryid - категория, к которой приписан объект
* departmentid - id подразделение - владельца ресурса
* personid - персона, ответственная за комплект
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invsets | invsets ]]
* note - примечание. Заполняется при выдаче/возврате комплекта

==Дополнительные методы:==
* Поиск комплекта по коду (второй параметр: только доступные, включая новые и временно недоступные, включая расформированные)
* Список комплектов по категории (если null - не учитывается) и структурному подразделению (если null - не учитывается) и статусу : только доступные, включая новые и временно недоступные, включая расформированные)
* Создать комплект (с проверкой уникальности кода и правомерностью расположения в категории)
* Расформировать комплект
[[Категория:Оборудование]]

Разработка:storages/invsets

2012-02-17T13:01:04Z

Dido86: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

==Таблица в базе данных==
''invsets'' - комплекты оборудования, минимальная единица, которую можно выдать персоне. Комплект включать в себя штучное оборудование. Все комплекты являются штучными и содержат конкретный перечень оборудования с известными инвентарными номерами.

====Подробный формат полей в таблице:====
* code - код комплекта
* type - возвращаемость комплекта: полностью расходуемый, возвращаемый, штучный
* invcategoryid - категория, к которой приписан объект
* departmentid - id подразделение - владельца ресурса
* personid - персона, ответственная за комплект
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invsets | invsets ]]
* note - примечание. Заполняется при выдаче/возврате комплекта

==Дополнительные методы:==
* Поиск комплекта по коду (второй параметр: только доступные, включая новые и временно недоступные, включая расформированные)
* Список комплектов по категории (если null - не учитывается) и структурному подразделению (если null - не учитывается) и статусу : только доступные, включая новые и временно недоступные, включая расформированные)
* Создать комплект (с проверкой уникальности кода и правомерностью расположения в категории)
* Расформировать комплект
[[Категория:Оборудование]]

Разработка:storages/invsets

2012-02-17T12:59:14Z

Dido86: /* Подробный формат полей в таблице: */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

==Таблица в базе данных==
''invsets'' - комплекты оборудования, минимальная единица, которую можно выдать персоне. Комплект включать в себя штучное оборудование. Все комплекты являются штучными и содержат конкретный перечень оборудования с известными инвентарными номерами.

====Подробный формат полей в таблице:====
* code - код комплекта
* type - возвращаемость комплекта: полностью расходуемый, возвращаемый, штучный
* invcategoryid - категория, к которой приписан объект
* departmentid - id подразделение - владельца ресурса
* personid - персона, ответственная за комплект
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invsets | invsets ]]

==Дополнительные методы:==
* Поиск комплекта по коду (второй параметр: только доступные, включая новые и временно недоступные, включая расформированные)
* Список комплектов по категории (если null - не учитывается) и структурному подразделению (если null - не учитывается) и статусу : только доступные, включая новые и временно недоступные, включая расформированные)
* Создать комплект (с проверкой уникальности кода и правомерностью расположения в категории)
* Расформировать комплект
[[Категория:Оборудование]]

Разработка:storages/invsets

2012-02-17T12:58:40Z

Dido86: /* Таблица в базе данных */

{{Infobox_Plugin
| name = invsets
| type = storages
}}

==Таблица в базе данных==
''invsets'' - комплекты оборудования, минимальная единица, которую можно выдать персоне. Комплект включать в себя штучное оборудование. Все комплекты являются штучными и содержат конкретный перечень оборудования с известными инвентарными номерами.

==Подробный формат полей в таблице:==
* code - код комплекта
* type - возвращаемость комплекта: полностью расходуемый, возвращаемый, штучный
* invcategoryid - категория, к которой приписан объект
* departmentid - id подразделение - владельца ресурса
* personid - персона, ответственная за комплект
* status - список статусов указан в одноименном плагине рабочих процессов [[Разработка:workflows/invsets | invsets ]]

==Дополнительные методы:==
* Поиск комплекта по коду (второй параметр: только доступные, включая новые и временно недоступные, включая расформированные)
* Список комплектов по категории (если null - не учитывается) и структурному подразделению (если null - не учитывается) и статусу : только доступные, включая новые и временно недоступные, включая расформированные)
* Создать комплект (с проверкой уникальности кода и правомерностью расположения в категории)
* Расформировать комплект
[[Категория:Оборудование]]

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

2012-02-09T13:36:23Z

Dido86: /* dof_calendar */

== Общие сведения ==
Библиотека ''moodleQuickForm'' (она же ''moodleform'') построена на основе библиотеки PEAR [http://pear.php.net/package/HTML_QuickForm HTML_QuickForm]. Описание работы всех функций moodleQuickForm следует искать именно по этой ссылке.

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

Перечисление всего того, что доступно в ''moodleQuickForm'' заняло бы слишком много места, поэтому перечислим только те задачи, которые при помощи этой библиотеки решить нельзя:
* создать форму в виде таблицы, в которой более 2-х столбцов
* создать длинную горизонтальную форму
Для всех остальных случаев построения форм следует использовать именно эту библиотеку.
== Внешний вид ==
Внешне все формы класса moodleform выглядят одинаково: это таблица из 2-х столбцов, и некоторого количества строк:

== Правила объявления формы ==
Установка всех элементов формы происходит либо в функции [[Разработка:moodleQuickForm#definition()|definition()]] (для статических форм), либо в функции [[Разработка:moodleQuickForm#definition_after_data()|definition_after_data()]] (для динамических форм).
== Описание стандартных методов moodleform ==
===== __construct($action, $customdata, $method, $target, $attributes, $editable) =====
Этот метод вызывается когда вы создаете новый объект формы.

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

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

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

===== setDefault('elementName', $value) =====
Установить значение ''$value'' по умолчанию для элемента ''elementName''.
$mform->addElement('hidden', 'имяэлемента');
$mform->setDefault('имяэлемента', $value);
В случае, если нужно установить значение по умолчанию для элемента внутри группы, то нужно использовать такой синтаксис
$mform->setDefault('имягруппы[имяэлемента]', $value);
Для элемента ''hierselect'' в качестве второго аргумента нужно указывать массив со значениями по умолчанию для каждого уровня:
$mform->setDefault('имяэлемента', array(14, 2, 8));

===== get_submitted_data($slashed) =====
Получить данные из формы, к которым еще не применены никакие проверки.
* $slashed - экранировать кавычки. По умолчанию true.
===== add_element($type, $name, $description, $attributes, $options) =====
Добавить элемент в форму. Наиболее часто используемая функция при построении формы.
$type - Тип элемента
$name - Имя элемента в форме. Только латинские буквы.
$description - Описание элемента. Выведется слева от него.
$attributes - строка с параметрами, вставляемая в html-тег элемента.
$options - массив с дополнительными параметрами. Назначение параметров зависит от типа элемента.

Поведение самой функции ''add_element'' также зависит от типа добавляемого элемента. Подробнее об этом - см. раздел [[Разработка:moodleQuickForm#Элементы формы|Элементы формы]].

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

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

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

Пример:
// создаем массив
$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) =====
Вставляет элемент перед уже ранее добавленным функцией [[Разработка:moodleQuickForm#add_element($type, $name, $description, $attributes, $options) | add_element()]]. Этот метод полезно применять в динамических формах, внутри функции [[Разработка:moodleQuickForm#definition()|definition()]] или [[Разработка:moodleQuickForm#definition_after_data()|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) =====
Добавить правило для отдельного поля. Эту функцию следует использовать для проверок на стороне клиента и простых проверок на стороне сервера. Для сложных проверок данных (например с использованием обращения к БД) используйте функцию [[Разработка:moodleQuickForm#validation($data, $files) | validation()]].

* $element - имя элемента, к которому применяется проверка
* $message - сообщение, в случае если проверка не пройдена
* $type - тип правила проверки (см. таблицу ниже)
* $format - дополнительные данные, требующиеся для некоторых проверок. По умолчанию null.
* $validation - на какой стороне производить проверку. Возможные значения:
** server - на стороне сервера (по умолчанию)
** client - на стороне клиента
* $reset - используется при проверке на стороне клиента. Сбрасывать ли данные в этом поле на значение по умолчанию, если введены неправильные данные? по умолчанию false (не сбрасывать).
* $force - применять ли проверку даже если проверяемый элемент не существует? По умолчанию false (не применять). Этот параметр используется для проверок в динамических формах.

{| border="1"
|+ Таблица типов правил для полей формы
! Имя
! Описание
! width="50%" |Пример кода
|-
|required
|Обязательное поле
|<pre>$mform->addRule('testname','Это поле является обязательным', 'required',null,'client');</pre>
|-
|minlength
|Минимальная длина значения в поле.
|<pre>$mform->addRule('testname','Слишком короткое значение', 'minlength', 10,'client');</pre>
|-
|maxlength
|Максимальная длина значения в поле.
|<pre>$mform->addRule('testname','Слишком длинное значение', 'maxlength', 256,'client');</pre>
|-
|rangelength
|Проверка длины значения с обеих сторон: например не больше 5 и не меньше 7. Параметры задаются массивом из двух элементов. В данном примере от 111 до 222.
|<pre>$mform->addRule('testname','Длина значения неправильна', 'rangelength', array(111, 222),'client');</pre>
|-
|email
|Проверка email-адреса
|<pre>$mform->addRule('testname','неправильный email', 'email',null,'client');</pre>
|-
|regex
|Проверка данных регулярными выражениями. Используется редко, в случае, когда обычных проверок недостаточно.
|
|-
|lettersonly
|Только латинские буквы.
|<pre>$mform->addRule('testname','Ошибка', 'lettersonly', null,'client');</pre>
|-
|alphanumeric
|Только латинские буквы и цифры
|<pre>$mform->addRule('testname','Ошибка', 'alphanumeric', null,'client');</pre>
|-
|numeric
|Целое или дробное число
|<pre>$mform->addRule('testname', 'В этом поле разрешены только числа', 'numeric', null, 'client');</pre>
|-
|nopunctuation
|В строке не должны присутствовать специальные символы. Список: '''()./*^?#!@$%+=,"'><~[]{}'''
|<pre>$mform->addRule('testname', 'Введены запрещенные символы', 'nopunctuation', null, 'client');</pre>
|-
|nonzero
|Ненулевое значение
|<pre>$mform->addRule('testname', 'Только ненулевые значения', 'nonzero', null, 'client');</pre>
|-
|callback
|Использовать пользовательскую функцию для проверки данных. Используется крайне редко, если у вас есть сложные проверки - то лучше используйте для них функцию [[Разработка:moodleQuickForm#validation($data, $files) | validation()]].
|
|-
|compare
|Сравнить два значения. Может использоваться для сравнения чисел и строк. Операторы, используемые для сравнения:
* '''==''' равно
* '''!=''' не равно
* '''>''' больше
* '''>=''' больше или равно
* '''<''' меньше
* '''<=''' меньше или равно
|<pre></pre>
|-
|uploadedfile
|
|
|-
|maxfilesize
|Проверка максимального значения файла для конкретного поля
|
|-
|mimetype
|Проверка mime-типа загруженного файла.
|
|-
|filename
|Проверка имени файла. Убираются все потенциально опасные символы.
|
|}

===== is_submitted() =====
Возвращает ''true'' если форма подтверждена кнопкой типа "submit", и ''false'' в противном случае. Обратите внимание, что кнопка "отмена" в форме также является кнопкой типа "submit", поэтому используйте для этих целей функцию is_canceled().
Для проверки того, что данные отправлены в форму, и корректно прошли все проверки на стороне сервера и клиента, можно использовать такую конструкцию:
<pre>
if ( $form->is_submitted() AND confirm_sesskey() AND $formdata = $form->get_data() AND ! $form->is_cancelled() )
{//даные переданы и прошли все проверки

....

}elseif( $form->is_cancelled() )
{// ввод данных отменен

....

}
</pre>
Здесь:
* ''$form->is_submitted()'' - проверка того, что данные в форме были отправлены кнопкой типа "submit"
* ''confirm_sesskey()'' - проверка того, что данные отправлены внутри текущей сессии (встроенная функция moodle)
* ''$formdata = $form->get_data()'' - получение данных формы, и одновременное подтверждение того, что данные прошли все проверки, не не нажата кнопка "отмена".

Также возможно сначала проверять is_canceled(), а потом is_submitted().

===== 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 можно посмотреть в статье [[Разработка:Константы_Moodle#Константы типов данных|константы типов данных]]

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

Используется для дополнительной проверки данных на стороне сервера. Все необходимые сложные проверки должны быть проведены именно здесь. Для простых проверок (на тип данных, проверка email-адреса и т. п.) используйте функцию [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force) | addRule()]]
* $data - массив вида array('имя_поля' => 'значение') из отправленных данных
* $files - массив загруженных в форму файлов. Имеет вид array('имя_поля' => 'путь_к_временному_файлу')

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

===== disabledIf($elementName, $dependentOn, $condition, $value) =====
Эта функция используется для того чтобы установить зависимости между полями формы. До тех пор пока одно поле формы не будет выделено, или в него не будет введено нужное значение, другое не станет активным.

К одному элементу формы можно применять несколько правил disabledIf. Несколько элементов могут зависеть от одного поля.
* $elementName - имя зависимого элемента.
* $dependentOn - имя элемента, чье состояние должно быть проверено условием $condition.
* $condition - по умолчанию 'notchecked'.
* $value - значение, используемое для проверки условия. По умолчанию "1".

{| border="1"
|+ Таблица вариантов условий для параметра $condition
! Значение
! Пояснение
|-
|''checked''
|Элемент выделен. Используется для элементов radio и checkbox. Не работает с элементами advcheckbox.
|-
|''notchecked''
|Элемент не выделен. Используется для элементов radio и checkbox. Не работает с элементами advcheckbox.
|-
|''eq''
|Значение указанного элемента равно значению указанному в параметре $value.
|-
|''noteq''
|Значение указанного элемента не равно значению указанному в параметре $value.
|-
|''noitemselected''
|В указанном html-элементе "select" ничего не выбрано.
|}
===== applyFilter($elementName, $functionName); =====
Применить проверку элементу формы.

Параметры
* ''$elementName'' - название элемента внутри формы. В качестве имени можно использовать специальное значение '''__ALL__''' чтобы применить проверку ко всем элементам.
* ''$functionName'' - название функции (без скобок и аргументов), которая должна быть применена к этому элементу

Пример:
// применение проверки ко всем элементам
$mform->applyFilter('__ALL__', 'trim');

// применение проверки к одному элементу
$mform->applyFilter('lastname', 'addslashes');
===== closeHeaderBefore($elementName) =====
Закрыть рамку формы до элемента с указанным именем. Эта функция позволит вам выносить нижние элементы "за пределы" визуальной рамки формы, а также добавлять элементы без заголовка.
Иными словами, эта функция закрывает тег [http://htmlbook.ru/html/fieldset.html <FIELDSET>].
Эта функция должна быть обязательно вызвана ПОСЛЕ добавления элемента, перед которым закрывается рамка формы.

Пример:
// добавляем элемент формы
$mform->addElement('text', 'name', $this->dof->get_string('name','plans').':');
// Выносим его, и следующие элементы за рамку формы
$mform->closeHeaderBefore('name')

== Элементы формы ==
Во всех приведенных примерах переменная $form обозначает ссылку на объект HTML_QuickForm. Подробнее об этом в описании функции [[Разработка:moodleQuickForm#definition() |definition()]]. Во всех текстовых полях (кроме кнопок) можно использовать html-теги форматирования.

=== header ===
Заголовок формы. Этот заголовок будет говорить об общем содержании данных в форме. Также он используется в случае, когда вам нужно разбить форму на несколько частей.
Если вам нужно закрыть рамку заголовка перед каким-либо элементом, используйте функцию [[#closeHeaderBefore($elementName) |closeHeaderBefore()]]
<pre>$mform->addElement('header','testname', 'Текст заголовка');</pre>

=== checkbox ===
Стандартный html-элемент checkbox.
<pre>$mform->addElement('checkbox', 'testname', 'Текст_перед_галочкой', 'Текст_после галочки');</pre>

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

=== group ===
Добавление группы элементов. Для того, чтобы добавить группу элементов, их нужно предварительно создать при помощи функции [[Разработка:moodleQuickForm#create_element($type, $name, $description, $attributes, $options)|create_element()]]
Параметры (в порядке перечисления):
* тип
* название элемента
* пояснение
* массив с элементами
* разделитель для элементов (в примере - тег <br>)
* добавить ли имя группы к имени элемента (true - добавить)
<pre>
// создаем массив
$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, '<br>', true);
</pre>

=== password ===
Стандартный html-элемент password
<pre>mform->addElement('password', 'testname', 'Текст перед окном с паролем');</pre>

=== passwordunmask ===
То же самое, что и элемент password, но с дополнительной галочкой "отобразить пароль".
<pre>$mform->addElement('passwordunmask', 'testname', 'Текст перед окном с паролем');</pre>

=== radio ===
Стандартный html-элемент radio. Единственный элемент в quickform, несколько объектов которого можно добавить, используя одинаковое значение name.
<pre>$mform->addElement('radio', 'testname', 'Текст до переключателя 1',
'Текст после переключателя 1', 'Значение1');
$mform->addElement('radio', 'testname', 'Текст до переключателля 2',
'Текст после переключателя 2', 'Значение2');</pre>

=== select ===
Стандартный html-элемент select. Массив $choices содержит варианты для оператора select. Значениями массива являются текстовые надписи в списке выбора, а ключами - значения этих вариантов.
<pre>
// создаем массив с вариантами выбора
$choices = array('a' => 'Текст варианта 1', 'b' => 'Текст варианта 2');

// Добавляем элемент формы
$mform->addElement('select', 'testname', 'Пояснение для строки выбора', $choices);
</pre>
==== Дополнительные функции ====
Элемент select обладает дополнительными методами, которые
* addOption($text, $value, $attributes=null) - добавить новый вариант к select-элементу, уже после того как он был создан, и в него были установлены значения. Параметры:
** $text - текст, который отображается пользователю
** $value - значение, которое передается из формы
** $attributes - дополнительные html-атрибуты тега OPTION (если требуется). Передаются строкой, либо массивом в формате ключ-значение.
Пример:
<pre>
$select = $mform->getElement('testname');
$select->addOption('Текст для отображения', 555);
</pre>

=== selectgroups ===
=== submitlink ===
=== text ===
Стандартный html-элемент text. Последний параметр - строка html-атрибутов. В данном примере длина поля задана 100%. Это гарантирует, что элемент будет нормально выглядеть и умещаться в форму при любых размерах экрана.
<pre>$mform->addElement('text', 'testname', 'Пояснение для текстового поля', ' width="100%" ');</pre>
=== textarea ===
Стандартный html-элемент textarea. Значения ширины и высоты задаются в виде массива, последним аргументом. Ширину поля также рекомендуется задавать 100%.
<pre>$mform->addElement('textarea', 'testname', 'Пояснение:', array('width'=>'100%', 'height'=>'100px'));</pre>
=== date_selector ===
Диалоговое окно с выбором даты. Обратите внимание, что при получении данных через [[Разработка:moodleQuickForm#get_data($slashed)|get_data()]] значение этого поля автоматически трансформируется в метку unixtime на 12:00:00 дня выбранной даты. По умолчанию выставляется текущая дата и время. Другое начальное значение может быть задано при помощи функции [[Разработка:moodleQuickForm#setDefault($elementName, $defaultValue, $slashed)|setDefault()]].
<pre>
$options = array();// объявляем массив для установки значений по умолчанию
$options['startyear'] = 1980; // устанавливаем год, с которого начинать вывод списка
$options['stopyear'] = 2001; // устанавливаем год, которым заканчивается список
$options['optional'] = false; // убираем галочку, делающую возможным отключение этого поля

$mform->addElement('date_selector', 'testname', 'Пояснение для поля даты', $options);
// устанавливаем время по умолчанию на год вперед
$mform->setDefault('testname', time()+3600*24*365);
</pre>
=== date_time_selector ===
Этот элемент аналогичен элементу date_selector, только добавлены параметры часов и минут. Полученные данные также трансформируются в unixtime, но уже для выбранных значений часов и минут. По умолчанию выставляется текущая дата и время. Другое начальное значение может быть задано при помощи функции [[Разработка:moodleQuickForm#setDefault($elementName, $defaultValue, $slashed)|setDefault()]].
<pre>
$options = array();// объявляем массив для установки значений по умолчанию
$options['startyear'] = 1980; // устанавливаем год, с которого начинать вывод списка
$options['stopyear'] = 2001; // устанавливаем год, которым заканчивается список
$options['optional'] = false; // убираем галочку, делающую возможным отключение этого поля

$mform->addElement('date_time_selector', 'testname', 'Пояснение для поля даты', $options);
</pre>
=== htmleditor ===
Полноценный html-редактор для редактирования страниц. Его вид (обычный или расширенный) настраивается индивидуально каждым пользователем для себя (в настройках профиля moodle). Обратите внимание, что в качестве дополнительных параметров можно массивом передать значения ширины и высоты текстового поля.
<pre>
$mform->addElement('htmleditor', 'testname', 'Пояснение:', array('width'=>'100%', 'height'=>'200px')

</pre>
=== format ===
Выбор формата для редактирования сообщения. Полезно использовать вместе со встроенным html-редактором.
<pre>$mform->addElement('format', 'testname', 'Текст пояснения');</pre>
=== static ===
Обычное текстовое поле, не передает никаких данных. Полезно использовать для различных пояснений и отображения текущей информации о каком-либо объекте. Вы также можете использовать этот элемент для разбиения формы на небольшие смысловые блоки, не разрывая рамку формы. Для более явного разбиения используйте элемент header.
<pre>$mform->addElement('static', 'testname', 'Пояснение:', '<b><i>Само текстовое значение</i></b>');</pre>
=== hidden ===
Стандартный html-элемент hidden, скрытое поле для передачи служебных id, адресов для перенаправления и т. д. Помните о необходимости проверки значений из этого поля.
<pre>$mform->addElement('hidden','testname', 'Значение скрытого поля');</pre>
=== modvisible ===
Установить модуль видимым/скрытым. Только для использования внутри Mooodle.
=== selectyesno ===
Элемент с двумя стандартными select-вариантами выбора: да и нет.
<pre>
$mform->addElement('selectyesno', 'testname', 'Текст пояснения');
// установить значение по умолчанию "да"
$mform->setDefault('stoponerror', 1);
</pre>
=== modgrade ===
Шкала выставление оценки за задание. Только для использования внутри Moodle.
=== cancel ===
Кнопка "отменить форму". При нажатии на нее происходит отмена всех произведенных в форме действий.
<pre>$mform->addElement('cancel', 'testname', 'Надпись на кнопке'); </pre>
=== button ===
Элемент аналогичен кнопке типа submit, но при использовании button пропускается проверка данных на стороне клиента.
<pre>$mform->addElement('button', 'testname', 'Надпись на кнопке');</pre>
=== choosecoursefile ===
Выбрать файл из курса. Только для использования внутри курса Moodle.
=== submit ===
Кнопка отправки данных из формы. Обязательно ставьте ее в конце, иначе все введенные данные нельзя будет отправить. Существует также альтернативный способ задать такую кнопку - это функция [[Разработка:moodleQuickForm#add_action_buttons($cancel, $submitlabel)|get_data()]]
<pre>$mform->addElement('submit', 'testname', 'Текст на кнопке');</pre>
=== questioncategory ===
Выбрать вопрос из категории. Только при редактировании теста и только внутри курса Moodle.
=== advcheckbox ===
Элемент checkbox c расширенными функциями - такие элементы можно объединять в группы и устанавливать им контрольный переключатель (делает либо все галочки поставлеными либо снятыми) при помощи функции [[Разработка:moodleQuickForm#add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue) |add_checkbox_controller()]].

Поскольку таких галочек всегда задается несколько - то целесообразно в указании имени элемента использовать квадратные скобки, чтобы собрать значения всех элементов в один массив. Последним аргументом задается группа, к которой принадлежит созданный элемент. Именно это значение должно быть указано в первом параметре функции [[Разработка:moodleQuickForm#add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue) |add_checkbox_controller()]].

Несовместим с функцией [[Разработка:moodleQuickForm#disabledIf($elementName, $dependentOn, $condition, $value) | disabledIf()]]

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

$mform->addElement('advcheckbox', 'testname[2]', 'Описание:', 'Текст за галочкой', array('group' => 'id_группы'));
</pre>
=== recaptcha ===
Окно с картинкой для использования Capcha проверки. Обратите внимание, что для того чтобы использовать этот элемент вы сначала должны получить уникальный ключ с на сайте <nowiki>http://recaptcha.net/api/getkey</nowiki>.
<pre>$mform->addElement('recaptcha', 'testname', 'Текст с пояснением');</pre>
=== hierselect ===
Несколько зависимых друг от друга html-элементов типа "select". В зависимости от выбранной опции в первом элементе, меняются значения остальных.
При вызове функции addElement в последнем параметре указывается, какими символами разделять операторы select.
<pre>
// для начала создадим два массива - по количеству операторов select
// которые нам предстоит создать

// Первый, главный элемент select
$select1[0] = 'Pop';
$select1[1] = 'Classical';
$select1[2] = 'Funeral doom';

// второй элемент select - его варианты зависят от первого
$select2[0][0] = '--- Artist ---';
$select2[0][1] = 'Red Hot Chil Peppers';
$select2[0][2] = 'The Pixies';

$select2[1][0] = '--- Artist ---';
$select2[1][1] = 'Wagner';
$select2[1][2] = 'Strauss';

$select2[2][0] = '--- Artist ---';
$select2[2][1] = 'Pantheist';
$select2[2][2] = 'Skepticism';

// добавляем новый элемент в форму
$myselect =& $mform->addElement('hierselect', 'testname', 'Текст с пояснением:',null,'<br>');
// устанавливаем для него варианты ответа
$myselect->setOptions(array($select1, $select2));
// устанавливаем значения по умолчанию: 'Funeral doom'->'Pantheist'
$mform->setDefault('testname', array(2, 1));
</pre>
=== html ===
Добавить собственный html-код. Используйте этот тип элементов формы, только в случае, если ни один из перечисленных элементов вам не подходит, или нужно решить какую-либо нетривиальную задачу с форматированием.
Может помочь в случае решения задачи разбиения формы на 3, или более колонок ([http://docs.moodle.org/en/User:Frank_Ralf/Moodle_forms3] [http://moodle.org/mod/forum/discuss.php?d=126935]).
<pre>$mform->addElement('html', '<div class="qheader">');</pre>
=== autocomplete ===
Элемент, который автоматически подсказывает варианты по мере набора текста. Выглядит как обычный элемент text, но имеет встроенный javascript. Значение по умолчанию устанавливается стандартным образом.
<pre>// Создаем массив подсказок
$options = array('апельсин', 'ананас', 'авокадо');
// добавляем новый элемент в форму
$element =& $mform->addElement('autocomplete', 'testname', 'Текст с пояснением:', 'size=12');
// устанавливаем массив подсказок
$element->setOptions($options);
</pre>

=== dof_calendar ===
Элемент, который автоматически отображает 2 календаря для выбора диапозона дат. Календари находятся на одной линии. Под каждым календарем поле-указывает в формате д.м.гг дату, которая выбрана на календаре. В скрытое поле каждого календаря помещается время в unix time, причем в "с" береть отчет от 00.00.01, в "до" с 23.59.59. Если на правом и на левом календарях отмечена одна дата, то диапозон ,соотвественно, равен 00.00.01-23.59.59, что полностью охватывает выбранный день
<pre>
// добавляем новый элемент в форму
$element = $mform->addElement('dof_calendar', 'calendarname', 'Текст с пояснением:', $options),где
'Текст с пояснением:' - Текст, который будет выведен выше календарей
$options - массив, с указанием дат(левый и праавй календарь)
* $options['date_from'] - с какой даты брать отсчет(левый календарь)(unix time)
* $options['date_to'] - по какую дату брать отсчет(правый календарь)(unix time)
</pre>
Если параметр options опущен, то береться текущая дата.
Важно !! При объявлении времени, нужно брать массив именно с ЭТИМИ параметры(date_from, date_to).
Выходные данные имеют вид
<pre>
[calendarname] = Array
[date_from] = ... (unux time)
[date_to] = ... (unux time)
</pre>

=== dof_autocomplete ===
Элемент с выпадающим списком подсказок по мере набора текста. Выглядит как обычный элемент text, но имеет встроенный javascript. В помощь с ним создается автоматически hidden поле, значение которого будет равно индексу выбранного элемента(name="id_autocomplete" id="id_hidden_auto"). В dof_autocomplete есть обязательные параметры, работа без которых не возможна. Записываются они в переменную массив <b>$options</b>. В неё же и помещается массив option(ключ=>значени), это так называемые значения по умолчанию(не обязательные).
*Список обязательных полей для переменной $options:
**plugintype - тип плагина ( например storage)
**plugincode - код плагина ( например plans)
**queryty - тип запроса, именно по нему и определяется, что надо делать( например plans_name ). Этот тип должен совпадать с типом, который будет находиться в этом в плагине в методе widgets_field_variants_list
**sesskey - ключ сессии(чтоб идентифицировать запрос) задается методом sesskey()
**type - тип действия ( например autocomplete ). Есть ещё тип savefield
*Необязательные поля:
**option - массив значений по умолчания( например $a[19]= "primer"), где ключ - это id элемента из бд

<pre> $mform->addElement('dof_autocomplete', $elementName = null, $elementLabel = null, $attributes = null, $options = null)
//Создаем массив входных данных
$options = array();
$options['plugintype'] = "storage";
$options['plugincode'] = "plans";
$options['querytype'] = "plans_name";
$options['sesskey'] = sesskey();
$options['type'] = 'autocomplete';
// установим значение по умолчанию
$mas = array( 19 => 'primer' );
$options['option'] = $mas;

// добавляем новый элемент в форму
$mform->addElement('autocomplete', 'testname', 'Текст перед полем:', 'size=12', $options);
// устаонвка типа
$mform->setType('testname', PARAM_TERXT);
</pre>
*Замечение:
**следует помнить, что элемент autocomplete сам в себе подключает js-библиотеки, и потому, объявление класса на странице должно быть ''раньше'', чем печать шапки страницы
**выходные данные имеют вид
<pre>
[testname] = Array
[testname] = полученное значение
[id_autocomplete] = id значения
</pre>
Необходимые методы:
Плагин, данные которого будут составлять автозаполнение должен иметь метод <b>widgets_field_variants_list($querytype, $data="")</b>, который возвращает массив объектов в формате <pre>
$a = arrya();
a[1] = object[
name = ЗНАЧЕНИЕ_1 ДЛЯ ВЫПАДАЮЩЕГО СПИСКА
id = id элемента_1
];
a[2] = object[
name = ЗНАЧЕНИЕ_2 ВЫПАДАЮЩЕГО СПИСКА
id = id элемента_2
];
...
]
</pre>где $querytype-тип запроса(обрабатывается путем case), $data-вх данные, как правило строка(набранные данные в поле autocomplete)
* Замечание:
** поля name и id обязательны в переданном массиве
** метод должен возвращать с LIMIT 15(не больше), для быстроты работы

=== dof_duration ===
Элемент для задания длительности временного интервала в часах, днях, неделях, и т. п.
<pre>
// задаем возможные единицы измерения: часы и минуты
$options['availableunits'] = array(60 => $this->dof->modlib('ig')->igs('minutes'),
3600 => $this->dof->modlib('ig')->igs('hours'));
// добавляем сам элемент
$mform->addElement('dof_duration', 'testname', 'Текст с пояснением:', $minutesoptions);
</pre>
=== dof_single_use_submit ===
Одноразовая submit-кнопка. Отправляет данные формы и сразу же становится неактивной, для того чтобы избежать повторного нажатия и отправки данных (doubleclick). Имеет дополнительный метод setPleaseWaitText(), при помощи которого можно устанавливать надпись, которая появляется после нажатия на кнопку.
<pre>
// создаем кнопку, с надписью "сохранить"
$submit = &$mform->addElement('dof_single_use_submit', 'testsinglesubmit', $this->dof->modlib('ig')->igs('save'));
// Устанавливаем сообщение после нажатия - "обработка"
$submit->setPleaseWaitText($this->dof->modlib('ig')->igs('processing'));
</pre>

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

=== Установка обязательных полей ===
Установка обязательных полей происходит при помощи функции [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force)|addRule()]].

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

=== Установка дополнительных полей ===
Установка дополнительных полей производится при помощи функции [[Разработка:moodleQuickForm#setAdvanced($elementName, $advanced)|setAdvanced()]]. Необязательные элементы должны располагаться один за другим.

Пример:
// устанавливаем два текстовых поля и делаем их необязательными
$mform->addElement('text', 'my_field1', 'Пояснение :');
$mform->setAdvanced('my_field1');
$mform->addElement('text', 'my_field2', 'Пояснение :');
$mform->setAdvanced('my_field2');

=== Установка проверки на стороне клиента или сервера ===
По умолчанию все данные из формы подлежат проверке на стороне сервера. Существует возможность добавить проверку на стороне клиента. Не забывайте при этом, что эти данные нужно потом все равно еще раз проверить на стороне сервера, так как всегда существует возможность послать данные в обход формы.
==== Проверка на стороне сервера ====
Если вам требуется дополнительная проверка данных на стороне клиента, то используйте стандартный метод [[Разработка:moodleQuickForm#validation($data, $files) | validation()]]. Любые другие способы проверки данных после формы должны использоваться только в исключительных случаях.

==== Проверка на стороне клиента ====
Все малозначимые проверки желательно производить на стороне клиента для увеличения быстродействия приложения. Все проверки на стороне клиента производятся при помощи функции [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force)|addRule()]].

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

Пример:
// устанавливаем поле "фамилия"
$mform->addElement('text', 'lastname', 'Фамилия :');
// делаем его обязательным
$mform->addRule('lastname','Это поле является обязательным', 'required',null,'client');
=== Установка зависимых полей ===
==== Стандартный вариант ====
Установка зависимых полей производится при помощи функции [[Разработка:moodleQuickForm#disabledIf($elementName, $dependentOn, $condition, $value)|disabledIf()]].

Пример:
// Устанавливаем элемент checkbox
$mform->addElement('checkbox', 'my_checkbox', get_string('forcedownload', 'resource'));
// устанавливаем текстовое поле
$mform->addElement('text', 'my_field', 'Пояснение :');
// устанавливаем зависимость
$mform->disabledIf('my_field', 'my_checkbox', 'checked');
==== Расширенный вариант ====
Для html-элеметов "select", есть возможность установить иерархическую зависимость элементов (то есть в зависимости от того, что было выбрано в первом "select", меняются значения в остальных). Синтаксис этого элемента указан в разделе [[Разработка:moodleQuickForm#Элементы формы|Элементы формы]] (в самом конце, он называется hierselect).

== Известные проблемы ==
В этом разделе собраны обнаруженные проблемы с элементами формы и способы их решения.
=== Данные не приходят из поля формы, даже в validation ===
Возможно на странице обработчика формы есть функция optional_param (или required_param) которая называется точно также как поле в форме. Если это так, то указанное поле из данных формы пропадет.
=== text ===
* Поле ввода слишком широкое, слишком узкое, или вылезает за границы заголовка
** Решение: Нужно в свойства элемента добавить style="width:100%;". В этом случае элемент растянется до конца формы, и не будет вылезать за границы формы вне зависимости от того - большой монитор у пользователя или маленький.
** Пример:
<pre>
$mform->addElement('select', 'my_select', 'Description...', $options, ' style="max-width:400px;width:100%;" ');
</pre>
=== textarea ===
* Поле ввода слишком широкое, слишком узкое, или вылезает за границы заголовка
** Решение: Нужно в свойства элемента добавить style="width:100%;". В этом случае элемент растянется до конца формы, и не будет вылезать за границы формы вне зависимости от того - большой монитор у пользователя или маленький.
** Пример:
<pre>
$mform->addElement('textarea', 'name', 'Description...', array('style' => 'width:100%;max-width:400px;height:150px;'));
</pre>
=== hierselect ===
* Не работает Javascript если в качестве значения hierselect используются цифры
** Решение: в списке значений после цифры добавлять пробел, или любой другой символ.
** Пример: array('1' => '''"1 "'''); вместо array('1' => '''"1"''');
* Невозможно отключить только одно поле hierselect не отключая при этом остальные
** Решение: отсутствует.
* При количестве select-элементов 3 или больше портится верстка. Подписи к select-элементам не совпадают с самими элементами.
** Решение: до элемента hierselect вставить html-элемент который содержит div, устанавливающий фиксированный межстрочный интервал (см. пример). После добавления hierselect-элемента закрыть div.
** Пример:
<pre>
// выравниваем строки по высоте
$mform->addElement('html', '<div style=" line-height: 1.9; ">');

// Дальше идет объявление hierselect...
// ...

// закрываем тег выравнивания строк
$mform->addElement('html', '</div>');
</pre>
* При указании строковых ключей массива hierselect не работает. Это происходит из-за того что в Javascript мы можем иметь дело либо с индексированными массивами, либо с объектами. Ассоциативные массивы там не предусмотрены.
** Решение: не использовать ассоциативные ключи массивов при создании элементов hierselect. Если же обойтись без них никак нельзя - то можно закодировать ассоциативные элементы числами ('option1' - 1, 'option2' - 2 и т. д.), а на стороне обработчика раскодировать обратно.
* По неизвестным причинам иногда перестает работать переключение с одной опции на другую.
** Решение: скорее всего в списке дочерних опций присутствуют элементы не для всех родительских опций (см. пример). Для каждой опции верхнего уровня должен присутствовать хотя бы один элемент нижнего уровня.
** Пример:
'''Неправильный код:'''
<pre>
$level1 = array();
$level1[0] = 'option0';
$level1[1] = 'option1';

$level2 = array();
$level2[1][0] = 'option1_0';
$level2[1][1] = 'option1_1';
</pre>
'''Правильный код:'''
<pre>
$level1 = array();
$level1[0] = 'option0';
$level1[1] = 'option1';

$level2 = array();
$level2[0][0] = 'option0_0'; // без этой строки ничего не будет работать
$level2[1][0] = 'option1_0';
$level2[1][1] = 'option1_1';
</pre>
* Данные из поля hierselect передаются вне зависимости от того, было отключено поле или нет.
** Решение: отсутствует.
* При проверке данных в функции validation() нельзя сообщить о том, что ошибка произошла внутри какого-то конкретного select-элемента.
** Решение: отсутствует. Можно указать только указывать сам hierselect-элемент как источник ошибки, и сообщить подробности в сообщении.

=== hidden ===
* Не работает правило disabledif. Невозможно установить значение из hidden-поля для использования disabledif-правила.
** Решение: создать другой элемент (например checkbox), записать в него нужное значение, и в стилях установить ему display:none
** Пример:
<pre>
$mform->addElement('radio', 'hidden_hack', '', '', 'true', 'style' => 'display:none;');
</pre>

== Ссылки ==
* [http://pear.php.net/manual/en/package.html.html-quickform.php Справка по базовым методам класса HTML_QuickForm]
* [http://docs.moodle.org/en/Development:lib/formslib.php_Form_Definition Справки по элементам класса moodleform]
* [http://web.archive.org/web/20080214041550/http://www.midnighthax.com/quickform.php Getting Started Guide по элементам оригинального класса HTML_QuickForm. Некоторые обращения к методам могут отличаться от moodleform.]
* [http://wiki.triangle-solutions.com/index.php/PEAR_HTML_QuickForm] Примеры объявления элементов.

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

2012-02-09T13:35:18Z

Dido86: /* dof_calendar */

== Общие сведения ==
Библиотека ''moodleQuickForm'' (она же ''moodleform'') построена на основе библиотеки PEAR [http://pear.php.net/package/HTML_QuickForm HTML_QuickForm]. Описание работы всех функций moodleQuickForm следует искать именно по этой ссылке.

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

Перечисление всего того, что доступно в ''moodleQuickForm'' заняло бы слишком много места, поэтому перечислим только те задачи, которые при помощи этой библиотеки решить нельзя:
* создать форму в виде таблицы, в которой более 2-х столбцов
* создать длинную горизонтальную форму
Для всех остальных случаев построения форм следует использовать именно эту библиотеку.
== Внешний вид ==
Внешне все формы класса moodleform выглядят одинаково: это таблица из 2-х столбцов, и некоторого количества строк:

== Правила объявления формы ==
Установка всех элементов формы происходит либо в функции [[Разработка:moodleQuickForm#definition()|definition()]] (для статических форм), либо в функции [[Разработка:moodleQuickForm#definition_after_data()|definition_after_data()]] (для динамических форм).
== Описание стандартных методов moodleform ==
===== __construct($action, $customdata, $method, $target, $attributes, $editable) =====
Этот метод вызывается когда вы создаете новый объект формы.

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

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

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

===== setDefault('elementName', $value) =====
Установить значение ''$value'' по умолчанию для элемента ''elementName''.
$mform->addElement('hidden', 'имяэлемента');
$mform->setDefault('имяэлемента', $value);
В случае, если нужно установить значение по умолчанию для элемента внутри группы, то нужно использовать такой синтаксис
$mform->setDefault('имягруппы[имяэлемента]', $value);
Для элемента ''hierselect'' в качестве второго аргумента нужно указывать массив со значениями по умолчанию для каждого уровня:
$mform->setDefault('имяэлемента', array(14, 2, 8));

===== get_submitted_data($slashed) =====
Получить данные из формы, к которым еще не применены никакие проверки.
* $slashed - экранировать кавычки. По умолчанию true.
===== add_element($type, $name, $description, $attributes, $options) =====
Добавить элемент в форму. Наиболее часто используемая функция при построении формы.
$type - Тип элемента
$name - Имя элемента в форме. Только латинские буквы.
$description - Описание элемента. Выведется слева от него.
$attributes - строка с параметрами, вставляемая в html-тег элемента.
$options - массив с дополнительными параметрами. Назначение параметров зависит от типа элемента.

Поведение самой функции ''add_element'' также зависит от типа добавляемого элемента. Подробнее об этом - см. раздел [[Разработка:moodleQuickForm#Элементы формы|Элементы формы]].

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

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

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

Пример:
// создаем массив
$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) =====
Вставляет элемент перед уже ранее добавленным функцией [[Разработка:moodleQuickForm#add_element($type, $name, $description, $attributes, $options) | add_element()]]. Этот метод полезно применять в динамических формах, внутри функции [[Разработка:moodleQuickForm#definition()|definition()]] или [[Разработка:moodleQuickForm#definition_after_data()|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) =====
Добавить правило для отдельного поля. Эту функцию следует использовать для проверок на стороне клиента и простых проверок на стороне сервера. Для сложных проверок данных (например с использованием обращения к БД) используйте функцию [[Разработка:moodleQuickForm#validation($data, $files) | validation()]].

* $element - имя элемента, к которому применяется проверка
* $message - сообщение, в случае если проверка не пройдена
* $type - тип правила проверки (см. таблицу ниже)
* $format - дополнительные данные, требующиеся для некоторых проверок. По умолчанию null.
* $validation - на какой стороне производить проверку. Возможные значения:
** server - на стороне сервера (по умолчанию)
** client - на стороне клиента
* $reset - используется при проверке на стороне клиента. Сбрасывать ли данные в этом поле на значение по умолчанию, если введены неправильные данные? по умолчанию false (не сбрасывать).
* $force - применять ли проверку даже если проверяемый элемент не существует? По умолчанию false (не применять). Этот параметр используется для проверок в динамических формах.

{| border="1"
|+ Таблица типов правил для полей формы
! Имя
! Описание
! width="50%" |Пример кода
|-
|required
|Обязательное поле
|<pre>$mform->addRule('testname','Это поле является обязательным', 'required',null,'client');</pre>
|-
|minlength
|Минимальная длина значения в поле.
|<pre>$mform->addRule('testname','Слишком короткое значение', 'minlength', 10,'client');</pre>
|-
|maxlength
|Максимальная длина значения в поле.
|<pre>$mform->addRule('testname','Слишком длинное значение', 'maxlength', 256,'client');</pre>
|-
|rangelength
|Проверка длины значения с обеих сторон: например не больше 5 и не меньше 7. Параметры задаются массивом из двух элементов. В данном примере от 111 до 222.
|<pre>$mform->addRule('testname','Длина значения неправильна', 'rangelength', array(111, 222),'client');</pre>
|-
|email
|Проверка email-адреса
|<pre>$mform->addRule('testname','неправильный email', 'email',null,'client');</pre>
|-
|regex
|Проверка данных регулярными выражениями. Используется редко, в случае, когда обычных проверок недостаточно.
|
|-
|lettersonly
|Только латинские буквы.
|<pre>$mform->addRule('testname','Ошибка', 'lettersonly', null,'client');</pre>
|-
|alphanumeric
|Только латинские буквы и цифры
|<pre>$mform->addRule('testname','Ошибка', 'alphanumeric', null,'client');</pre>
|-
|numeric
|Целое или дробное число
|<pre>$mform->addRule('testname', 'В этом поле разрешены только числа', 'numeric', null, 'client');</pre>
|-
|nopunctuation
|В строке не должны присутствовать специальные символы. Список: '''()./*^?#!@$%+=,"'><~[]{}'''
|<pre>$mform->addRule('testname', 'Введены запрещенные символы', 'nopunctuation', null, 'client');</pre>
|-
|nonzero
|Ненулевое значение
|<pre>$mform->addRule('testname', 'Только ненулевые значения', 'nonzero', null, 'client');</pre>
|-
|callback
|Использовать пользовательскую функцию для проверки данных. Используется крайне редко, если у вас есть сложные проверки - то лучше используйте для них функцию [[Разработка:moodleQuickForm#validation($data, $files) | validation()]].
|
|-
|compare
|Сравнить два значения. Может использоваться для сравнения чисел и строк. Операторы, используемые для сравнения:
* '''==''' равно
* '''!=''' не равно
* '''>''' больше
* '''>=''' больше или равно
* '''<''' меньше
* '''<=''' меньше или равно
|<pre></pre>
|-
|uploadedfile
|
|
|-
|maxfilesize
|Проверка максимального значения файла для конкретного поля
|
|-
|mimetype
|Проверка mime-типа загруженного файла.
|
|-
|filename
|Проверка имени файла. Убираются все потенциально опасные символы.
|
|}

===== is_submitted() =====
Возвращает ''true'' если форма подтверждена кнопкой типа "submit", и ''false'' в противном случае. Обратите внимание, что кнопка "отмена" в форме также является кнопкой типа "submit", поэтому используйте для этих целей функцию is_canceled().
Для проверки того, что данные отправлены в форму, и корректно прошли все проверки на стороне сервера и клиента, можно использовать такую конструкцию:
<pre>
if ( $form->is_submitted() AND confirm_sesskey() AND $formdata = $form->get_data() AND ! $form->is_cancelled() )
{//даные переданы и прошли все проверки

....

}elseif( $form->is_cancelled() )
{// ввод данных отменен

....

}
</pre>
Здесь:
* ''$form->is_submitted()'' - проверка того, что данные в форме были отправлены кнопкой типа "submit"
* ''confirm_sesskey()'' - проверка того, что данные отправлены внутри текущей сессии (встроенная функция moodle)
* ''$formdata = $form->get_data()'' - получение данных формы, и одновременное подтверждение того, что данные прошли все проверки, не не нажата кнопка "отмена".

Также возможно сначала проверять is_canceled(), а потом is_submitted().

===== 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 можно посмотреть в статье [[Разработка:Константы_Moodle#Константы типов данных|константы типов данных]]

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

Используется для дополнительной проверки данных на стороне сервера. Все необходимые сложные проверки должны быть проведены именно здесь. Для простых проверок (на тип данных, проверка email-адреса и т. п.) используйте функцию [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force) | addRule()]]
* $data - массив вида array('имя_поля' => 'значение') из отправленных данных
* $files - массив загруженных в форму файлов. Имеет вид array('имя_поля' => 'путь_к_временному_файлу')

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

===== disabledIf($elementName, $dependentOn, $condition, $value) =====
Эта функция используется для того чтобы установить зависимости между полями формы. До тех пор пока одно поле формы не будет выделено, или в него не будет введено нужное значение, другое не станет активным.

К одному элементу формы можно применять несколько правил disabledIf. Несколько элементов могут зависеть от одного поля.
* $elementName - имя зависимого элемента.
* $dependentOn - имя элемента, чье состояние должно быть проверено условием $condition.
* $condition - по умолчанию 'notchecked'.
* $value - значение, используемое для проверки условия. По умолчанию "1".

{| border="1"
|+ Таблица вариантов условий для параметра $condition
! Значение
! Пояснение
|-
|''checked''
|Элемент выделен. Используется для элементов radio и checkbox. Не работает с элементами advcheckbox.
|-
|''notchecked''
|Элемент не выделен. Используется для элементов radio и checkbox. Не работает с элементами advcheckbox.
|-
|''eq''
|Значение указанного элемента равно значению указанному в параметре $value.
|-
|''noteq''
|Значение указанного элемента не равно значению указанному в параметре $value.
|-
|''noitemselected''
|В указанном html-элементе "select" ничего не выбрано.
|}
===== applyFilter($elementName, $functionName); =====
Применить проверку элементу формы.

Параметры
* ''$elementName'' - название элемента внутри формы. В качестве имени можно использовать специальное значение '''__ALL__''' чтобы применить проверку ко всем элементам.
* ''$functionName'' - название функции (без скобок и аргументов), которая должна быть применена к этому элементу

Пример:
// применение проверки ко всем элементам
$mform->applyFilter('__ALL__', 'trim');

// применение проверки к одному элементу
$mform->applyFilter('lastname', 'addslashes');
===== closeHeaderBefore($elementName) =====
Закрыть рамку формы до элемента с указанным именем. Эта функция позволит вам выносить нижние элементы "за пределы" визуальной рамки формы, а также добавлять элементы без заголовка.
Иными словами, эта функция закрывает тег [http://htmlbook.ru/html/fieldset.html <FIELDSET>].
Эта функция должна быть обязательно вызвана ПОСЛЕ добавления элемента, перед которым закрывается рамка формы.

Пример:
// добавляем элемент формы
$mform->addElement('text', 'name', $this->dof->get_string('name','plans').':');
// Выносим его, и следующие элементы за рамку формы
$mform->closeHeaderBefore('name')

== Элементы формы ==
Во всех приведенных примерах переменная $form обозначает ссылку на объект HTML_QuickForm. Подробнее об этом в описании функции [[Разработка:moodleQuickForm#definition() |definition()]]. Во всех текстовых полях (кроме кнопок) можно использовать html-теги форматирования.

=== header ===
Заголовок формы. Этот заголовок будет говорить об общем содержании данных в форме. Также он используется в случае, когда вам нужно разбить форму на несколько частей.
Если вам нужно закрыть рамку заголовка перед каким-либо элементом, используйте функцию [[#closeHeaderBefore($elementName) |closeHeaderBefore()]]
<pre>$mform->addElement('header','testname', 'Текст заголовка');</pre>

=== checkbox ===
Стандартный html-элемент checkbox.
<pre>$mform->addElement('checkbox', 'testname', 'Текст_перед_галочкой', 'Текст_после галочки');</pre>

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

=== group ===
Добавление группы элементов. Для того, чтобы добавить группу элементов, их нужно предварительно создать при помощи функции [[Разработка:moodleQuickForm#create_element($type, $name, $description, $attributes, $options)|create_element()]]
Параметры (в порядке перечисления):
* тип
* название элемента
* пояснение
* массив с элементами
* разделитель для элементов (в примере - тег <br>)
* добавить ли имя группы к имени элемента (true - добавить)
<pre>
// создаем массив
$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, '<br>', true);
</pre>

=== password ===
Стандартный html-элемент password
<pre>mform->addElement('password', 'testname', 'Текст перед окном с паролем');</pre>

=== passwordunmask ===
То же самое, что и элемент password, но с дополнительной галочкой "отобразить пароль".
<pre>$mform->addElement('passwordunmask', 'testname', 'Текст перед окном с паролем');</pre>

=== radio ===
Стандартный html-элемент radio. Единственный элемент в quickform, несколько объектов которого можно добавить, используя одинаковое значение name.
<pre>$mform->addElement('radio', 'testname', 'Текст до переключателя 1',
'Текст после переключателя 1', 'Значение1');
$mform->addElement('radio', 'testname', 'Текст до переключателля 2',
'Текст после переключателя 2', 'Значение2');</pre>

=== select ===
Стандартный html-элемент select. Массив $choices содержит варианты для оператора select. Значениями массива являются текстовые надписи в списке выбора, а ключами - значения этих вариантов.
<pre>
// создаем массив с вариантами выбора
$choices = array('a' => 'Текст варианта 1', 'b' => 'Текст варианта 2');

// Добавляем элемент формы
$mform->addElement('select', 'testname', 'Пояснение для строки выбора', $choices);
</pre>
==== Дополнительные функции ====
Элемент select обладает дополнительными методами, которые
* addOption($text, $value, $attributes=null) - добавить новый вариант к select-элементу, уже после того как он был создан, и в него были установлены значения. Параметры:
** $text - текст, который отображается пользователю
** $value - значение, которое передается из формы
** $attributes - дополнительные html-атрибуты тега OPTION (если требуется). Передаются строкой, либо массивом в формате ключ-значение.
Пример:
<pre>
$select = $mform->getElement('testname');
$select->addOption('Текст для отображения', 555);
</pre>

=== selectgroups ===
=== submitlink ===
=== text ===
Стандартный html-элемент text. Последний параметр - строка html-атрибутов. В данном примере длина поля задана 100%. Это гарантирует, что элемент будет нормально выглядеть и умещаться в форму при любых размерах экрана.
<pre>$mform->addElement('text', 'testname', 'Пояснение для текстового поля', ' width="100%" ');</pre>
=== textarea ===
Стандартный html-элемент textarea. Значения ширины и высоты задаются в виде массива, последним аргументом. Ширину поля также рекомендуется задавать 100%.
<pre>$mform->addElement('textarea', 'testname', 'Пояснение:', array('width'=>'100%', 'height'=>'100px'));</pre>
=== date_selector ===
Диалоговое окно с выбором даты. Обратите внимание, что при получении данных через [[Разработка:moodleQuickForm#get_data($slashed)|get_data()]] значение этого поля автоматически трансформируется в метку unixtime на 12:00:00 дня выбранной даты. По умолчанию выставляется текущая дата и время. Другое начальное значение может быть задано при помощи функции [[Разработка:moodleQuickForm#setDefault($elementName, $defaultValue, $slashed)|setDefault()]].
<pre>
$options = array();// объявляем массив для установки значений по умолчанию
$options['startyear'] = 1980; // устанавливаем год, с которого начинать вывод списка
$options['stopyear'] = 2001; // устанавливаем год, которым заканчивается список
$options['optional'] = false; // убираем галочку, делающую возможным отключение этого поля

$mform->addElement('date_selector', 'testname', 'Пояснение для поля даты', $options);
// устанавливаем время по умолчанию на год вперед
$mform->setDefault('testname', time()+3600*24*365);
</pre>
=== date_time_selector ===
Этот элемент аналогичен элементу date_selector, только добавлены параметры часов и минут. Полученные данные также трансформируются в unixtime, но уже для выбранных значений часов и минут. По умолчанию выставляется текущая дата и время. Другое начальное значение может быть задано при помощи функции [[Разработка:moodleQuickForm#setDefault($elementName, $defaultValue, $slashed)|setDefault()]].
<pre>
$options = array();// объявляем массив для установки значений по умолчанию
$options['startyear'] = 1980; // устанавливаем год, с которого начинать вывод списка
$options['stopyear'] = 2001; // устанавливаем год, которым заканчивается список
$options['optional'] = false; // убираем галочку, делающую возможным отключение этого поля

$mform->addElement('date_time_selector', 'testname', 'Пояснение для поля даты', $options);
</pre>
=== htmleditor ===
Полноценный html-редактор для редактирования страниц. Его вид (обычный или расширенный) настраивается индивидуально каждым пользователем для себя (в настройках профиля moodle). Обратите внимание, что в качестве дополнительных параметров можно массивом передать значения ширины и высоты текстового поля.
<pre>
$mform->addElement('htmleditor', 'testname', 'Пояснение:', array('width'=>'100%', 'height'=>'200px')

</pre>
=== format ===
Выбор формата для редактирования сообщения. Полезно использовать вместе со встроенным html-редактором.
<pre>$mform->addElement('format', 'testname', 'Текст пояснения');</pre>
=== static ===
Обычное текстовое поле, не передает никаких данных. Полезно использовать для различных пояснений и отображения текущей информации о каком-либо объекте. Вы также можете использовать этот элемент для разбиения формы на небольшие смысловые блоки, не разрывая рамку формы. Для более явного разбиения используйте элемент header.
<pre>$mform->addElement('static', 'testname', 'Пояснение:', '<b><i>Само текстовое значение</i></b>');</pre>
=== hidden ===
Стандартный html-элемент hidden, скрытое поле для передачи служебных id, адресов для перенаправления и т. д. Помните о необходимости проверки значений из этого поля.
<pre>$mform->addElement('hidden','testname', 'Значение скрытого поля');</pre>
=== modvisible ===
Установить модуль видимым/скрытым. Только для использования внутри Mooodle.
=== selectyesno ===
Элемент с двумя стандартными select-вариантами выбора: да и нет.
<pre>
$mform->addElement('selectyesno', 'testname', 'Текст пояснения');
// установить значение по умолчанию "да"
$mform->setDefault('stoponerror', 1);
</pre>
=== modgrade ===
Шкала выставление оценки за задание. Только для использования внутри Moodle.
=== cancel ===
Кнопка "отменить форму". При нажатии на нее происходит отмена всех произведенных в форме действий.
<pre>$mform->addElement('cancel', 'testname', 'Надпись на кнопке'); </pre>
=== button ===
Элемент аналогичен кнопке типа submit, но при использовании button пропускается проверка данных на стороне клиента.
<pre>$mform->addElement('button', 'testname', 'Надпись на кнопке');</pre>
=== choosecoursefile ===
Выбрать файл из курса. Только для использования внутри курса Moodle.
=== submit ===
Кнопка отправки данных из формы. Обязательно ставьте ее в конце, иначе все введенные данные нельзя будет отправить. Существует также альтернативный способ задать такую кнопку - это функция [[Разработка:moodleQuickForm#add_action_buttons($cancel, $submitlabel)|get_data()]]
<pre>$mform->addElement('submit', 'testname', 'Текст на кнопке');</pre>
=== questioncategory ===
Выбрать вопрос из категории. Только при редактировании теста и только внутри курса Moodle.
=== advcheckbox ===
Элемент checkbox c расширенными функциями - такие элементы можно объединять в группы и устанавливать им контрольный переключатель (делает либо все галочки поставлеными либо снятыми) при помощи функции [[Разработка:moodleQuickForm#add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue) |add_checkbox_controller()]].

Поскольку таких галочек всегда задается несколько - то целесообразно в указании имени элемента использовать квадратные скобки, чтобы собрать значения всех элементов в один массив. Последним аргументом задается группа, к которой принадлежит созданный элемент. Именно это значение должно быть указано в первом параметре функции [[Разработка:moodleQuickForm#add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue) |add_checkbox_controller()]].

Несовместим с функцией [[Разработка:moodleQuickForm#disabledIf($elementName, $dependentOn, $condition, $value) | disabledIf()]]

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

$mform->addElement('advcheckbox', 'testname[2]', 'Описание:', 'Текст за галочкой', array('group' => 'id_группы'));
</pre>
=== recaptcha ===
Окно с картинкой для использования Capcha проверки. Обратите внимание, что для того чтобы использовать этот элемент вы сначала должны получить уникальный ключ с на сайте <nowiki>http://recaptcha.net/api/getkey</nowiki>.
<pre>$mform->addElement('recaptcha', 'testname', 'Текст с пояснением');</pre>
=== hierselect ===
Несколько зависимых друг от друга html-элементов типа "select". В зависимости от выбранной опции в первом элементе, меняются значения остальных.
При вызове функции addElement в последнем параметре указывается, какими символами разделять операторы select.
<pre>
// для начала создадим два массива - по количеству операторов select
// которые нам предстоит создать

// Первый, главный элемент select
$select1[0] = 'Pop';
$select1[1] = 'Classical';
$select1[2] = 'Funeral doom';

// второй элемент select - его варианты зависят от первого
$select2[0][0] = '--- Artist ---';
$select2[0][1] = 'Red Hot Chil Peppers';
$select2[0][2] = 'The Pixies';

$select2[1][0] = '--- Artist ---';
$select2[1][1] = 'Wagner';
$select2[1][2] = 'Strauss';

$select2[2][0] = '--- Artist ---';
$select2[2][1] = 'Pantheist';
$select2[2][2] = 'Skepticism';

// добавляем новый элемент в форму
$myselect =& $mform->addElement('hierselect', 'testname', 'Текст с пояснением:',null,'<br>');
// устанавливаем для него варианты ответа
$myselect->setOptions(array($select1, $select2));
// устанавливаем значения по умолчанию: 'Funeral doom'->'Pantheist'
$mform->setDefault('testname', array(2, 1));
</pre>
=== html ===
Добавить собственный html-код. Используйте этот тип элементов формы, только в случае, если ни один из перечисленных элементов вам не подходит, или нужно решить какую-либо нетривиальную задачу с форматированием.
Может помочь в случае решения задачи разбиения формы на 3, или более колонок ([http://docs.moodle.org/en/User:Frank_Ralf/Moodle_forms3] [http://moodle.org/mod/forum/discuss.php?d=126935]).
<pre>$mform->addElement('html', '<div class="qheader">');</pre>
=== autocomplete ===
Элемент, который автоматически подсказывает варианты по мере набора текста. Выглядит как обычный элемент text, но имеет встроенный javascript. Значение по умолчанию устанавливается стандартным образом.
<pre>// Создаем массив подсказок
$options = array('апельсин', 'ананас', 'авокадо');
// добавляем новый элемент в форму
$element =& $mform->addElement('autocomplete', 'testname', 'Текст с пояснением:', 'size=12');
// устанавливаем массив подсказок
$element->setOptions($options);
</pre>

=== dof_calendar ===
Элемент, который автоматически отображает 2 календаря для выбора диапозона дат. Календари находятся на одной линии. Под каждым календарем поле-указывает в формате д.м.гг дату, которая выбрана на календаре. В скрытое поле каждого календаря помещается время в unix time, причем в "с" береть отчет от 00.00.01, в "до" с 23.59.59. Если на правом и на левом календарях отмечена одна дата, то диапозон ,соотвественно, равен 00.00.01-23.59.59, что полностью охватывает выбранный день
<pre>
// добавляем новый элемент в форму
$element = $mform->addElement('dof_calendar', 'calendarname', 'Текст с пояснением:', $options),где
'Текст с пояснением:' - Текст, который будет выведен выше календарей
$options - массив, с указанием дат(левый и праавй календарь)
* $options['date_from'] - с какой даты брать отсчет(левый календарь)(unix time)
* $options['date_to'] - по какую дату брать отсчет(правый календарь)(unix time)
</pre>
Если параметр options опущен, то береться текущая дата.
Важно !! При объявлении времени, нужно брать массив именно с ЭТИМИ параметры(date_from, date_to).
Выходные данные имеют вид
<pre>
[testname] = Array
[testname] = полученное значение
[id_autocomplete] = id значения
</pre>

=== dof_autocomplete ===
Элемент с выпадающим списком подсказок по мере набора текста. Выглядит как обычный элемент text, но имеет встроенный javascript. В помощь с ним создается автоматически hidden поле, значение которого будет равно индексу выбранного элемента(name="id_autocomplete" id="id_hidden_auto"). В dof_autocomplete есть обязательные параметры, работа без которых не возможна. Записываются они в переменную массив <b>$options</b>. В неё же и помещается массив option(ключ=>значени), это так называемые значения по умолчанию(не обязательные).
*Список обязательных полей для переменной $options:
**plugintype - тип плагина ( например storage)
**plugincode - код плагина ( например plans)
**queryty - тип запроса, именно по нему и определяется, что надо делать( например plans_name ). Этот тип должен совпадать с типом, который будет находиться в этом в плагине в методе widgets_field_variants_list
**sesskey - ключ сессии(чтоб идентифицировать запрос) задается методом sesskey()
**type - тип действия ( например autocomplete ). Есть ещё тип savefield
*Необязательные поля:
**option - массив значений по умолчания( например $a[19]= "primer"), где ключ - это id элемента из бд

<pre> $mform->addElement('dof_autocomplete', $elementName = null, $elementLabel = null, $attributes = null, $options = null)
//Создаем массив входных данных
$options = array();
$options['plugintype'] = "storage";
$options['plugincode'] = "plans";
$options['querytype'] = "plans_name";
$options['sesskey'] = sesskey();
$options['type'] = 'autocomplete';
// установим значение по умолчанию
$mas = array( 19 => 'primer' );
$options['option'] = $mas;

// добавляем новый элемент в форму
$mform->addElement('autocomplete', 'testname', 'Текст перед полем:', 'size=12', $options);
// устаонвка типа
$mform->setType('testname', PARAM_TERXT);
</pre>
*Замечение:
**следует помнить, что элемент autocomplete сам в себе подключает js-библиотеки, и потому, объявление класса на странице должно быть ''раньше'', чем печать шапки страницы
**выходные данные имеют вид
<pre>
[testname] = Array
[testname] = полученное значение
[id_autocomplete] = id значения
</pre>
Необходимые методы:
Плагин, данные которого будут составлять автозаполнение должен иметь метод <b>widgets_field_variants_list($querytype, $data="")</b>, который возвращает массив объектов в формате <pre>
$a = arrya();
a[1] = object[
name = ЗНАЧЕНИЕ_1 ДЛЯ ВЫПАДАЮЩЕГО СПИСКА
id = id элемента_1
];
a[2] = object[
name = ЗНАЧЕНИЕ_2 ВЫПАДАЮЩЕГО СПИСКА
id = id элемента_2
];
...
]
</pre>где $querytype-тип запроса(обрабатывается путем case), $data-вх данные, как правило строка(набранные данные в поле autocomplete)
* Замечание:
** поля name и id обязательны в переданном массиве
** метод должен возвращать с LIMIT 15(не больше), для быстроты работы

=== dof_duration ===
Элемент для задания длительности временного интервала в часах, днях, неделях, и т. п.
<pre>
// задаем возможные единицы измерения: часы и минуты
$options['availableunits'] = array(60 => $this->dof->modlib('ig')->igs('minutes'),
3600 => $this->dof->modlib('ig')->igs('hours'));
// добавляем сам элемент
$mform->addElement('dof_duration', 'testname', 'Текст с пояснением:', $minutesoptions);
</pre>
=== dof_single_use_submit ===
Одноразовая submit-кнопка. Отправляет данные формы и сразу же становится неактивной, для того чтобы избежать повторного нажатия и отправки данных (doubleclick). Имеет дополнительный метод setPleaseWaitText(), при помощи которого можно устанавливать надпись, которая появляется после нажатия на кнопку.
<pre>
// создаем кнопку, с надписью "сохранить"
$submit = &$mform->addElement('dof_single_use_submit', 'testsinglesubmit', $this->dof->modlib('ig')->igs('save'));
// Устанавливаем сообщение после нажатия - "обработка"
$submit->setPleaseWaitText($this->dof->modlib('ig')->igs('processing'));
</pre>

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

=== Установка обязательных полей ===
Установка обязательных полей происходит при помощи функции [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force)|addRule()]].

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

=== Установка дополнительных полей ===
Установка дополнительных полей производится при помощи функции [[Разработка:moodleQuickForm#setAdvanced($elementName, $advanced)|setAdvanced()]]. Необязательные элементы должны располагаться один за другим.

Пример:
// устанавливаем два текстовых поля и делаем их необязательными
$mform->addElement('text', 'my_field1', 'Пояснение :');
$mform->setAdvanced('my_field1');
$mform->addElement('text', 'my_field2', 'Пояснение :');
$mform->setAdvanced('my_field2');

=== Установка проверки на стороне клиента или сервера ===
По умолчанию все данные из формы подлежат проверке на стороне сервера. Существует возможность добавить проверку на стороне клиента. Не забывайте при этом, что эти данные нужно потом все равно еще раз проверить на стороне сервера, так как всегда существует возможность послать данные в обход формы.
==== Проверка на стороне сервера ====
Если вам требуется дополнительная проверка данных на стороне клиента, то используйте стандартный метод [[Разработка:moodleQuickForm#validation($data, $files) | validation()]]. Любые другие способы проверки данных после формы должны использоваться только в исключительных случаях.

==== Проверка на стороне клиента ====
Все малозначимые проверки желательно производить на стороне клиента для увеличения быстродействия приложения. Все проверки на стороне клиента производятся при помощи функции [[Разработка:moodleQuickForm#addRule($element, $message, $type, $format, $validation, $reset, $force)|addRule()]].

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

Пример:
// устанавливаем поле "фамилия"
$mform->addElement('text', 'lastname', 'Фамилия :');
// делаем его обязательным
$mform->addRule('lastname','Это поле является обязательным', 'required',null,'client');
=== Установка зависимых полей ===
==== Стандартный вариант ====
Установка зависимых полей производится при помощи функции [[Разработка:moodleQuickForm#disabledIf($elementName, $dependentOn, $condition, $value)|disabledIf()]].

Пример:
// Устанавливаем элемент checkbox
$mform->addElement('checkbox', 'my_checkbox', get_string('forcedownload', 'resource'));
// устанавливаем текстовое поле
$mform->addElement('text', 'my_field', 'Пояснение :');
// устанавливаем зависимость
$mform->disabledIf('my_field', 'my_checkbox', 'checked');
==== Расширенный вариант ====
Для html-элеметов "select", есть возможность установить иерархическую зависимость элементов (то есть в зависимости от того, что было выбрано в первом "select", меняются значения в остальных). Синтаксис этого элемента указан в разделе [[Разработка:moodleQuickForm#Элементы формы|Элементы формы]] (в самом конце, он называется hierselect).

== Известные проблемы ==
В этом разделе собраны обнаруженные проблемы с элементами формы и способы их решения.
=== Данные не приходят из поля формы, даже в validation ===
Возможно на странице обработчика формы есть функция optional_param (или required_param) которая называется точно также как поле в форме. Если это так, то указанное поле из данных формы пропадет.
=== text ===
* Поле ввода слишком широкое, слишком узкое, или вылезает за границы заголовка
** Решение: Нужно в свойства элемента добавить style="width:100%;". В этом случае элемент растянется до конца формы, и не будет вылезать за границы формы вне зависимости от того - большой монитор у пользователя или маленький.
** Пример:
<pre>
$mform->addElement('select', 'my_select', 'Description...', $options, ' style="max-width:400px;width:100%;" ');
</pre>
=== textarea ===
* Поле ввода слишком широкое, слишком узкое, или вылезает за границы заголовка
** Решение: Нужно в свойства элемента добавить style="width:100%;". В этом случае элемент растянется до конца формы, и не будет вылезать за границы формы вне зависимости от того - большой монитор у пользователя или маленький.
** Пример:
<pre>
$mform->addElement('textarea', 'name', 'Description...', array('style' => 'width:100%;max-width:400px;height:150px;'));
</pre>
=== hierselect ===
* Не работает Javascript если в качестве значения hierselect используются цифры
** Решение: в списке значений после цифры добавлять пробел, или любой другой символ.
** Пример: array('1' => '''"1 "'''); вместо array('1' => '''"1"''');
* Невозможно отключить только одно поле hierselect не отключая при этом остальные
** Решение: отсутствует.
* При количестве select-элементов 3 или больше портится верстка. Подписи к select-элементам не совпадают с самими элементами.
** Решение: до элемента hierselect вставить html-элемент который содержит div, устанавливающий фиксированный межстрочный интервал (см. пример). После добавления hierselect-элемента закрыть div.
** Пример:
<pre>
// выравниваем строки по высоте
$mform->addElement('html', '<div style=" line-height: 1.9; ">');

// Дальше идет объявление hierselect...
// ...

// закрываем тег выравнивания строк
$mform->addElement('html', '</div>');
</pre>
* При указании строковых ключей массива hierselect не работает. Это происходит из-за того что в Javascript мы можем иметь дело либо с индексированными массивами, либо с объектами. Ассоциативные массивы там не предусмотрены.
** Решение: не использовать ассоциативные ключи массивов при создании элементов hierselect. Если же обойтись без них никак нельзя - то можно закодировать ассоциативные элементы числами ('option1' - 1, 'option2' - 2 и т. д.), а на стороне обработчика раскодировать обратно.
* По неизвестным причинам иногда перестает работать переключение с одной опции на другую.
** Решение: скорее всего в списке дочерних опций присутствуют элементы не для всех родительских опций (см. пример). Для каждой опции верхнего уровня должен присутствовать хотя бы один элемент нижнего уровня.
** Пример:
'''Неправильный код:'''
<pre>
$level1 = array();
$level1[0] = 'option0';
$level1[1] = 'option1';

$level2 = array();
$level2[1][0] = 'option1_0';
$level2[1][1] = 'option1_1';
</pre>
'''Правильный код:'''
<pre>
$level1 = array();
$level1[0] = 'option0';
$level1[1] = 'option1';

$level2 = array();
$level2[0][0] = 'option0_0'; // без этой строки ничего не будет работать
$level2[1][0] = 'option1_0';
$level2[1][1] = 'option1_1';
</pre>
* Данные из поля hierselect передаются вне зависимости от того, было отключено поле или нет.
** Решение: отсутствует.
* При проверке данных в функции validation() нельзя сообщить о том, что ошибка произошла внутри какого-то конкретного select-элемента.
** Решение: отсутствует. Можно указать только указывать сам hierselect-элемент как источник ошибки, и сообщить подробности в сообщении.

=== hidden ===
* Не работает правило disabledif. Невозможно установить значение из hidden-поля для использования disabledif-правила.
** Решение: создать другой элемент (например checkbox), записать в него нужное значение, и в стилях установить ему display:none
** Пример:
<pre>
$mform->addElement('radio', 'hidden_hack', '', '', 'true', 'style' => 'display:none;');
</pre>

== Ссылки ==
* [http://pear.php.net/manual/en/package.html.html-quickform.php Справка по базовым методам класса HTML_QuickForm]
* [http://docs.moodle.org/en/Development:lib/formslib.php_Form_Definition Справки по элементам класса moodleform]
* [http://web.archive.org/web/20080214041550/http://www.midnighthax.com/quickform.php Getting Started Guide по элементам оригинального класса HTML_QuickForm. Некоторые обращения к методам могут отличаться от moodleform.]
* [http://wiki.triangle-solutions.com/index.php/PEAR_HTML_QuickForm] Примеры объявления элементов.