Users Model GameAP: различия между версиями
Nikita (обсуждение | вклад) |
Nikita (обсуждение | вклад) |
||
(не показано 12 промежуточных версий этого же участника) | |||
Строка 1: | Строка 1: | ||
− | [[Категория:АдминПанель | + | [[Категория:АдминПанель]] |
− | [[ | + | [[Категория:Документация для разработчиков]] |
− | |||
− | + | == Расположение файла == | |
+ | application/models/users.php | ||
− | + | == Загрузка модели == | |
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
$this->load->model('users'); | $this->load->model('users'); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | === add_user === | + | == Основные функции == |
+ | |||
+ | === $this->users->add_user(); === | ||
Функция добавляет нового пользователя. | Функция добавляет нового пользователя. | ||
bool add_user ( array $data ) | bool add_user ( array $data ) | ||
+ | :'''data''' | ||
+ | ::Данные пользователя | ||
'''Пример:''' | '''Пример:''' | ||
Строка 26: | Строка 30: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | === | + | === $this->users->delete_user(); === |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | $this-> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
Удаляет пользователя. | Удаляет пользователя. | ||
bool delete_user ( int $id ) | bool delete_user ( int $id ) | ||
+ | :'''id''' | ||
+ | :: Идентификатор пользователя | ||
'''Пример:''' | '''Пример:''' | ||
Строка 59: | Строка 42: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | === get_server_privileges === | + | === $this->users->get_server_privileges === |
Получат привилегии пользователя на определенный сервер. | Получат привилегии пользователя на определенный сервер. | ||
array get_server_privileges( $server_id [ , $user_id ]) | array get_server_privileges( $server_id [ , $user_id ]) | ||
− | Возвращает массив с привилегиями на сервер | + | Возвращает массив с привилегиями на сервер '''server_id''' для пользователя '''user_id'''. Если id пользователя не указывать, то будут получены привилегии на авторизованного пользователя. |
'''Пример:''' | '''Пример:''' | ||
Строка 75: | Строка 58: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | === get_user_data === | + | === $this->users->get_user_data(); === |
Получение данных пользователя | Получение данных пользователя | ||
− | === get_user_hash === | + | === $this->users->get_user_hash(); === |
Получение хеш строки пользователя | Получение хеш строки пользователя | ||
− | === get_user_recovery_code === | + | === $this->users->get_user_recovery_code(); === |
Получение кода восстановления пользователя | Получение кода восстановления пользователя | ||
− | === get_users_list === | + | === $this->users->get_users_list(); === |
Получение списка пользователей | Получение списка пользователей | ||
− | === | + | === $this->users->set_server_privileges(); === |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
Задает привилегии на серверы | Задает привилегии на серверы | ||
− | === set_user_recovery_code === | + | === $this->users->set_user_recovery_code(); === |
Обновляет указанному пользователю код восстановления. | Обновляет указанному пользователю код восстановления. | ||
− | === tpl_userdata === | + | === $this->users->tpl_userdata(); === |
Возвращает данные пользователя, которые можно отправить в шаблон. | Возвращает данные пользователя, которые можно отправить в шаблон. | ||
− | === tpl_users_list === | + | === $this->users->tpl_users_list(); === |
Возвращает данные пользователей, данные которых можно отправить в шаблон. | Возвращает данные пользователей, данные которых можно отправить в шаблон. | ||
− | === update_user === | + | === $this->users->update_user(); === |
Обновление данных пользователя. | Обновление данных пользователя. | ||
− | + | bool update_user(array $user_data[, int $user_id]) | |
+ | :'''user_data''' | ||
+ | ::Массив с новыми данными пользователя | ||
+ | :'''user_id''' | ||
+ | ::Идентификатор пользователя. Если не задан, то будет использован ID авторизованного пользователя. | ||
− | + | === $this->users->user_live(); === | |
− | + | Проверяет, существует ли пользователь | |
+ | bool user_live(string $string [, $type = 'id']) | ||
+ | :'''string''' | ||
+ | ::Строка, которая будет проверена | ||
+ | :'''type''' | ||
+ | ::Поле (тип строки), по которому будет проверен пользователь. Возможные значения: | ||
+ | :: id — идентификатор | ||
+ | :: login — логин пользователя | ||
+ | :: email — электронный ящик пользователя | ||
− | Проверяет, | + | == Авторизация == |
+ | |||
+ | === $this->users->check_user(); === | ||
+ | |||
+ | Авторизация пользователя. Проверяет данные в куках. | ||
+ | |||
+ | bool check_user ( ) | ||
+ | |||
+ | '''Пример:''' | ||
+ | <syntaxhighlight lang="php"> | ||
+ | $this->load->model('users'); | ||
+ | if ($this->users->check_user()) { | ||
+ | echo 'Успех'; | ||
+ | } else { | ||
+ | echo 'Ошибка авторизации'; | ||
+ | } | ||
+ | </syntaxhighlight> | ||
+ | |||
+ | === $this->users->user_auth(); === | ||
+ | |||
+ | Авторизация пользователя по логину и паролю. | ||
+ | bool user_auth (string $user_login, string $user_password) | ||
+ | |||
+ | == Отправка сообщений == | ||
+ | |||
+ | === $this->users->admin_msg(); === | ||
+ | |||
+ | Отправляет email сообщение всем администраторам | ||
+ | |||
+ | bool admin_msg ( string $subject, string $message ) | ||
+ | Функция отправляет сообщение по электронной почте с темой subject и содержимым message всем администраторам | ||
+ | |||
+ | === $this->users->send_mail(); === | ||
+ | |||
+ | Отправляет пользователю email письмо | ||
+ | |||
+ | bool send_mail ( string $subject, string $message, int $user_id ) | ||
+ | Отправляет электронное письмо пользователю '''user_id''' с темой '''subject''' и сообщением '''message''' | ||
+ | |||
+ | {{Категория:Документация_для_разработчиков}} |
Текущая версия на 13:02, 19 июня 2014
Содержание
- 1 Расположение файла
- 2 Загрузка модели
- 3 Основные функции
- 3.1 $this->users->add_user();
- 3.2 $this->users->delete_user();
- 3.3 $this->users->get_server_privileges
- 3.4 $this->users->get_user_data();
- 3.5 $this->users->get_user_hash();
- 3.6 $this->users->get_user_recovery_code();
- 3.7 $this->users->get_users_list();
- 3.8 $this->users->set_server_privileges();
- 3.9 $this->users->set_user_recovery_code();
- 3.10 $this->users->tpl_userdata();
- 3.11 $this->users->tpl_users_list();
- 3.12 $this->users->update_user();
- 3.13 $this->users->user_live();
- 4 Авторизация
- 5 Отправка сообщений
Расположение файла
application/models/users.php
Загрузка модели
$this->load->model('users');
Основные функции
$this->users->add_user();
Функция добавляет нового пользователя.
bool add_user ( array $data )
- data
- Данные пользователя
Пример:
$data['reg_date'] = time();
$data['login'] = $this->input->post('login', TRUE);
$data['password'] = $this->input->post('password', TRUE);
$data['password'] = $this->password->encryption($data['password'], $data);
$this->users->add_user($data);
$this->users->delete_user();
Удаляет пользователя.
bool delete_user ( int $id )
- id
- Идентификатор пользователя
Пример:
$id = 2;
$this->users->delete_user($id);
$this->users->get_server_privileges
Получат привилегии пользователя на определенный сервер.
array get_server_privileges( $server_id [ , $user_id ])
Возвращает массив с привилегиями на сервер server_id для пользователя user_id. Если id пользователя не указывать, то будут получены привилегии на авторизованного пользователя.
Пример:
$server_id = 1;
$this->users->get_server_privileges($server_id);
if (!$this->users->auth_servers_privileges['SERVER_CHAT_MSG']) {
$this->output->set_output('Нет привилегий для отправки сообщения в чат');
return FALSE;
}
$this->users->get_user_data();
Получение данных пользователя
$this->users->get_user_hash();
Получение хеш строки пользователя
$this->users->get_user_recovery_code();
Получение кода восстановления пользователя
$this->users->get_users_list();
Получение списка пользователей
$this->users->set_server_privileges();
Задает привилегии на серверы
$this->users->set_user_recovery_code();
Обновляет указанному пользователю код восстановления.
$this->users->tpl_userdata();
Возвращает данные пользователя, которые можно отправить в шаблон.
$this->users->tpl_users_list();
Возвращает данные пользователей, данные которых можно отправить в шаблон.
$this->users->update_user();
Обновление данных пользователя.
bool update_user(array $user_data[, int $user_id])
- user_data
- Массив с новыми данными пользователя
- user_id
- Идентификатор пользователя. Если не задан, то будет использован ID авторизованного пользователя.
$this->users->user_live();
Проверяет, существует ли пользователь
bool user_live(string $string [, $type = 'id'])
- string
- Строка, которая будет проверена
- type
- Поле (тип строки), по которому будет проверен пользователь. Возможные значения:
- id — идентификатор
- login — логин пользователя
- email — электронный ящик пользователя
Авторизация
$this->users->check_user();
Авторизация пользователя. Проверяет данные в куках.
bool check_user ( )
Пример:
$this->load->model('users');
if ($this->users->check_user()) {
echo 'Успех';
} else {
echo 'Ошибка авторизации';
}
$this->users->user_auth();
Авторизация пользователя по логину и паролю.
bool user_auth (string $user_login, string $user_password)
Отправка сообщений
$this->users->admin_msg();
Отправляет email сообщение всем администраторам
bool admin_msg ( string $subject, string $message )
Функция отправляет сообщение по электронной почте с темой subject и содержимым message всем администраторам
$this->users->send_mail();
Отправляет пользователю email письмо
bool send_mail ( string $subject, string $message, int $user_id )
Отправляет электронное письмо пользователю user_id с темой subject и сообщением message
Документация для разработчиков | |
---|---|
Помощники: | •DS Helper |
Модели: | •Users •Servers •Games •Game Types |
Библиотеки: | •Query •Rcon •Control •Files •Install |