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

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

Портфолио достижений

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

Интерфейс достижений

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

• Панель управления достижениями
• Плагины портфолио
• Панель модерации достижений пользователей
• Мое портфолио

Панель управления достижениями

Через данный интерфейс производится администрирование шаблонов достижений. Имеется возможность создавать разделы при помощи кнопки “добавить раздел”, выстраивая нужную иерархию. Среди настроек раздела доступны:

• Имя раздела
• Родительский раздел
• Доступность в рейтинге

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

Находясь в разделе имеется возможность добавлять шаблоны достижений при помощи кнопки “Добавить шаблон достижения”. Первым шагом добавления шаблона является настройка его основных характеристик таких как:

• Название шаблона
• Тип шаблона
• Раздел
• Баллы

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

Тип шаблона “Результаты заданий”

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

Тип шаблона “Критерий”

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

• текст - пользователю будет необходимо ввести текст при создании достижения
• дата - пользователю будет необходимо указать дату при создании достижения
• файл - пользователю будет необходимо прикрепить файл при создании достижения
• список - пользователю будет необходимо выбрать пункт из выпадающего списка при создании достижения

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

Плагины портфолио

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

Фильтрация пользователей

Подсистема фильтрации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - display_filter. Интерфейс позволяет настраивать поля, по которым будет возможно отфильтровать пользователей на странице просмотра рейтинга и на странице модерации. Среди полей будут отображаться дополнительные поля профилей типа “Выбор из списка” и “Переключатель”, а также поля достижений “Раздел” и “Дата создания достижения”.

Блок информации о пользователе

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

Панель модерации достижений пользователей

Подсистема модерации по умолчанию отключена и ее можно включить в настройках подразделения, в котором расположено редактируемое портфолио. Название требуемой настройки: im - achievements - system_moderation_enabled. В соответствии с фильтром (если доступен), в данном интерфейсе можно выбрать пользователей, у которых имеются достижения, требующие модерации. Список пользователей с указанием количества требующих модерации достижений, будет отображено в таблице с результатами фильтрации. Для доступа к интерфейсу модерации у пользователя должно быть право im - achievements - moderate. Для модерации самих достижений (процедура может быть осуществлена не только через этот интерфейс) у пользователя должно быть право im - achievements - achievementins/moderate.

Мое портфолио

Данный интерфейс предназначен для наполнения пользовательского портфолио достижениями и просмотра достижений пользователя. По умолчанию интерфейс отображает достижения пользователя, который в данный момент авторизован в системе, но он же может отобразить достижения другого пользователя, если передан параметр с идентификатором персоны деканата “personid”. Подобные ссылки на портфолио других пользователей доступны в рейтинге. В интерфейсе будет отображена информация о пользователе, настроенная ранее в инструменте “Блок информации о пользователе”. Чуть ниже - информация о рейтинге (количество баллов, место в рейтинге) и ссылка на рейтинг. Далее - форма добавления достижений и просмотр добавленных достижений с возможностью их фильтрации по разделу/шаблону, баллам и статусу.

Рейтинг

Страница рейтинга по умолчанию отображает рейтинг по разделу достижений, указанный в настройках подразделения, в котором расположено редактируемое портфолио. Требуемая настройка: storage - achievementcats - default_achievementcat. Если раздел, указанный в настройке не доступен, будет предложен выбор раздела. В начале страницы отображается форма фильтрации пользователей, участвующих в рейтинге, по полям, настроенным в описанном выше инструменте “Фильтрация пользователей”. Ниже отображается таблица пользователей с указанием места в рейтинге и набранных баллов.

API

delete_achievement

Удаление шаблона вместе со всеми пользовательскими достижениями, связанными с этим шаблоном

параметры:

• $id - ID шаблона
• $options - массив дополнительных опций удаления, не используется

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

• массив ошибок, полученных во время удаления шаблонов

delete_achievementin

Удаление пользовательского достижения

параметры:

• $id - ID достижения
• $options - массив дополнительных опций удаления, не используется

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

• массив ошибок, полученных во время удаления достижения

delete_achievementins_by_achievementid

Удаление пользовательских достижений по ID шаблона

параметры:

• $id - ID шаблона для удаления его пользовательских достижений
• $options - массив дополнительных опций удаления, не используется

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

• $errors - массив ошибок, полученных во время удаления достижений

delete_achievements_by_categoryid

Удаление шаблонов по ID раздела

параметры:

• $id - ID раздела для удаления его шаблонов
• $options - массив параметров удаления

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

• массив ошибок, полученных во время удаления шаблонов

delete_category

Удаление раздела вместе дочерними разделами, шаблонами, а также пользовательскими достижениями, связанными с этими шаблонами

параметры:

• $id - ID раздела для удаления
• $options - массив параметров удаления

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

• массив ошибок, полученных во время удаления раздела

get_achievementcatstable

Получение таблицы управления разделами достижений

параметры:

• $options - массив параметров для переопределения значений
• ['addvars'] - Массив GET-параметров

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

• HTML код таблицы

get_achievementins

Получение пользовательских достижений

параметры:

• $options - массив параметров для переопределения значений
  • ['departmentid'] - ID подразделения
  • ['personid'] - ID персоны, для которой производится построение таблицы
  • ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
    • 'points' - По баллу
    • 'status' - По статусу
  • ['dir'] - Направление сортировки

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

• HTML код таблицы

get_achievementinstable

Сформировать таблицу пользовательских достижений

параметры:

• $list - массив пользовательских достижений
• $options - массив параметров для переопределения значений
  • ['addvars'] - Массив GET-параметров
  • ['personid'] - ID персоны, для которой производится построение таблицы
  • ['sort'] - Поле , по которому происходит сортировка. Доступные значения:
    • 'points' - По баллу
    • 'status' - По статусу
  • ['dir'] - Направление сортировки
  • ['limitnum'] - Число достижений в таблице
  • ['limitfrom'] - Смещение

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

• HTML код таблицы

get_achievementstable

Получить таблицу управления шаблонами достижений

параметры:

• $options - массив параметров для переопределения значений
  • ['addvars'] - Массив GET-параметров

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

• HTML код таблицы

get_clear_myachievementstable

Получить таблицу достижений пользователя

параметры:

• $personid - ID персоны
• $options - массив дополнительных параметров
  • ['limitnum'] - Число выводимых записей

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

• HTML код таблицы

get_moderation_data

Получить список персон, у которых есть достижения, требующие модерации

параметры:

• $options - массив параметров для переопределения значений
  • ['addvars'] - Массив GET-параметров

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

• массив с данными по пользователям. В качестве ключей передаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений

get_moderation_table

Получить таблицу достижений, требующих модерации

параметры:

• $personachievements - Данные пользователей. В качестве ключей ожидаются идентификаторы пользователей, а в качестве значений - количество непроверенных достижений
• $options - массив параметров для переопределения значений
  • ['addvars'] - Массив GET-параметров

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

• HTML код таблицы

get_my_rating_block

Получить блок рейтинга пользователя

параметры:

• $id - ID целевого пользователя или текущего, если NULL
• $addvars - Массив GET-параметров для ссылки

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

• HTML-код блока

get_ratingtable

Получить таблицу рейтинга

параметры:

• $options - массив параметров для переопределения значений
  • ['addvars'] - Массив GET-параметров,
  • ['page'] - Страница,
  • ['limit'] - Число записей на странице

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

• HTML код таблицы

get_user_info

Получить информацию о пользователе

параметры:

• $personid - ID персоны
• $addvars - массив GET-параметров с идентификатором подразделения

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

• HTML код с информацией о пользователе

get_userrating_info

Получить информацию о рейтинге пользователя

параметры:

• $personid - опционально, ID персоны
• $achievementids - опционально, ID шаблонов достижения или массив шаблонов, по которым будет строиться рейтинг

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

• Объект с информацией о рейтинге пользователя

points_format

Форматирование значения рейтинга

параметры:

• $points - Значение рейтинга пользователя

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

• Отформатированное число