1 Функции администратора / системные функции 1.1 Найти

1
Функции администратора / системные функции
1.1 Найти доступные к установке модули
Вход: нет.
Выход: массив массивов, содержащий поля (название модуля, версия,
путь к модулю).
Описание: СУ модулями просматривает папки, в которых должны
находиться модули, считывает информацию об имеющихся модулях и формирует список модулей, которые администратор может установить.
1.2 Получить список установленных модулей
Вход: нет.
Выход: массив массивов, содержащий поля (название модуля, версия,
путь к модулю).
Описание: СУ модулями просматривает БД и возвращает список
установленных / функционирующих модулей.
1.3 Сделать резервную копию БД модуля
Вход: название модуля.
Выход: true, если удача и false, если неудача.
Описание: СУ модулями по имени модуля находит модуль в БД и делает его резервную копию, если модуль не найден, возвращается false.
1.4 Cформировать список ссылок на страницы администрирования
установленных модулей
Вход: список установленных модулей.
Выход: массив ссылок.
Описание: СУ модулями просматривает БД и возвращается список
ссылок на администрирование каждого модуля.
1.5 Проверить целостность модуля
Вход: название модуля.
Выход: true – модуль прошел проверку, false – модуль поврежден.
Описание: СУ модулями проверяет - существуют ли все необходимые
файлы (задаются XML файлом в папке модуля) для нормального функционирования модуля и возвращает результат проверки.
1.6 Установить модуль
Вход:
1) название модуля;
2) путь к модулю.
Выход: true – модуль успешно установлен, false – при установке модуля возникли проблемы.
Описание: СУ модулями создает запись в БД о модуле, данный модуль считается установленным и он может нормально функционировать;
1.7 Удалить модуль
Вход: название модуля.
Выход: true – модуль успешно удален, false – удалить модуль не удалось.
Описание: СУ модулями удаляет запись из БД об этом модуле, он
считается удаленным и не может функционировать.
1.8 Обновить модуль
Вход: название модуля.
Выход: true – модуль успешно обновлен, false – при обновлении модуля возникла ошибка.
Описание: администратор указывает папку, в которой содержится более новая версия модуля, после чего из указанной папки копируются необходимые файлы.
1.9 Отключить модуль
Вход: название модуля.
Выход: true – модуль успешно отключен, false – не удалось отключить модуль.
Описание: СУ модулями делает в БД отметку о том, что данный модуль считается установленным, но он не функционирует.
1.10 Включить модуль
Вход: название модуля.
Выход: true – модуль успешно включен, false – не удалось включить
модуль.
Описание: СУ модулями делает в БД отметку о том, что данный модуль считается установленным, и он функционирует.
1.11 Активировать учетную запись пользователя
Вход: логин учетной записи пользователя.
Выход: true – учетная запись активирована, false – не удалось активировать учетную запись.
Описание: СУ пользователями делает в БД отметку о том, что данная
запись считается активированной.
1.12 Получить список зарегистрированных пользователей
Вход: нет.
Выход: массив из логинов пользователей.
Описание: СУ пользователями просматривает записи из БД о пользователях, и формирует список пользователей.
1.13 Создать учётную запись пользователя
Вход: ассоциативный массив с данными пользователя (ключ - параметр, значение – значение параметра).
Выход: возвращает идентификатор пользователя, в случае ошибки
добавления возвращает число 0.
Описание: СУ пользователями добавляет запись о пользователе в БД.
1.14 Удалить учётную запись пользователя
Вход: логин пользователя.
Выход: true – пользователь удален, false – пользователя удалить невозможно.
Описание: СУ пользователями удаляет запись о пользователе из БД.
1.15 Изменить данные пользователя
Вход:
1) логин пользователя;
2) ассоциативный массив с новыми данными пользователя (ключ параметр, значение – значение параметра).
Выход: true – данные успешно изменены, false – невозможно изменить данные пользователя
Описание: СУ пользователями изменяет данные пользователя в БД.
1.16 Создать роль
Вход: название роли.
Выход: true – роль успешно создана, false – невозможно создать роль.
Описание: СУ ролями создает запись о роли в БД.
1.17 Удалить роль
Вход: название роли.
Выход: true – роль успешно удалена, false – невозможно удалить роль.
Описание: СУ ролями удаляет запись о роли из БД.
1.18 Редактировать роль
Вход:
1) название роли;
2) новое название роли.
Выход: true – роль успешно изменена, false – невозможно удалить
роль.
Описание: СУ ролями изменяет данные о роли в БД
1.19 Получить список существующих ролей
Вход: нет.
Выход: ассоциативный массив (ключ – идентификатор роли, значение
– название роли).
Описание: СУ ролями просматривает записи из БД о ролях, и формирует список ролей.
2
Информационное обеспечение
2.1 Авторизация
Вход:
1) логин;
2) пароль.
Выход: ключ сессии, при успешной авторизации, а при неуспешной возвращается число 0.
Описание: происходит проверка логина и пароля на соответствие с
записью об аккаунте в БД. При нахождении создается сессия для данного
пользователя.
2.2 Выход
Вход: ключ сессии.
Выход: нет.
Описание: завершая работу с сайтом, пользователь может "выйти" из
системы, перейдя по соответствующей ссылке (или не обращаться к серверу
в течение определенного времени, необходимого для разрыва "сессии") и
стать вновь неавторизованным пользователем.
2.3 Регистрация пользователя
Вход: регистрационные данные.
Выход: зарегистрированный пользователь.
Описание: перейдя по соответствующей ссылке, гость попадает на
страницу регистрации, где в форме указывает свои данные (логин/пароль/email). На указанный почтовый ящик будет выслано письмо с кодом для подтверждения учетной записи.
2.4 Восстановление пароля
Вход: e-mail.
Выход: сессия для восстановления пароля.