Вывод чекбоксов для соглашения с документами на обработку данных в формах шаблона

Базовый способ вывода в HTML форме

Чтобы вывести чекбоксы для согласия с документами отобразились в вашей форме, необходимо добавить в фаорму соответствующую верстку, которую генерирует CMS, сделать это нужно с помощью метода MG::addAgreementCheckbox(""). (Первый параметр обязателен, передайте пустую строку. Документация к методу). Должно получиться примерно так:


<form>
 <input name="name"> 
  <?php echo MG::addAgreementCheckbox(""); ?>
 <button type="submit">Отправить</button> 
</form>  

После этого форма будет отправлять данный с чекбоксами и движок сможет их валидировать.


Вывод формы с помощью JavaScript

Если ваша форма генерируется с помошью JS, то вместо MG::addAgreementCheckbox("") используйте переменную: window.agreementHtml в коде javascript.


const html = `
 <form> 
  <input name="name"> 
  ${window.agreementHtml}
  <button type="submit">Отправить</button> 
 </form>
`

Чтобы в JS переменной window.agreementHtml появилась верстка с чекбоксами нужно в файле шаблона этой страницы или плагине вызвать метод с тертьим параметром addJSVariable вот так MG::addAgreementCheckbox("", "", "addJSVariable") (обязательно передайте в третий параметр строку "addJSVariable").

Если форма выводится плагином, добавьте вызов  MG::addAgreementCheckbox("", "", "addJSVariable") в обработчик шорткода. Если в компоненте или на странице, то добавьте прямо в php файл этого компонента или страницы.

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


// Пример 
mgAddShortcode('my-form', array(__CLASS__, 'handlerMyForm')); 
function handlerMyForm($arg){
  /*
  Код обработчика шорткода плагина
  */
   MG::addAgreementCheckbox("", "", "addJSVariable");
return true;
}
 

Пример компонента с формой которая отрисовывается на JS /components/form/form.php


<?php 
MG::addAgreementCheckbox("", "", "addJSVariable"); 
mgAddMeta('components/form/form.js');
?>
<div class="form-wrapper" >
</div>

// код для файла components/form/form.js
const html = `
 <form> 
  <input name="name"> 
  ${window.agreementHtml}
  <button type="submit">Отправить</button> 
 </form>
`
document.querySelector('.form-wrapper').innerHTML = html;

Валидация формы

Валидация на сервере происходит с помощью метода Models_Privacy::validateForm($form, $source, $save = false, $forceUserId = null).



// Пример валидации чекбоксов в плагине обратный звонок
// $form - Данные формы
// $sourse - Идетификатор источника формы
// $save - Флаг сохранения согласия пользователя
// $forceUserId - Идентификатор пользователя, если согласие нужно привязать к пользователю отличному от тому, который авторизован в данный момент

if (class_exists('Models_Privacy')) {
            $formData = $_POST;
            unset($formData['pluginHandler']);
            unset($formData['add_datetime']);

            $agreementValidationResult = Models_Privacy::validateForm($formData, 'backRing', true);
            if ($agreementValidationResult !== true) {
                $error = 'Не удалось проверить согласие на юридические документы';
                if (!empty($agreementValidationResult['errors'])) {
                    $error = $agreementValidationResult['errors'][0];
                }
             
                $this->data['msg'] = $error;
                return false;
            }

            foreach (array_keys($_POST) as $postField) {
                if (mb_strpos($postField, 'privacyDocument-') === 0) {
                    unset($_POST[$postField]);
                }
            }
        }

  

Вывод таблицы принятых соглашений пользователя

Чтобы вывести таблицу, необходимо создать компонент agreement. Пример данного компонента из шаблона moguta:


<?php 
// components/personal/agreements/agreements.php
?>
<?php mgAddMeta('components/personal/agreements/agreements.js'); ?>
<?php mgAddMeta('components/personal/agreements/agreements.css'); ?>
<div class="agreements-table-wrapper">
    <table class="agreements-table">
        <thead>
            <tr>
                <th><?php echo lang('document'); ?></th>
                <th><?php echo lang('versionDocument'); ?></th>
                <th><?php echo lang('dateAndTimeAgree'); ?></th>
                <th><?php echo lang('actionsAgree'); ?></th>
            </tr>
        </thead>
        <tbody>
            <?php foreach ($data['userAgreedDocuments'] as $documentInfo) : ?>
            <?php
                $contentPublishedAtDate = new DateTime('@'.$documentInfo['content_published_at']);
                $agreedAtDate = new DateTime('@'.$documentInfo['agreed_at']);
                $contentPublishedAtDateString = $contentPublishedAtDate->format('d.m.Y');
                $agreedAtDateString = $agreedAtDate->format('d.m.Y H:i:s');
            ?>
            <tr class="agreements-table_row">
                <td>
                    <?php if ($documentInfo['name']) : ?>
                    <a href="<?php echo SITE.$documentInfo['link']; ?>" target="_blank"><?php echo $documentInfo['name']; ?></a>
                    <?php else: ?>
                    <?php echo lang('documentRemoved'); ?>
                    <?php endif; ?>
                </td>
                <td>
                    <b>v<?php echo $documentInfo['version']; ?></b> <?php echo lang('from') ?> <?php echo $contentPublishedAtDateString; ?>
                </td>
                <td><?php echo $agreedAtDateString; ?></td>
                <td>
                    <a
                        href="javascript:void(0);"
                        class="btn btn-primary revokeAgreement"
                        data-id="<?php echo $documentInfo['agreement_id']; ?>"
                    >
                        <?php echo lang('canselAgreement'); ?>
                    </a>
                </td>
            </tr>
            <?php endforeach; ?>
        </tbody>
    </table>
</div>



// components/personal/agreements/agreements.js
{
    class PersonalAgreements {
        constructor() {
            $('body').on('click', '.agreements-table .revokeAgreement', function() {
                const id = parseInt($(this).data('id'));
                if (!id) {
                    return;
                }

                $.ajax(
                    {
                        type: 'POST',
                        url: `${mgBaseDir}/personal`,
                        data: {
                            revokeAgreement: 1,
                            id,
                        },
                        cache: false,
                        dataType: 'json',
                        success: function(response) {
                            if (response?.status === 'success') {
                                $(this).parents('.agreements-table_row').remove();
                                if (!$('.agreements-table_row').length) {
                                    location.reload();
                                }
                            }
                        }.bind(this),
                    }
                );
            });
        }
    }

    $(document).ready(function() {
        if (!window?.personalAgreements) {
            window.personalAgreements = new PersonalAgreements;
        }
    });
}


/* components/personal/agreenemts/agreements.css  */
#c-tab__agreements .agreements-table-wrapper .agreements-table .c-button {
  border-radius: 100px;
  padding: 8px 12px;
  font-size: 16px;
  font-weight: 600;
  transition: all 0.2s;
  border: 1px solid var(--main-border-color);
}

#c-tab__agreements .agreements-table-wrapper .agreements-table .c-button:hover {
  background: var(--hover-btn-color);
  border-color: var(--hover-btn-color);
  color: var(--main-text-color);
}

#c-tab__agreements .agreements-table-wrapper .agreements-table a.c-button {
    text-decoration: none !important;
    color: #000 !important;
}

#c-tab__agreements .agreements-table-wrapper {
  overflow: auto;
  text-align: center;
  border: 1px solid #ddd;
  border-radius: 12px;
}

#c-tab__agreements .agreements-table-wrapper thead {
  background: var(--button-background);
}

#c-tab__agreements .agreements-table-wrapper th,
#c-tab__agreements .agreements-table-wrapper td {
  padding: 5px;
}

После создания компонента необходимо его подключить. Обычно в шаблонах это делается в компоненте components/tabs/tabs_personal.php, который подключается на странице личного кабинета. Пример подключения из шаблона moguta:


<div class="js-tabs-container c-tab">
    <div class="c-tab__nav"
         role="tablist"
         aria-label="<?php echo lang('tabsPersonalLabel'); ?>">
         <!-- Предыдущие кнопки табов -->
         <!-- Новая кнопка для таба с соглашеними -->
         <?php if (!empty($data['userAgreedDocuments'])) : ?>
        <button class="js-open-tab c-tab__link"
                aria-selected="false"
                aria-controls="c-tab__agreements"
                tabindex="0"
                id="c-tab-btn-agreements"
                role="tab"
                title="<?php echo lang('agreement'); ?>">
          <?php echo lang('agreement'); ?>
        </button>
        <?php endif; ?>
        <!-- Конец новой кнопки -->
         <!-- Следующие кнопки табов -->
    </div>
    <!-- Секции -->
    <!-- Новая секция с соглашениями -->
    <?php if (!empty($data['userAgreedDocuments'])) : ?>
    <section class="js-tab-content c-tab__content"
             tabindex="0"
             role="tabpanel"
             aria-labelledby="c-tab-btn-agreements"
             hidden
             id="c-tab__agreements">
      <?php
      // Смена пароля пользователя
      component('personal/agreements', $data);
      ?>
    </section>
    <?php endif; ?>
    <!-- Конец новой секции с соглашеними -->
</div>



Добавьте новую кнопку и секцию в нужные места компонента, как описано в примере. В некоторых шаблонах могут отличатся классы у элементов или отсутствовать /components/tabs/tabs_personal.php. Учитывайте это при копировании данного примера.
 

Если в старых версиях шаблона, которые нельзя обновить отсутствует компонент для вывода чекбоксов соглашенией, его нужно добавить в папку mg-templates/components/newAgreement

Скачать компонент newAgreement