Разработка:im/persons — различия между версиями
Alex (обсуждение | вклад) м («Разработка:im/person» переименована в «Разработка:im/persons») |
(→Создание нового пользователя) |
||
| (не показано 14 промежуточных версий 2 участников) | |||
| Строка 3: | Строка 3: | ||
| type = im | | type = im | ||
}} | }} | ||
| + | = Интерфейс = | ||
| + | Этт плагин предназначен для работы с пользователями Электронного Деканата. | ||
| + | Интерфейс позволяет выполнить следующие операции: | ||
| + | * Создать нового пользователя | ||
| + | * Расширенный поиск пользователей по персональным полям | ||
| + | * Базовый поиск по Фамилии/Имя/Email | ||
| + | * Массовая операция переноса пользователей в другое подразделение | ||
| + | = Описание функционала = | ||
| + | == Создание нового пользователя == | ||
| + | Форма создания нового пользователя имеет следующие поля: | ||
| + | |||
| + | ''Персона'' | ||
| + | |||
| + | * Фамилия (Обязательное поле) | ||
| + | * Имя (Обязательное поле) | ||
| + | * Отчество | ||
| + | * Дата рождения | ||
| + | * Пол (Обязательное поле) | ||
| + | * Адрес электронной почты:Обязательное поле | ||
| + | * Дополнительная эл. почта | ||
| + | * Дополнительная эл. почта | ||
| + | * Гражданство | ||
| + | * Домашний телефон | ||
| + | * Рабочий телефон | ||
| + | * Мобильный телефон | ||
| + | * Дополнительный телефон | ||
| + | * Дополнительный телефон | ||
| + | * Дополнительный телефон | ||
| + | * Характеристика | ||
| + | * Идентификатор Skype | ||
| + | * Тип удостоверения личности | ||
| + | * Серия удостоверения личности | ||
| + | * Номер удостоверения личности | ||
| + | * Страна и регион (Обязательное поле) | ||
| + | * Когда выдан | ||
| + | * Кем выдан | ||
| + | [[Файл:Selection 137.png|700px|thumb|center|Форма с полями "Персона"]] | ||
| + | ''Адрес регистрации / Адрес фактического проживания / Адрес рождения'' | ||
| + | * Почтовый индекс | ||
| + | * Район | ||
| + | * Населенный пункт | ||
| + | * Название улицы | ||
| + | * Тип улицы | ||
| + | * Номер дома | ||
| + | * Подъезд | ||
| + | * Этаж | ||
| + | * Квартира | ||
| + | * Широта | ||
| + | * Долгота | ||
| + | [[Файл:Selection 138.png|700px|thumb|center|Форма с полями "Адрес регистрации / Адрес фактического проживания / Адрес рождения"]] | ||
| + | ''Дополнительные поля'' | ||
| + | * Подразделение (Обязательное поле) | ||
| + | * Синхронизирован с Moodle | ||
| + | * Пользователь в Moodle | ||
| + | [[Файл:Selection 139.png|700px|thumb|center|Форма с полями "Дополнительные поля"]] | ||
| + | |||
| + | == Массовая операция пересона пользователей в другое подразделение == | ||
| + | Для переноса пользователей, необходимо необходимо выбрать персон, затем выбрать подразделение, в которое нужно перевести. | ||
| + | [[Файл:Selection 136.png|700px|thumb|center|Интерфейс плагина "Персоны"]] | ||
| + | |||
| + | = 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) - печатаем информацию о персонах в виде отдельных карточек | ||
| + | |||
| + | = Перехватываемые события = | ||
| + | {| border="1" | ||
| + | |+ Таблица событий, которые перехватывает этот плагин | ||
| + | ! Тип плагина | ||
| + | ! Код плагина | ||
| + | ! Код события | ||
| + | ! Пояснение | ||
| + | |- | ||
| + | | im | ||
| + | | obj | ||
| + | | get_obj_url | ||
| + | | Получает ссылку на объект | ||
| + | |} | ||
| + | |||
| + | == Генерируемые события == | ||
| + | {| border="1" | ||
| + | |+ Таблица событий, которые генерирует этот плагин | ||
| + | ! Тип плагина | ||
| + | ! Код плагина | ||
| + | ! Код события | ||
| + | ! Пояснение | ||
| + | |- | ||
| + | | 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 | Событие просмотра страницы пользователя |

