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

Материал из DOF
Перейти к: навигация, поиск
(→‎Создание нового пользователя)
 
(не показано 5 промежуточных версий этого же участника)
Строка 39: Строка 39:
 
* Когда выдан
 
* Когда выдан
 
* Кем выдан
 
* Кем выдан
−
 
+
[[Файл:Selection 137.png|700px|thumb|center|Форма с полями "Персона"]]
 
''Адрес регистрации / Адрес фактического проживания / Адрес рождения''
 
''Адрес регистрации / Адрес фактического проживания / Адрес рождения''
 
* Почтовый индекс
 
* Почтовый индекс
Строка 52: Строка 52:
 
* Широта
 
* Широта
 
* Долгота
 
* Долгота
−
 
+
[[Файл:Selection 138.png|700px|thumb|center|Форма с полями "Адрес регистрации / Адрес фактического проживания / Адрес рождения"]]
−
''Дополнительные параметры''
+
''Дополнительные поля''
 
* Подразделение (Обязательное поле)
 
* Подразделение (Обязательное поле)
 
* Синхронизирован с Moodle
 
* Синхронизирован с Moodle
 
* Пользователь в Moodle
 
* Пользователь в Moodle
 +
[[Файл:Selection 139.png|700px|thumb|center|Форма с полями "Дополнительные поля"]]
  
 
== Массовая операция пересона пользователей в другое подразделение ==
 
== Массовая операция пересона пользователей в другое подразделение ==
 
Для переноса пользователей, необходимо необходимо выбрать персон, затем выбрать подразделение, в которое нужно перевести.
 
Для переноса пользователей, необходимо необходимо выбрать персон, затем выбрать подразделение, в которое нужно перевести.
 
[[Файл:Selection 136.png|700px|thumb|center|Интерфейс плагина "Персоны"]]  
 
[[Файл:Selection 136.png|700px|thumb|center|Интерфейс плагина "Персоны"]]  
 +
 
= API =
 
= API =
−
Здесь описаны функции для работы с пользователями.
 
  
−
=API=
+
===== get_fullname() =====
−
Надо переделать функцию get_listing().
+
Возвращает полное имя пользователя
−
* перенести ее (и get_select_listing) в справочник.
+
''Параметры:''
−
* добавить в нее новый входной параметр $countonly = false;
+
* $personid - ID персоны
−
* переделать ее таким образом, чтобы она возвращала набор объектов или их количество.
+
* $islink - вернуть в виде ссылки на персону
−
** Если $countonly=false, функция возвращает набор объектов с учетом $limitnum, $limitfrom;
+
* peronobj - опционально вместо ID персоны можно отправить объект персоны
−
** Если $countonly=true, функция возвращает число - количество объектов, которые были выбраны по заданным параметрам (при этом $limitnum, $limitfrom в запрос не включаются);
+
 
−
** Запрос на выборку формируется как и ранее в get_select_listing(), на основе анализа названий полей переданных параеметров
+
''Возвращаемые значения:''
 +
* (string) - строка с полным именем пользователя
 +
 
 +
===== show_person_html() =====
 +
Возвращает html код с информацией о персоне
 +
''Параметры:''
 +
* $id - ID персоны
 +
* $addvars - GET-параметры для формирования списков
  
−
===== order() =====
+
''Возвращаемые значения:''
−
Подключает методы для работы с приказом
+
* (string) - html код с информацией о персоне
  
 +
===== show_list() =====
 +
Возвращает html код для отображения информации о нескольких персонах
 
''Параметры:''
 
''Параметры:''
−
* $code (string) - код типа для исполнения приказа
+
* $list - список объектов персон
−
* $id - id записи в таблице [[Разработка:storages/orders|orders]]
+
* $addvars - GET-параметры для формирования ссылок
 +
* $options - дополнительные параметры
  
 
''Возвращаемые значения:''
 
''Возвращаемые значения:''
−
* (object) [[Разработка:storages/orders#API | order]]  - объект приказа
+
* (string) - html код с информацией о персонах
 +
 
 +
===== show_list_as_cards() =====
 +
Печать пользователей в виде карточек
 +
''Параметры:''
 +
* $persons - список объектов персон
 +
* $addvars - GET-параметры для формирования ссылок
 +
* $options - дополнительные параметры
  
 +
''Возвращаемые значения:''
 +
* (void) - печатаем информацию о персонах в виде отдельных карточек
  
 
= Перехватываемые события =
 
= Перехватываемые события =
Строка 92: Строка 112:
 
  ! Пояснение
 
  ! Пояснение
 
  |-
 
  |-
−
  |  
+
  | im
−
  |  
+
  | obj
−
  |  
+
  | get_obj_url
−
  |
+
  | Получает ссылку на объект
 
  |}
 
  |}
  
Строка 104: Строка 124:
 
  ! Код плагина
 
  ! Код плагина
 
  ! Код события
 
  ! Код события
−
! Доп. данные
 
 
  ! Пояснение
 
  ! Пояснение
 
  |-
 
  |-
−
  |
+
  | im
−
  |
+
  | persons
−
  |
+
  | persondata
−
  |
+
  | Событие просмотра страницы пользователя
−
|
 
 
  |}
 
  |}

Текущая версия на 18:26, 15 мая 2017

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


Интерфейс

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

  • Создать нового пользователя
  • Расширенный поиск пользователей по персональным полям
  • Базовый поиск по Фамилии/Имя/Email
  • Массовая операция переноса пользователей в другое подразделение

Описание функционала

Создание нового пользователя

Форма создания нового пользователя имеет следующие поля:

Персона

  • Фамилия (Обязательное поле)
  • Имя (Обязательное поле)
  • Отчество
  • Дата рождения
  • Пол (Обязательное поле)
  • Адрес электронной почты:Обязательное поле
  • Дополнительная эл. почта
  • Дополнительная эл. почта
  • Гражданство
  • Домашний телефон
  • Рабочий телефон
  • Мобильный телефон
  • Дополнительный телефон
  • Дополнительный телефон
  • Дополнительный телефон
  • Характеристика
  • Идентификатор Skype
  • Тип удостоверения личности
  • Серия удостоверения личности
  • Номер удостоверения личности
  • Страна и регион (Обязательное поле)
  • Когда выдан
  • Кем выдан
Форма с полями "Персона"

Адрес регистрации / Адрес фактического проживания / Адрес рождения

  • Почтовый индекс
  • Район
  • Населенный пункт
  • Название улицы
  • Тип улицы
  • Номер дома
  • Подъезд
  • Этаж
  • Квартира
  • Широта
  • Долгота
Форма с полями "Адрес регистрации / Адрес фактического проживания / Адрес рождения"

Дополнительные поля

  • Подразделение (Обязательное поле)
  • Синхронизирован с Moodle
  • Пользователь в Moodle
Форма с полями "Дополнительные поля"

Массовая операция пересона пользователей в другое подразделение

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

Интерфейс плагина "Персоны"

API

get_fullname()

Возвращает полное имя пользователя Параметры:

  • $personid - ID персоны
  • $islink - вернуть в виде ссылки на персону
  • peronobj - опционально вместо ID персоны можно отправить объект персоны

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

  • (string) - строка с полным именем пользователя
show_person_html()

Возвращает html код с информацией о персоне Параметры:

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

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

  • (string) - html код с информацией о персоне
show_list()

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

  • $list - список объектов персон
  • $addvars - GET-параметры для формирования ссылок
  • $options - дополнительные параметры

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

  • (string) - html код с информацией о персонах
show_list_as_cards()

Печать пользователей в виде карточек Параметры:

  • $persons - список объектов персон
  • $addvars - GET-параметры для формирования ссылок
  • $options - дополнительные параметры

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

  • (void) - печатаем информацию о персонах в виде отдельных карточек

Перехватываемые события

Таблица событий, которые перехватывает этот плагин
Тип плагина Код плагина Код события Пояснение
im obj get_obj_url Получает ссылку на объект

Генерируемые события

Таблица событий, которые генерирует этот плагин
Тип плагина Код плагина Код события Пояснение
im persons persondata Событие просмотра страницы пользователя
Источник — «http://docs.deansoffice.ru/wiki/index.php?title=Разработка:im/persons&oldid=3093»