Docs For Class User

User

Описание

Класс User - предназначен для работы с учетными записями пользователей системы.

Доступен из любой точки программы. Реализован в виде синглтона, что исключает его дублирование.

Методы класса
int access() Проверяет права доуступа пользователей сайта к различным разделам системы.
bool AccessOnly() Проверяет права пользователя на выполнение ajax запроса.
bool add() Добавляет новую учетную запись пользователя в базу сайта.
string addUserToCsvLine() Добавляет пользователя в CSV выгрузку.
bool auth() Аутентифицирует данные, с помощью криптографического алгоритма.
bool delete() Удаляет учетную запись пользователя из базы.
string exportToCsvUser() Выгружает список пользователей в CSV файл.
object - getInstance() Возвращает единственный экземпляр данного класса.
array getListUser() Получает список пользователей.
array getMaxDate() Возвращает дату последней регистрации пользователя.
array getMinDate() Возвращает дату первой регистрации пользователя.
bool getThis() Возвращает авторизированнго пользователя.
array getUserById() Получает все данные пользователя из БД по ID.
array getUserInfoByEmail() Получает все данные пользователя из БД по email.
void init() Инициализирует объект данного класса User.
bool isAuth() Проверяет, авторизован ли текущий пользователь.
void logout() Разлогинивает авторизованного пользователя.
array searchEmail() Получает все email пользователя из БД.
bool update() Обновляет учетную запись пользователя.
Описание методов и примеры их использования

Метод

int access ([string $zone = ''])

Параметры

  • $zone: название зоны доступа admin_zone - админка product - товары page - страницы category - категории order - заказы user - покупатели plugin - плагины setting - настройки wholesales - оптовые цены

Описание

Проверяет права доуступа пользователей сайта к различным разделам системы.

Пример использования

  1.  $result USER::access('product');
  2.  viewData($result);

Метод

bool AccessOnly ([string $roleMask = "1,2,3,4"], [bool $exit = null])

Параметры

  • $roleMask: - строка с перечисленными ролями, которые имеют доступ, если параметр не передается, то доступ открыт для всех.
    1. - администратор,
    2. - пользователь,
    3. - менеджер,
    4. - модератор
  • $exit: нужно ли прерывать движок

Описание

Проверяет права пользователя на выполнение ajax запроса.

Пример использования

  1.  USER::AccessOnly('1,4','exit()');

  • deprecated:

Метод

bool add (array $userInfo)

Параметры

  • $userInfo: - массив значений для вставки в БД [Поле => Значение].

Описание

Добавляет новую учетную запись пользователя в базу сайта.

Пример использования

  1.  $userInfo array(
  2.   'id' => null,                   // id пользователя, при добавлении null
  3.   'email' => 'mail@email.com',    // почта пользователя
  4.   'pass' => '123456',             // пароль
  5.   'name' => 'username',           // имя пользователя
  6.   'birthday' => '01.03.2018',     // день рождения пользователя
  7.   'sname' => 'usersname',         // фамилия
  8.   'address' => 'adr',             // адрес
  9.   'phone' => '+7 (111) 111-11-11',// телефон
  10.   'blocked' => 0,                 // флаг блокировки пользователя (1 = заблокирован)
  11.   'activity' => 1,                // флаг активности пользователя (0 = не активен)
  12.   'role' => 2                     // группа пользователя (1 - администратор, 2 - пользователь, 3 - менеджер, 4 - модератор)
  13.  );
  14.  User::add($userInfo);

Метод

string addUserToCsvLine (array $row)

Параметры

  • $row: - запись о пользователе.

Описание

Добавляет пользователя в CSV выгрузку.

Метод

bool auth (string $email, string $pass, [string|null $cap = null])

Параметры

  • $email: - емайл.
  • $pass: - пароль.
  • $cap: - captcha

Описание

Аутентифицирует данные, с помощью криптографического алгоритма.

Пример использования

  1.  User::auth('mail@email.com''123456');

Метод

bool delete (int $id)

Параметры

  • $id: id пользователя, чью запись следует удалить.

Описание

Удаляет учетную запись пользователя из базы.

Пример использования

  1.  User::delete(3);

Метод

string exportToCsvUser ([array $listUserId = array()])

Параметры

  • $listUserId: массив с id пользователей для выгрузки (необязаьельно)

Описание

Выгружает список пользователей в CSV файл.

$listUserId выгрузка выбранных пользователей

Метод

array getListUser ()

Описание

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

Пример использования

  1.  $result User::getListUser();
  2.  viewData($result);

Метод

array getMaxDate ()

Описание

Возвращает дату последней регистрации пользователя.

Пример использования

  1.  $result User::getMaxDate();
  2.  viewData($result);

Метод

array getMinDate ()

Описание

Возвращает дату первой регистрации пользователя.

Пример использования

  1.  $result User::getMinDate();
  2.  viewData($result);

Метод

bool getThis ()

Описание

Возвращает авторизированнго пользователя.

Пример использования

  1.  $result User::getThis();
  2.  viweData($result);

Метод

array getUserById (int $id)

Параметры

  • $id: - id пользователя.

Описание

Получает все данные пользователя из БД по ID.

Пример использования

  1.  $result User::getUserById(14);
  2.  viewData($result);

Метод

array getUserInfoByEmail (string $email)

Параметры

  • $email: - почта пользователя.

Описание

Получает все данные пользователя из БД по email.

Пример использования

  1.  $result User::getUserById('mail@email.com');
  2.  viewData($result);

Метод

bool isAuth ()

Описание

Проверяет, авторизован ли текущий пользователь.

Пример использования

  1.  $result User::isAuth();
  2.  var_dump($result);

Метод

void logout ()

Описание

Разлогинивает авторизованного пользователя.

Пример использования

  1.  User::logout();

Метод

array searchEmail (string $email)

Параметры

  • $email: почтовый адрес пользователя.

Описание

Получает все email пользователя из БД.

Пример использования

  1.  $result User::searchEmail('mail@email.com');
  2.  viewData($result);

Метод

bool update (int $id, array $data, [bool $authRewrite = false])

Параметры

  • $id: id пользователя.
  • $data: массив значений для вставки в БД [Поле => Значение].
  • $authRewrite: false = перезапишет данные в сессии детущего пользователя, на полученные у $data.

Описание

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

Пример использования

  1.  $data array(
  2.   'id' => 14,                     // id пользователя
  3.   'email' => 'mail@email.com',    // почта пользователя
  4.   'pass' => '123456',             // пароль
  5.   'name' => 'username',           // имя пользователя
  6.   'birthday' => '01.03.2018',     // день рождения пользователя
  7.   'sname' => 'usersname',         // фамилия
  8.   'address' => 'adr',             // адрес
  9.   'phone' => '+7 (111) 111-11-11',// телефон
  10.   'blocked' => 0,                 // флаг блокировки пользователя (1 = заблокирован)
  11.   'activity' => 1,                // флаг активности пользователя (0 = не активен)
  12.   'role' => 2                     // группа пользователя (1 - администратор, 2 - пользователь, 3 - менеджер, 4 - модератор)
  13.  );
  14.  User::update(14$data);