Login.Using Pre and Post Hooks

Последнее обновление not available | История страницы | Улучшить эту страницу | Сообщить о проблеме

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$204 per month—let's make that $500!

Learn more

У Register, UpdateProfile и Login есть свойства preHooks и postHooks. Они запускают свой код до и после основного действия сниппета.

Пользовательские хуки¶

Хук, это сниппет, который выполняется после валидации формы. Хуки можно цепочкой. Первый выполняется, при успехе идёт следующий. Сниппет возвращает true при успехе и false или текст ошибки при провале. При false следующие хуки из списка не выполняются. Если сниппет не найден, следующие хуки в списке всё равно выполнятся.

Пользовательский сниппет-хук должен возвращать true. false означает ошибку, процесс останавливается (Login или Register).

Pre-Hooks в Login срабатывают до действия, но после валидации полей. При ошибке preHook сниппет не выполнит основное действие.
Post-Hooks срабатывают после действия. Пользователь уже сохранён. getUser() не обязательно вернёт активный объект пользователя.

Написание хуков¶

Создайте сниппет и укажите его имя в &preHooks или &postHooks в Register и/или UpdateProfile.

Доступ к полям в хуке¶

Поля формы доступны через Hooks API в fields. Пример:

$email = $hook->getValue('email');

Все значения формы:

$formFields = $hook->getValues();
$email = $formFields['email'];

Post-Hooks добавляют специальные поля помимо полей формы:

Register¶

// A reference to the modUser object
$user = $hook->getValue('register.user');
// A reference to the modUserProfile object
$profile = $hook->getValue('register.profile');
// An array of usergroup names that the User joined
$usergroups = $hook->getValue('register.usergroups');

UpdateProfile¶

// A reference to the modUser object
$user = $hook->getValue('updateprofile.user');
// A reference to the modUserProfile object
$profile = $hook->getValue('updateprofile.profile');
// A boolean stating if the username was changed
$changed = $hook->getValue('updateprofile.usernameChanged');

Доступ к свойствам сниппета¶

Свойства Register и Login:

$properties = $hook->login->controller->config;

Возвращаемые значения preHook¶

Сниппет возвращает true при успехе. При ошибке задайте сообщения в $hook->errors и верните false. Следующие хуки из &preHooks не выполнятся.

Объект $hook доступен в сниппете как $scriptProperties['hook']. Через него можно вернуть общую ошибку:

$errorMsg = 'User not found';
$hook->addError('user',$errorMsg);
return false;

Примеры¶

PostHook Register с письмом¶

Отправлять письмо на [email protected] при каждой регистрации.

Сниппет hookComEmail:

$message = 'Hi, a new User signed up: '.$hook->getValue('username')
 . ' with email '.$hook->getValue('email').'.';
$modx->getService('mail', 'mail.modPHPMailer');
$modx->mail->set(modMail::MAIL_BODY,$message);
$modx->mail->set(modMail::MAIL_FROM,'[email protected]');
$modx->mail->set(modMail::MAIL_FROM_NAME,'Jerrys Site');
$modx->mail->set(modMail::MAIL_SENDER,'Jerrys Site');
$modx->mail->set(modMail::MAIL_SUBJECT,'New User Signed Up');
$modx->mail->address('to','[email protected]');
$modx->mail->setHTML(true);
if (!$modx->mail->send()) {
    $modx->log(modX::LOG_LEVEL_ERROR,'An error occurred while trying to send the email: '.$err);
}
$modx->mail->reset();
/* tell our snippet we're good and can continue */
return true;

Вызов Register:

[[!Register? &postHooks=`hookComEmail`]]

PreHook Register с вложением в письмо активации¶

Чтобы прикрепить документ к письму активации, используйте prehook. Сниппет attachFile:

// it can be a list/array of files and even passed to the hook from the outside. This example will be limited to a single hard-fixed file

$attachment = 'relative_file_path.pdf';
$hook->modx->getService('mail', 'mail.modPHPMailer');
$hook->modx->mail->mailer->AddAttachment(MODX_BASE_PATH.$attachment);
return true;

В Register:

[[!Register? &preHooks=`attachFile`]]

PostHook обновления аватара профиля¶

Сначала расширьте HTML-форму UpdateProfile:

<div>
  <img src="[[+photo:default=`/assets/photouser/default.jpg`]]">
</div>
<label for="photo">Photo
    <span class="error">[[+error.photo]]</span>
</label>
<input type="file" id="photo" name="photo" value="[[+photo]]">

Создайте хук hookUpdateProfilePhoto. Папки должны существовать с нужными правами. Код сниппета:


<?php
// get user details
$profile = $modx->user->getOne('Profile');
//if post
if(isset($_POST['login-updprof-btn'])) {
    //set extensions
    $validExt=array('jpg','png','jpeg');
    //set path for file
    $pathToFile = $modx->config['base_path'].'site_content/content/users/';
    // set path for cmp because of media resource
    $pathToFileProfile = 'users/';
    // get file name
    $nameFile = $_FILES['photo']['name'];
    // lowercase and exxtention
    $extFile = mb_strtolower(pathinfo($nameFile, PATHINFO_EXTENSION));
    // the tmp file
    $tmpFile = $_FILES['photo']['tmp_name'];
    // upload is ok then
    if((is_uploaded_file($tmpFile)) &&! ($_FILES['photo']['error'])){
        // check extention types
        if (in_array($extFile,$validExt)) {
            // make a file name
            $tmpzname='user'.$modx->user->get('id');
            // add a hash and extension
            $nameFile=hash('adler32',$tmpzname).'.'.$extFile;
            //full name with path
            $fullNameFile = $pathToFile.$nameFile;
            // copy the tmp to new one move_uploaded_file1 and rename1 did not work this will overwrite the old pic as they all have same name
            copy($tmpFile, $fullNameFile);
            // name and path for profile as its different because of media resource
            $fullNameFileProfile = $pathToFileProfile.$nameFile;
            // delete old pic in profile
            $hook->setValue('photo','');
            //set new pic path
            $hook->setValue('photo',$fullNameFileProfile);
        }
        else{
            $modx->log(modX::LOG_LEVEL_ERROR,'The image has an invalid extension');
        }
    }
      else {
        $modx->log(modX::LOG_LEVEL_ERROR,'Error loading file. Error code:'.$_FILES['photo']['error']);
    }
} 
return true;

Добавьте хук в preHooks UpdateProfile:

[[!UpdateProfile? &preHooks=`hookUpdateProfilePhoto`]]

См. также¶