Users Model GameAP: различия между версиями

Материал из HLDM Wiki
Перейти к навигации Перейти к поиску
Строка 3: Строка 3:
 
[[Категория:Документация для разработчиков]]
 
[[Категория:Документация для разработчиков]]
  
−
Модель для работы с пользователями.
+
== Расположение файла ==
−
 
 
−
'''Расположение файла'''
 
 
  application/models/users.php
 
  application/models/users.php
  
−
'''Загрузка модуля'''
+
== Загрузка модели ==
 
<syntaxhighlight lang="php">
 
<syntaxhighlight lang="php">
 
$this->load->model('users');
 
$this->load->model('users');
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
== Основные функции ==
  
 
=== add_user ===
 
=== add_user ===
Строка 29: Строка 29:
  
 
$this->users->add_user($data);
 
$this->users->add_user($data);
−
</syntaxhighlight>
 
−
 
−
=== admin_msg ===
 
−
 
−
Отправляет email сообщение всем администраторам
 
−
 
−
bool admin_msg ( string $subject, string $message )
 
−
Функция отправляет сообщение по электронной почте с темой subject и содержимым message всем администраторам
 
−
 
−
=== check_user ===
 
−
 
−
Авторизация пользователя. Проверяет данные в куках.
 
−
 
−
bool check_user ( )
 
−
 
−
'''Пример:'''
 
−
<syntaxhighlight lang="php">
 
−
$this->load->model('users');
 
−
if ($this->users->check_user()) {
 
−
    echo 'Успех';
 
−
} else {
 
−
    echo 'Ошибка авторизации';
 
−
}
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Строка 97: Строка 74:
  
 
Получение списка пользователей
 
Получение списка пользователей
−
 
−
=== send_mail ===
 
−
 
−
Отправляет пользователю email письмо
 
−
 
−
bool send_mail ( string $subject, string $message, int $user_id )
 
−
Отправляет электронное письмо пользователю '''user_id''' с темой '''subject''' и сообщением '''message'''
 
  
 
=== set_server_privileges ===
 
=== set_server_privileges ===
Строка 124: Строка 94:
  
 
Обновление данных пользователя.
 
Обновление данных пользователя.
 +
 +
=== user_live ===
 +
 +
Проверяет, существует ли пользователь
 +
 +
== Авторизация ==
 +
 +
=== check_user ===
 +
 +
Авторизация пользователя. Проверяет данные в куках.
 +
 +
bool check_user ( )
 +
 +
'''Пример:'''
 +
<syntaxhighlight lang="php">
 +
$this->load->model('users');
 +
if ($this->users->check_user()) {
 +
    echo 'Успех';
 +
} else {
 +
    echo 'Ошибка авторизации';
 +
}
 +
</syntaxhighlight>
  
 
=== user_auth ===
 
=== user_auth ===
  
−
Авторизация пользователя.
+
Авторизация пользователя по логину и паролю.
 +
bool user_auth (string $user_login, string $user_password)
  
−
=== user_live ===
+
== Отправка сообщений ==
 +
 
 +
=== admin_msg ===
 +
 
 +
Отправляет email сообщение всем администраторам
 +
 
 +
bool admin_msg ( string $subject, string $message )
 +
Функция отправляет сообщение по электронной почте с темой subject и содержимым message всем администраторам
 +
 
 +
=== send_mail ===
 +
 
 +
Отправляет пользователю email письмо
  
−
Проверяет, существует ли пользователь
+
bool send_mail ( string $subject, string $message, int $user_id )
 +
Отправляет электронное письмо пользователю '''user_id''' с темой '''subject''' и сообщением '''message'''
  
 
{{Категория:Документация_для_разработчиков}}
 
{{Категория:Документация_для_разработчиков}}

Версия 13:04, 15 мая 2014


Расположение файла

application/models/users.php

Загрузка модели

$this->load->model('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);

delete_user

Удаляет пользователя. 

bool delete_user ( int $id )
id
Идентификатор пользователя

Пример: 

$id = 2;
$this->users->delete_user($id);

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;
}

get_user_data

Получение данных пользователя

get_user_hash

Получение хеш строки пользователя

get_user_recovery_code

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

get_users_list

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

set_server_privileges

Задает привилегии на серверы

set_user_recovery_code

Обновляет указанному пользователю код восстановления.

tpl_userdata

Возвращает данные пользователя, которые можно отправить в шаблон.

tpl_users_list

Возвращает данные пользователей, данные которых можно отправить в шаблон.

update_user

Обновление данных пользователя.

user_live

Проверяет, существует ли пользователь

Авторизация

check_user

Авторизация пользователя. Проверяет данные в куках. 

bool check_user ( )

Пример: 

$this->load->model('users');
if ($this->users->check_user()) {
    echo 'Успех';
} else {
    echo 'Ошибка авторизации';
}

user_auth

Авторизация пользователя по логину и паролю. 

bool user_auth (string $user_login, string $user_password)

Отправка сообщений

admin_msg

Отправляет email сообщение всем администраторам 

bool admin_msg ( string $subject, string $message )

Функция отправляет сообщение по электронной почте с темой subject и содержимым message всем администраторам

send_mail

Отправляет пользователю email письмо 

bool send_mail ( string $subject, string $message, int $user_id )

Отправляет электронное письмо пользователю user_id с темой subject и сообщением message

Источник — https://wiki.hldm.org/index.php?title=Users_Model_GameAP&oldid=1417