Это различные методы связанные с управлением пользователем в EvolutionCMS, все действия связанные с пользователем проходят через эти методы.
User \UserManager::get(integer $userId)
Функция возвращает объект модели пользователя User
Параметры, которые принимает функция:
Пример получения пользователя и вывода его атрибутов
$user = \UserManager::get(1);
print_r($user->attributes->toArray());
create - регистрация пользователя
User \UserManager::create(array $userData, bool $events = true, bool $cache = true)
Пользователи по умолчанию создаются подтверждёнными, если необходимо чтобы пользователь был не подтверждён, необходимо в $userData передать элемент с ключом verified и значнием 0
Функция возвращает объект модели пользователя User
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример функции регистрации пользователя
$data = ['username' => 'admin22', 'password' => '123456', 'password_confirmation' => '123456', 'email' => 'test@test.test'];
try {
$user = \UserManager::create($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
edit - редактирование пользователя
User \UserManager::edit(array $userData, bool $events = true, bool $cache = true)
Функция возвращает объект модели пользователя User
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример функции редактирования пользователя
$data = ['id'=> 1, 'username' => 'admin22', 'email' => 'test@test.test'];
try {
$user = \UserManager::edit($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
delete - удаление пользователя
User \UserManager::delete(array $userData, bool $events = true, bool $cache = true)
Функция возвращает username пользователя
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример функции удаления пользователя
$data = [ 'id' => 1 ];
try {
$user = \UserManager::delete($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
getValues - получение TV пользователя
array \UserManager::getValues(array $userData, bool $events = true, bool $cache = true)
Функция возвращает массив TV пользователя User в формате [ 'tvname1' => 'tvvalue1', 'tvname2' => 'tvvalue2', ... ]
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример общий
$data = [ 'id' => $userid ];
try {
$arrTVs = \UserManager::getValues($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
Пример получения всех TV пользователя
$data = [ 'id' => 1 ];
$tvValues = \UserManager::getValues($data);
print_r($tvValues);
Пример получения отдельных TV пользователя
$data = [ 'id' => 1, 'tvNames' => [ 'user_tv1', 'user_tv2' ] ];
$tvValues = \UserManager::getValues($data);
print_r($tvValues);
Пример с использованием id пользователя из evo
$userid = evolutionCMS()->getLoginUserID();
$data = [ 'id' => $userid ];
$tvValues = \UserManager::getValues($data);
print_r($tvValues);
saveValues - редактирование TV пользователя
array \UserManager::saveValues(array $userData, bool $events = true, bool $cache = true)
Функция возвращает true в случае успешного сохранения
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример общий
$data = [ 'id' => 1, 'some_tv1' => 'something', 'other_tv2' => 'awesome' ];
try {
$result = \UserManager::saveValues($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
login - авторизация пользователя
User \UserManager::login(array $userData, bool $events = true, bool $cache = true)
Функция возвращает объект модели пользователя User
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример авторизации пользователя
$data = [ 'username'=> 'manager', 'password' => '123456' ];
try {
$user = \UserManager::login($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
loginById - авторизация пользователя по его id
User \UserManager::loginById(array $userData, bool $events = true, bool $cache = true)
Функция возвращает объект модели пользователя User
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример авторизации пользователя
$data = [ 'id' => 1 ];
try {
$user = \UserManager::loginById($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
logout - Выход пользователя из системы
User \UserManager::logout(array $userData, bool $events = true, bool $cache = true)
Функция возвращает username пользователя
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример выхода пользователя из системы
try {
$username = \UserManager::logout();
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
setRole - назначению пользователю его роли
User \UserManager::setRole(array $userData, bool $events = true, bool $cache = true)
Функция возвращает объект модели пользователя User
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример функции назначения роли
$data = [ 'id' => 1, 'role' => 2 ];
try {
$user = \UserManager::setRole($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
setGroups - назначению пользователю его группы пользователей
User \UserManager::setGroups(array $userData, bool $events = true, bool $cache = true)
Функция возвращает объект модели пользователя User
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример функции назначения группы пользователей
$data = [ 'id' => 1, 'groups' => [1,2]];
try {
$user = \UserManager::setGroups($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
clearSettings - удаление всех настроек пользователя
User \UserManager::clearSettings(array $userData, bool $events = true, bool $cache = true)
Функция возвращает true в случае успешного сохранения
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример функции сохранения настроек пользователей
$data = [ 'id' => 1 ];
try {
$result = \UserManager::clearSettings($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
saveSettings - сохранение настроек пользователя
User \UserManager::saveSettings(array $userData, bool $events = true, bool $cache = true)
Функция возвращает true в случае успешного сохранения
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример функции сохранения настроек пользователей
$data = [ 'id' => 1, 'some_settings' => 'some_data'];
try {
$result = \UserManager::saveSettings($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
repairPassword - получение хэша для сброса пароля
User \UserManager::repairPassword(array $userData, bool $events = true, bool $cache = true)
Функция возвращает hash для сброса пароля
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример функции сброса пароля
$data = [ 'id' => 1];
try {
$hash = \UserManager::repairPassword($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
changePassword - смена пароля при наличии старого пароля
User \UserManager::changePassword(array $userData, bool $events = true, bool $cache = true)
Функция возвращает hash для сброса пароля
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример функции сброса пароля
$data = [ 'id' => 1, 'old_password' => '111111', 'password' => '123456', 'password_confirmation' => '123456'];
try {
$hash = \UserManager::changePassword($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
hashChangePassword - смена пароля по хэшу полученному из метода repairPassword
User \UserManager::hashChangePassword(array $userData, bool $events = true, bool $cache = true)
Функция возвращает hash для сброса пароля
Параметры, которые принимает функция:
ВНИМАНИЕ Функция может бросить два различных исключения
Пример функции сброса пароля
$data = [ 'hash' => '111111', 'password' => '123456', 'password_confirmation' => '123456'];
try {
$hash = \UserManager::hashChangePassword($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
generateAndSavePassword - смена пароля на автосгенерированный для дальнейшей отправки пользователю
User \UserManager::generateAndSavePassword(array $userData, bool $events = true, bool $cache = true)
Функция возвращает пароль
Параметры, которые принимает функция:
$userData - массив содержащий поле id. Поле обязательно к заполнению.
$events - указатель вызываем ли мы события связанные со сменой пароля пользователя
$cache - указатель сбрасываем ли кэш после смены пароля пользователя
ВНИМАНИЕ Функция может бросить два различных исключения
\EvolutionCMS\Exceptions\ServiceValidationException исключение срабатывает в случае если мы передали плохие данные в $userData.
\EvolutionCMS\Exceptions\ServiceActionException исключение срабатывает в ситуации когда возникла ошибка в процессе обработки данных.
Пример функции смена пароля
$data = [ 'id' => 1 ];
try {
$password = \UserManager::generateAndSavePassword($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
refreshToken - обновление токена авторизации
User \UserManager::refreshToken(array $userData, bool $events = true, bool $cache = true)
Функция возвращает актуальный токен
Параметры, которые принимает функция:
$userData - массив содержащий поле refresh_token. Поле обязательно к заполнению.
$events - указатель вызываем ли мы события связанные с обновлением токена пользователя
$cache - указатель сбрасываем ли кэш после обновления токена пользователя
ВНИМАНИЕ Функция может бросить два различных исключения
\EvolutionCMS\Exceptions\ServiceValidationException исключение срабатывает в случае если мы передали плохие данные в $userData.
\EvolutionCMS\Exceptions\ServiceActionException исключение срабатывает в ситуации когда возникла ошибка в процессе обработки данных.
Пример функции обновления токена
$data = [ 'refresh_token' => '1asdasd1sad2dd4t54351fd1dfs1fd1' ];
try {
$token = \UserManager::refreshToken($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
getVerifiedKey - получение ключа верификации пользователя
User \UserManager::getVerifiedKey(array $userData, bool $events = true, bool $cache = true)
Функция возвращает объект пользователя из которого можно получить ключ верификации $user->verified_key;
Параметры, которые принимает функция:
$userData - массив содержащий поле id. Поле обязательно к заполнению.
$events - указатель вызываем ли мы события связанные с верификацией пользователя
$cache - указатель сбрасываем ли кэш после верификации пользователя
ВНИМАНИЕ Функция может бросить два различных исключения
\EvolutionCMS\Exceptions\ServiceValidationException исключение срабатывает в случае если мы передали плохие данные в $userData.
\EvolutionCMS\Exceptions\ServiceActionException исключение срабатывает в ситуации когда возникла ошибка в процессе обработки данных.
Пример функции обновления токена
$data = [ 'id' => '1' ];
try {
$user = \UserManager::getVerifiedKey($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}
verified - подтверждение пользователя с помощью ключа верификации
User \UserManager::verified(array $userData, bool $events = true, bool $cache = true)
Функция возвращает объект пользователя
Параметры, которые принимает функция:
$userData - массив содержащий поля verified_key и username. Оба поля обязательны к заполнению.
$events - указатель вызываем ли мы события связанные с верификацией пользователя
$cache - указатель сбрасываем ли кэш после оверификациии пользователя
ВНИМАНИЕ Функция может бросить два различных исключения
\EvolutionCMS\Exceptions\ServiceValidationException исключение срабатывает в случае если мы передали плохие данные в $userData.
\EvolutionCMS\Exceptions\ServiceActionException исключение срабатывает в ситуации когда возникла ошибка в процессе обработки данных.
Пример функции обновления токена
$data = [ 'username' => 'test', 'verified_key' => '166a44621c209ef152cc92a2316c6307'];
try {
$user = \UserManager::verified($data);
} catch (\EvolutionCMS\Exceptions\ServiceValidationException $exception) {
$validateErrors = $exception->getValidationErrors(); //Получаем все ошибки валидации
print_r($validateErrors); //Выводим все ошибки валидации
} catch (\EvolutionCMS\Exceptions\ServiceActionException $exception) {
print_r($exception->getMessage()); //Выводим ошибку процесса обработки данных
}