Разработка:im/programms — различия между версиями

Материал из DOF
Перейти к: навигация, поиск
м (Список учебных программ: дополнено описание списка программ)
м
 
(не показано 8 промежуточных версий 2 участников)
Строка 1: Строка 1:
== Учебные программы ==
+
{{Infobox_Plugin
 +
| name = programms
 +
| type = im
 +
}}== Учебные программы ==
 
Этот интерфейс позволяет просматривать и редактировать информацию об учебных программах.
 
Этот интерфейс позволяет просматривать и редактировать информацию об учебных программах.
 
=== Список учебных программ ===
 
=== Список учебных программ ===
Строка 12: Строка 15:
 
Если у пользователя есть право редактировать учебные программы, то в последней строке таблицы с информацией вместо иконки просмотра появляется иконка редактирования, нажатие на которую отправляет пользователя на страницу редактирования учебной программы.
 
Если у пользователя есть право редактировать учебные программы, то в последней строке таблицы с информацией вместо иконки просмотра появляется иконка редактирования, нажатие на которую отправляет пользователя на страницу редактирования учебной программы.
  
=== Создание и редактирование учебной программы ===
+
=== Создание и редактирование ===
Это действие доступно только для пользователей с правом редактирования учебной программы. Для создания и для редактирования учебной программы используется форма такого вида:
+
Это действие доступно только для пользователей с правом редактирования учебной программы. Для создания и для редактирования используется форма такого вида:
  
[[Изображение:im-programms-form.jpg]]
+
[[Изображение:im-programms-form1.jpg]]
  
 
'''Назначение полей:'''
 
'''Назначение полей:'''
Строка 21: Строка 24:
 
* ''Код'' - код учебной программы, обязательное поле. Не может быть создано двух программ с одинаковым кодом.
 
* ''Код'' - код учебной программы, обязательное поле. Не может быть создано двух программ с одинаковым кодом.
 
* ''Подразделение'' - название подразделения, к которому будет привязана учебная программа. Если пользователь имеет право редактировать информацию обо всех подразделениях - то ему выведется весь список подразделений. Если пользователь имеет право редактировать только одно подразделение - то сможет добавить учебную программу только в него. При перенесении существующей учебной программы из одного подразделения в другое будет проверяться сначала право удалять программу из текущего подразделения, а потом право добавлять программу в новое подразделение. Если оба этих условия соблюдены - программа переносится. Если же нет - то выдается ошибка о том, что пользователь не имеет права переносить программу.
 
* ''Подразделение'' - название подразделения, к которому будет привязана учебная программа. Если пользователь имеет право редактировать информацию обо всех подразделениях - то ему выведется весь список подразделений. Если пользователь имеет право редактировать только одно подразделение - то сможет добавить учебную программу только в него. При перенесении существующей учебной программы из одного подразделения в другое будет проверяться сначала право удалять программу из текущего подразделения, а потом право добавлять программу в новое подразделение. Если оба этих условия соблюдены - программа переносится. Если же нет - то выдается ошибка о том, что пользователь не имеет права переносить программу.
* ''Длительность обучения'' - здесь указываются нормативные данные по длительности программы: количество дней, академических часов и и семестров, отведенных на нее.  
+
* ''Количество часов'' - здесь указываются нормативные данные по длительности программы: количество академических часов, отведенных на нее.  
* Количество учебных периодов - сколько учебных периодов будет длиться программа. Количество периодов напрямую связано с количеством учебных программ в таблице [[Разработка:storages/programmitems|programmitems]]. Количество периодов не может быть меньше, чем максимальное число в поле agenum для элементов данной учебной программы.
+
* ''Количество дней'' - здесь указываются нормативные данные по длительности программы: количество дней, отведенных на нее. В таблице это поле duration, и данные хранятся в секундах.
 +
* ''Количество учебных периодов'' - сколько учебных периодов будет длиться программа. Количество периодов напрямую связано с количеством учебных периодов в таблице [[Разработка:storages/programmitems|programmitems]]. Количество периодов не может быть меньше, чем максимальное число в поле agenum для элементов данной учебной программы.
 +
* ''Описание'' - краткое описание учебной программы для учеников и учителей
 +
* ''Заметки'' - заметки по учебной программы для методистов
 +
 
 
== API ==
 
== API ==
 
Здесь описаны функции для работы со списком учебных программ.
 
Здесь описаны функции для работы со списком учебных программ.
Строка 33: Строка 40:
  
 
''Возвращаемые значения:''
 
''Возвращаемые значения:''
* (array) массив записей из базы, или false в случае ошибки
+
* (array) массив записей из базы, или false в случае ошибки
 +
 
 +
===== form() =====
 +
Возвращает форму создания/редактирования учебногой программы с начальными данными
 +
 
 +
''Параметры:''
 +
* $id - id учебной программы в таблице [[Разработка:storages/programms|programms]], для редактирования которой вызывается форма. По умолчанию NULL (создается новая учебная программа).
 +
 
 +
''Возвращаемые значения:''
 +
* [[Разработка:moodleQuickForm|moodleQuickForm]] object - объект формы, с загруженными в нее исходными данными.
 +
 
 +
===== showlist() =====
 +
Возвращает html-код отображения информации о нескольких учебных программах.
 +
 
 +
''Параметры:''
 +
* $list - массив записей из таблицы [[Разработка:storages/programms|programms]] для отображения.
 +
 
 +
''Возвращаемые значения:''
 +
* (string) - html-код или false в случае ошибки
 +
 
 +
===== show_id() =====
 +
Возвращает html-код отображения информации об одной учебной программе
 +
 
 +
''Параметры:''
 +
* $id - id записи в таблице [[Разработка:storages/programms|programms]]
 +
 
 +
''Возвращаемые значения:''
 +
* (string) - html-код или false в случае ошибки

Текущая версия на 23:12, 4 февраля 2010

Плагин
Название programms
Тип im

Учебные программы

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

Список учебных программ

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

  • Название
  • Код
  • Статус (список возможных статусов указан в плагине workflows/programms)

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

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

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

Создание и редактирование

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

Im-programms-form1.jpg

Назначение полей:

  • Название - название учебной программы. Обязательное поле.
  • Код - код учебной программы, обязательное поле. Не может быть создано двух программ с одинаковым кодом.
  • Подразделение - название подразделения, к которому будет привязана учебная программа. Если пользователь имеет право редактировать информацию обо всех подразделениях - то ему выведется весь список подразделений. Если пользователь имеет право редактировать только одно подразделение - то сможет добавить учебную программу только в него. При перенесении существующей учебной программы из одного подразделения в другое будет проверяться сначала право удалять программу из текущего подразделения, а потом право добавлять программу в новое подразделение. Если оба этих условия соблюдены - программа переносится. Если же нет - то выдается ошибка о том, что пользователь не имеет права переносить программу.
  • Количество часов - здесь указываются нормативные данные по длительности программы: количество академических часов, отведенных на нее.
  • Количество дней - здесь указываются нормативные данные по длительности программы: количество дней, отведенных на нее. В таблице это поле duration, и данные хранятся в секундах.
  • Количество учебных периодов - сколько учебных периодов будет длиться программа. Количество периодов напрямую связано с количеством учебных периодов в таблице programmitems. Количество периодов не может быть меньше, чем максимальное число в поле agenum для элементов данной учебной программы.
  • Описание - краткое описание учебной программы для учеников и учителей
  • Заметки - заметки по учебной программы для методистов

API

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

get_listing()

Параметры:

  • $limitfrom - с какой записи начинать вывод
  • $limitnum - сколько записей выводить на одной странице
  • $conds - Обьект, содержащий данные с условиями выборки, в формате поле_БД->значение по умолчанию пустой массив

Возвращаемые значения:

  • (array) массив записей из базы, или false в случае ошибки
form()

Возвращает форму создания/редактирования учебногой программы с начальными данными

Параметры:

  • $id - id учебной программы в таблице programms, для редактирования которой вызывается форма. По умолчанию NULL (создается новая учебная программа).

Возвращаемые значения:

  • moodleQuickForm object - объект формы, с загруженными в нее исходными данными.
showlist()

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

Параметры:

  • $list - массив записей из таблицы programms для отображения.

Возвращаемые значения:

  • (string) - html-код или false в случае ошибки
show_id()

Возвращает html-код отображения информации об одной учебной программе

Параметры:

  • $id - id записи в таблице programms

Возвращаемые значения:

  • (string) - html-код или false в случае ошибки