Пользователи

Базовый класс

Для работы с пользователями предусмотрен базовый класс \Realweb\Api\Model\User\Client. Экземпляр класса может существовать только в единственном экземпляре ($_instance).

use Realweb\Api\Model\User;

$obUser = User\Client::getInstance();

Класс \Realweb\Api\Model\User\Client имеет 2 встроенных метода для работы с сессией:

• public function setSessionValue(string $strKey, mixed $mValue): self - установка значения
• public function getSessionValue(string $strKey, mixed $mDefault = null): mixed - получение значения

Пользователь Bitrix

Для работы с пользователями bitrix предусмотрен класс \Realweb\Api\Model\User\User расширяющий \Realweb\Api\Model\User\Client. Класс имеет ряд встроенных методов:

• public function getId() - возвращает ID текущего пользователя
• public function isAuthorized(): bool - проверка на авторизацию
• public function isAdmin(): bool - проверка на Администратора
• public function authorize(int $iId): bool - авторизация пользователя по ID
• public function logout(): void - выход пользователя
• public function getGroupsId(): array - получение ID групп пользователя
• public function getCUser(): ?\CUser - получение экземпляра класса \CUser
• public function getEntity(): Entity - получение Orm сущности пользователя

Orm

База данных

Основной запрос для поиска пользователей в БД содержится в классе \Realweb\Api\Model\User\Database расширяющий стандартный. Принимает следующие параметры:

• login - string фильтр по логину LOGIN
• email - string фильтр по EMAIL
• phone - string фильтр по полям PERSONAL_PHONE или PERSONAL_MOBILE

Также обладает встроенными методами-обертками:

• public static function getByLogin(string $strEmail): ?Entity - получение записи по логину
• public static function getByEmail(string $strEmail): ?Entity - получение записи по email
• public static function getByPhone(string $strPhone): ?Entity - получение записи по номеру телефона
• public static function getByUniqueParam(string $strParam): ?Entity - получение записи по уникальному значению. В качестве аргумента допустимо передать email, телефон или логин пользователя

Сущность пользователя

Сущность пользователя \Realweb\Api\Model\User\Entity расширяет стандартный класс \Realweb\Api\Model\Data\Entity и имеет встроенные методы:

• public function getId(): ?int - получение ID пользователя
• public function getFullName(): string - получение полного имени Фамилия Имя Отчество или логин, при отсутствии
• public function setPassword(string $strPassword): self - установка нового пароля. Пример реализации задачи по восстановлению пароля
• public function setGroups(array $arGroups): self - установка групп пользователя
• public function save(): bool - сохранение данных сущности

Группы пользователя

Для работы с группами пользователя предусмотрена Orm структура \Realweb\Api\Model\User\Group.

Запрос базы данных \Realweb\Api\Model\User\Group\Database по умолчанию может принимать следующие параметры:

• filter - массив фильтрации
  • id - int фильтр по ID
  • code - string фильтр по символьному коду STRING_ID
  • name - string фильтр по названию NAME
• ids - array фильтр по ID
• codes - array фильтр по символьному коду STRING_ID