pbAuth — мощная система авторизации, регистрации и управления профилем для PageBlocks

Быстрый старт

• auth — классическая панель с кнопками входа/регистрации и отображением профиля,
• auth_modal — модальное окно (если вы хотите встроить формы без отдельных страниц).

{insert 'file:auth/chunks/auth.tpl'}

{auth}
    <a href="{route 'pageProfile'}" class="d-flex align-items-center gap-2 text-dark text-decoration-none">
        <div class="avatar d-flex align-items-center justify-content-center rounded-5 bg-secondary-subtle overflow-hidden" style="width:48px;height:48px">
            <img src="{$modx->user->getGravatar()}" width="48" height="48" alt="{$modx->user->username}">
        </div>
        <div class="d-flex flex-column">
            <strong>{$modx->user->username}</strong>
            <span>{$modx->user->email}</span>
        </div>
    </a>
{/auth}

{guest}
    <ul class="navbar-nav d-flex align-items-center list-unstyled mb-0">
        <li class="nav-item">
            <a class="btn btn-sm" href="{route 'pageLogin'}">{lang 'auth.login_title'}</a>
        </li>
        <li class="nav-item">
            <a class="btn btn-light btn-sm" href="{route 'pageRegister'}">{lang 'auth.register_title'}</a>
        </li>
    </ul>
{/guest}

• {auth} и {guest} — условные блоки, отображающие содержимое только для авторизованных или неавторизованных пользователей соответственно.
• {route 'имя_маршрута'} — получение ссылки по имени маршрута. Удобно при рефакторинге, чтобы не менять ссылки в шаблонах вручную.
• {lang 'ключ_лексикона'} — получение фраз из языковых файлов (например, {lang 'auth.register_title'} — ищет переменную register_title из файла App/lang/en/auth.php).

// Только для неавторизованных пользователей
Route::middleware('guest')->group(function () {
    Route::get('/login', 'Auth\LoginController@show')->name('pageLogin');
    Route::post('/login', 'Auth\LoginController@login')->name('login');

    Route::get('/register', 'Auth\RegisterController@show')->name('pageRegister');
    Route::post('/register', 'Auth\RegisterController@register')->name('register');

    Route::get('/forgot-password', 'Auth\ForgotPasswordController@show')->name('pageForgotPassword');
    Route::post('/forgot-password', 'Auth\ForgotPasswordController@forgotPassword')->name('forgotPassword');

    Route::get('/reset-password/{token}', 'Auth\ResetPasswordController@show')->name('pageResetPassword');
    Route::post('/reset-password', 'Auth\ResetPasswordController@resetPassword')->name('resetPassword');
});

// Только для авторизованных
Route::middleware('auth')->group(function () {
    Route::get('/confirm-password', 'Auth\ConfirmPasswordController@show')->name('pageConfirmPassword');
    Route::post('/confirm-password', 'Auth\ConfirmPasswordController@confirmPassword')->name('confirmPassword');

    Route::get('/profile', 'Auth\ProfileController@show')->name('pageProfile');
    Route::post('/profile', 'Auth\ProfileController@updateProfile')->name('updateProfile');

    Route::get('/profile/password', 'Auth\ChangePasswordController@show')->name('pageChangePassword');
    Route::post('/profile/password', 'Auth\ChangePasswordController@changePassword')->name('changePassword');

    Route::get('/logout', 'Auth\LoginController@logout')->name('logout');
});

// Подтверждение email
Route::get('/verify-email/{token}', 'Auth\AuthController@verifyEmail')->name('verifyEmail');

• /login — форма входа
• /register — регистрация
• /forgot-password — восстановление пароля
• /reset-password/{token} — сброс пароля
• /confirm-password — подтверждение пароля
• /profile — редактирование профиля
• /profile/password — смена пароля
• /logout — выход
• /verify-email/{token} — подтверждение email

• Контроллеры — /core/App/Http/Controllers/Auth/
Основная логика регистрации, входа, восстановления пароля и т.д.
• Шаблоны — /core/App/elements/auth/
Fenom-шаблоны форм и уведомлений, которые можно кастомизировать.
• Лексиконы (переводы) — /core/App/lang/
Переводы на разные языки для сообщений, ошибок и интерфейса.
• Маршруты — /core/App/routes/auth.php
Определяют доступные URL и обрабатывающие их контроллеры.

Пример авторизации

Route::middleware('guest')->get('/login', 'LoginController@show')->name('pageLogin');

<a class="btn btn-sm" href="{route 'pageLogin'}">Login</a>

<?php

namespace PageBlocks\App\Http\Controllers\Auth;

use Boshnik\PageBlocks\Facades\Request;

class LoginController extends AuthController
{
   public function show()
    {
        return view('file:auth/templates/auth', [
            'title' => lang('auth.login_title'),
            'form' => 'form.login'
        ]);
    }
}

• title — заголовок страницы (будет использоваться в теге title);
• form — название формы, которая будет подгружена внутрь шаблона.

<head>
    <title>{$title} | {'site_name'|config}</title>
</head>
<section class="section-auth">
    <div class="container">
        {block 'content'}
            <div class="row">
                <div class="col-12 col-md-5 mx-auto my-5">
                    {set $chunkPath = 'file:auth/chunks/' ~ $form}
                    {include $chunkPath}
                </div>
            </div>
        {/block}
    </div>
</section>

Route::post('/login', 'LoginController@login')->name('login');

<form class="border rounded-4 p-5" action="{route 'login'}" method="post" data-pbform>

<span data-error="namefield"></span>

<div class="form-group mb-3">
        <label class="mb-2" for="username">{lang 'auth.field_login'}</label>
        <input type="text" name="username" id="username" class="form-control" required>
        <span class="invalid-feedback" data-error="username"></span>
    </div>

<p data-pbform-message></p>

• errors — ошибки полей;
• old_input — предыдущие значения полей;
• success_message — сообщение об успешной операции;
• error_message — общая ошибка.

{if $success_message}
    <p class="form-message text-center text-success" >{$success_message}</p>
{elseif $error_message}
    <p class="form-message text-center text-error text-danger">{$error_message}</p>
{/if}

<div class="form-group mb-3">
    <label class="mb-2" for="username">{lang 'auth.field_login'}</label>
    <input type="text" name="username" id="username" class="form-control{if $errors.username} is-invalid{/if}" value="{$old_input.username}" required>
    <span class="invalid-feedback" data-error="username">{$errors.username}</span>
</div>

public function login(Request $request)
{
    // Валидируем данные
    $request->validate([
        'honeypot' => 'empty',
        'username' => 'required',
        'password' => 'required|min:8'
    ]);
    
    // Мы можем авторизовать пользователя по любому полю, 
    // проверяем сначала его имя, если не нашли проверяем почту и затем телефон.
    $user = $this->modx->getObject($this->userClassKey, ['username' => $request->username]);
    if (!$user) {
        $profile = $this->modx->getObject($this->profileClassKey, ['email' => $request->username])
            ?: $this->modx->getObject($this->profileClassKey, ['phone' => $request->username]);

        if (!$profile || !$user = $profile->getOne('User')) {
            // Если ничего не нашли то возвращаем ошибку, что не нашли пользователя
            return response()->error('', [
                'username' => $this->modx->lexicon('user_err_nf'),
            ]);
        }

        $request->username = $user->username;
    }
   
    // Авторизовываем пользователя через процессор 
    $response = $this->modx->runProcessor('Security/Login', [
        'username' => $request->username,
        'password' => $request->password,
        'rememberme' => $request->remember ?? false,
        'login_context' => $this->modx->context->key ?? 'web',
        'add_contexts' => 'en,de' // добавляем доп. контексты для авторизации
    ]);

    if ($response->isError()) {
        return response()->error($response->getMessage());
    }
     
    // Если все хорошо, то перекидываем на главную страницу
    return response()->success('', '/');
}

• $message — текст ошибки
• $errors — массив ошибок для конкретных полей (например, ['username' => 'Не найден'])
• $data — массив заполненных значений, которые нужно сохранить (например, ['username' => 'test'])

{
"success" : false,
"message" : $message,
"errors" : $errors,
}

response()
    ->back() // перезагружаем страницу
    ->withErrors($errors) // добавляем сообщения об ошибках полей
    ->withInput($data) // добавляем заполненные данные
    ->with('error_message', $message); // добавляем ошибку формы

• $message — сообщение об успехе
• $redirect — ссылка, на которую нужно перенаправить пользователя

{
"success" : true,
"message" : $message,
"redirect" : $redirect,
}

response()
    ->redirect('/register') // делаем редирект на страницу /register
    ->with('success_message', $message); // добавляем сообщение

Заключение

1. Переходим в меню установщика компонентов (Дополнения → Установщик).
2. Переходим на вкладку «Провайдеры» и создаём нового провайдера.
• Имя: Boshnik
• URL сервиса: https://boshnik.com/extras/
3. Выбираем созданного провайдера.
4. После сохранения откроется список компонентов выбранного провайдера.

Поддержка

• MODX 2 / 3
• PHP ^7.4