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

Материал из HLDM Wiki
Перейти к навигации Перейти к поиску
(Новая страница: «Модель для работы с пользователями. '''Загрузка модуля''' <syntaxhighlight lang="php"> $this->load->model('users'); <…»)
 
 
(не показано 17 промежуточных версий этого же участника)
Строка 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'''
 +
::Данные пользователя
  
 
'''Пример:'''
 
'''Пример:'''
Строка 22: Строка 30:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
=== delete_user ===
+
=== $this->users->delete_user(); ===
 
Удаляет пользователя.
 
Удаляет пользователя.
 
  bool delete_user ( int $id )
 
  bool delete_user ( int $id )
 +
:'''id'''
 +
:: Идентификатор пользователя
  
 
'''Пример:'''
 
'''Пример:'''
Строка 32: Строка 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 пользователя не указывать, то будут получены привилегии на авторизованного пользователя.
+
Возвращает массив с привилегиями на сервер '''server_id''' для пользователя '''user_id'''. Если id пользователя не указывать, то будут получены привилегии на авторизованного пользователя.
  
 
'''Пример:'''
 
'''Пример:'''
Строка 47: Строка 57:
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
=== $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 ( )
 +
 +
'''Пример:'''
 +
<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


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

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

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