Elpha\Migration\Helper\EventHelper

Хелпер для почтовых/смс событий

 

Оглавление

  1. getType(string $eventName)
  2. getTypeIfExists(string $eventName): array
  3. getTypes(array $filter = []): array
  4. exportTypes(array $filter = []): array
  5. exportType(string $eventName)
  6. addType(string $eventName, array $fields, bool $silent = false): int
  7. addTypeIfNotExists(string $eventName, array $fields, bool $silent = false)
  8. updateTypeById(int $id, array $fields, bool $silent = false): bool
  9. saveType(string $eventName, array $fields, bool $silent = false)
  10. deleteType(array $fields, bool $silent = false): bool
  11. deleteTypeIfExists(array $fields, bool $silent = false): bool
  12. getEmailTemplate(string $eventName, string $subject = null)
  13. getEmailTemplateIfExists(string $eventName, string $subject = null): array
  14. getEmailTemplates(string $eventName): array
  15. exportEmailTemplates(string $eventName): array
  16. exportEmailTemplateById(int $id)
  17. addEmailTemplate(string $eventName, array $fields, bool $silent = false): int
  18. addEmailTemplateIfNotExists(string $eventName, array $fields, bool $silent = false)
  19. updateEmailTemplates(string $eventName, array $fields, bool $silent = false): bool
  20. updateEmailTemplateById(int $id, array $fields, bool $silent = false): bool
  21. saveEmailTemplate(string $eventName, array $fields, bool $silent = false)
  22. deleteEmailTemplate(array $fields, bool $silent = false): bool
  23. deleteEmailTemplateIfExists(array $fields, bool $silent = false): bool
  24. getEmailTemplateSites(int $id): array
  25. getSmsTemplate(string $eventName, string $receiver = null)
  26. getSmsTemplateIfExists(string $eventName, string $receiver = null): array
  27. getSmsTemplates(string $eventName): array
  28. exportSmsTemplates(string $eventName): array
  29. exportSmsTemplateById(int $id)
  30. addSmsTemplate(string $eventName, array $fields, bool $silent = false): int
  31. addSmsTemplateIfNotExists(string $eventName, array $fields, bool $silent = false)
  32. updateSmsTemplates(string $eventName, array $fields, bool $silent = false): bool
  33. updateSmsTemplateById(int $id, array $fields, bool $silent = false): bool
  34. saveSmsTemplate(string $eventName, array $fields, bool $silent = false)
  35. deleteSmsTemplate(array $fields, bool $silent = false): bool
  36. deleteSmsTemplateIfExists(array $fields, bool $silent = false): bool
  37. getSmsTemplateSites(int $id): array

getType(string $eventName)

Получить тип почтового/смс события

Аргумент Описание
string $eventName Символьный код типа почтового/смс события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getType('FEEDBACK_FORM'));

    return true;
}
        
    

 

getTypeIfExists(string $eventName): array

Возвращает тип почтового/смс события, если он есть

Аргумент Описание
string $eventName Символьный код типа почтового/смс события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getTypeIfExists('FEEDBACK_FORM'));

    return true;
}
        
    

 

getTypes(array $filter = []): array

Получить список типов почтового/смс событий по фильтру

Аргумент Описание
array $filter Фильтр для \CEventType::GetList
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getTypes(['EVENT_NAME' => 'FEEDBACK_FORM',]));

    return true;
}
        
    

 

exportTypes(array $filter = []): array

Экспорт типов почтового/смс событий

Аргумент Описание
array $filter Фильтр для \CEventType::GetList
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->exportTypes(['EVENT_NAME' => 'FEEDBACK_FORM',]));

    return true;
}
        
    

 

exportType(string $eventName)

Экспорт типа почтового/смс события

Аргумент Описание
string $eventName Символьный код типа почтового/смс события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->exportTypes(['EVENT_NAME' => 'FEEDBACK_FORM',]));

    return true;
}
        
    

 

addType(string $eventName, array $fields, bool $silent = false): int

Добавляет тип почтового/смс события

Аргумент Описание
string $eventName Символьный код типа почтового/смс события
array $fields Поля типа почтового/смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->addType(
        'NEW_EVENT',
        [
            'LID' => LANGUAGE_ID,
            'NAME' => 'Новый тип почтового/смс события',
        ]
    ));

    return true;
}
        
    

 

addTypeIfNotExists(string $eventName, array $fields, bool $silent = false)

Добавляет тип почтового/смс события, если его нет

Аргумент Описание
string $eventName Символьный код типа почтового/смс события
array $fields Поля типа почтового/смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->addTypeIfNotExists(
        'NEW_EVENT',
        [
            'LID' => LANGUAGE_ID,
            'NAME' => 'Новый тип почтового/смс события',
        ]
    ));

    return true;
}
        
    

 

updateTypeById(int $id, array $fields, bool $silent = false): bool

Обновляет тип почтового/смс события

Аргумент Описание
int $id Идентификатор типа почтового/смс события
array $fields Поля типа почтового/смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->updateTypeById(
        197,
        [
            'NAME' => 'Новое название типа почтового/смс события',
        ]
    ));

    return true;
}
        
    

 

saveType(string $eventName, array $fields, bool $silent = false)

Сохраняет тип почтового/смс события

Аргумент Описание
string $eventName Символьный код типа почтового/смс события
array $fields Поля типа почтового/смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->saveType(
        'NEW_EVENT',
        [
            'NAME' => 'Новое название типа почтового/смс события',
            'LID' => LANGUAGE_ID,
        ]
    ));

    return true;
}
        
    

 

deleteType(array $fields, bool $silent = false): bool

Удаляет тип почтового/смс события

Аргумент Описание
array $fields Поля типа почтового/смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->deleteType(
        [
            'EVENT_NAME' => 'NEW_EVENT',
            'LID' => LANGUAGE_ID,
        ]
    ));

    return true;
}
        
    

 

deleteTypeIfExists(array $fields, bool $silent = false): bool

Удаление типа почтового/смс события

Аргумент Описание
array $fields Поля типа почтового/смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->deleteTypeIfExists(
        [
            'EVENT_NAME' => 'NEW_EVENT',
            'LID' => LANGUAGE_ID,
        ]
    ));

    return true;
}
        
    

 

getEmailTemplate(string $eventName, string $subject = null)

Получить шаблон по типу почтового события

Аргумент Описание
string $eventName Символьный код типа почтового события
string $subject Тема почтового шаблона
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getEmailTemplate('NEW_EVENT'));

    return true;
}
        
    

 

getEmailTemplateIfExists(string $eventName, string $subject = null): array

Возвращает шаблон по типу почтового события, если он есть

Аргумент Описание
string $eventName Символьный код типа почтового события
string $subject Тема почтового шаблона
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getEmailTemplateIfExists('NEW_EVENT'));

    return true;
}
        
    

 

getEmailTemplates(string $eventName): array

Получить шаблоны по типу почтового события

Аргумент Описание
string $eventName Символьный код типа почтового события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getEmailTemplates('NEW_EVENT'));

    return true;
}
        
    

 

exportEmailTemplates(string $eventName): array

Экспорт шаблонов по типу почтового события

Аргумент Описание
string $eventName Символьный код типа почтового события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->exportEmailTemplates('NEW_EVENT'));

    return true;
}
        
    

 

exportEmailTemplateById(int $id)

Экспорт почтового шаблона по идентификатору

Аргумент Описание
int $id Идентификатор шаблона почтового события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->exportEmailTemplateById(80));

    return true;
}
        
    

 

addEmailTemplate(string $eventName, array $fields, bool $silent = false): int

Добавляет шаблон почтового события

Аргумент Описание
string $eventName Символьный код типа почтового события
array $fields Поля шаблона почтового события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->addEmailTemplate(
        'NEW_EVENT',
        [
            'SUBJECT' => 'Новый шаблон',
            'LID' => ['s1'],
        ]
    ));

    return true;
}
        
    

 

addEmailTemplateIfNotExists(string $eventName, array $fields, bool $silent = false)

Добавляет шаблон почтового события, если его нет

Аргумент Описание
string $eventName Символьный код типа почтового события
array $fields Поля шаблона почтового события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->addEmailTemplateIfNotExists(
        'NEW_EVENT',
        [
            'SUBJECT' => 'Новый шаблон',
            'LID' => ['s1'],
        ]
    ));

    return true;
}
        
    

 

updateEmailTemplates(string $eventName, array $fields, bool $silent = false): bool

Обновляет шаблоны почтового события

Аргумент Описание
string $eventName Символьный код типа почтового события
array $fields Поля шаблона почтового события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->updateEmailTemplates(
        'NEW_EVENT',
        [
            'SUBJECT' => 'Новый шаблон',
            'LID' => ['s1'],
        ]
    ));

    return true;
}
        
    

 

updateEmailTemplateById(int $id, array $fields, bool $silent = false): bool

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

Аргумент Описание
int $id Идентификатор шаблона почтового события
array $fields Поля шаблона почтового события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->updateEmailTemplateById(
        80,
        [
            'SUBJECT' => 'Новый шаблон',
            'LID' => ['s1'],
            'LANGUAGE_ID' => 'ru',
        ]
    ));

    return true;
}
        
    

 

saveEmailTemplate(string $eventName, array $fields, bool $silent = false)

Сохраняет шаблон почтового события

Аргумент Описание
string $eventName Символьный код типа почтового события
array $fields Поля шаблона почтового события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->saveEmailTemplate(
        'NEW_EVENT',
        [
            'SUBJECT' => 'Новый шаблон',
            'LID' => ['s1'],
            'LANGUAGE_ID' => 'en',
        ]
    ));

    return true;
}
        
    

 

deleteEmailTemplate(array $fields, bool $silent = false): bool

Удаляет шаблон почтового события

Аргумент Описание
array $fields Поля шаблона почтового события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->deleteEmailTemplate(
        [
            'EVENT_NAME' => 'NEW_EVENT',
            'SUBJECT' => 'Новый шаблон',
        ]
    ));

    return true;
}
        
    

 

deleteEmailTemplateIfExists(array $fields, bool $silent = false): bool

Удаляет шаблон почтового события, если он есть

Аргумент Описание
array $fields Поля шаблона почтового события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->deleteEmailTemplateIfExists(
        [
            'EVENT_NAME' => 'NEW_EVENT',
            'SUBJECT' => 'Новый шаблон',
        ]
    ));

    return true;
}
        
    

 

getEmailTemplateSites(int $id): array

Получает список сайтов для шаблона почтового события

Аргумент Описание
int $id Идентификатор шаблона почтового события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getEmailTemplateSites(79));

    return true;
}
        
    

 

getSmsTemplate(string $eventName, string $receiver = null)

Получить шаблон по типу смс события

Аргумент Описание
string $eventName Символьный код типа смс события
string $receiver Телефон получателя
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getSmsTemplate('SMS_USER_RESTORE_PASSWORD'));

    return true;
}
        
    

 

getSmsTemplateIfExists(string $eventName, string $receiver = null): array

Возвращает шаблон по типу смс события, если он есть

Аргумент Описание
string $eventName Символьный код типа смс события
string $receiver Телефон получателя
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getSmsTemplateIfExists('SMS_USER_RESTORE_PASSWORD'));

    return true;
}
        
    

 

getSmsTemplates(string $eventName): array

Получить шаблоны смс по типу смс события

Аргумент Описание
string $eventName Символьный код типа смс события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getSmsTemplates('SMS_USER_RESTORE_PASSWORD'));

    return true;
}
        
    

 

exportSmsTemplates(string $eventName): array

Получить шаблоны смс по типу смс события

Аргумент Описание
string $eventName Символьный код типа смс события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->exportSmsTemplates('SMS_USER_RESTORE_PASSWORD'));

    return true;
}
        
    

 

exportSmsTemplateById(int $id)

Экспорт шаблона смс по идентификатору

Аргумент Описание
int $id Идентификатор шаблона типа смс события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->exportSmsTemplateById(2));

    return true;
}
        
    

 

addSmsTemplate(string $eventName, array $fields, bool $silent = false): int

Добавляет шаблон смс события

Аргумент Описание
string $eventName Символьный код типа смс события
array $fields Поля шаблона смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->addSmsTemplate(
        'SMS_USER_RESTORE_PASSWORD',
        [
            'SENDER' => '#DEFAULT_SENDER#',
            'RECEIVER' => '#USER_PHONE#',
            'MESSAGE' => 'Код для восстановления пароля #CODE#',
            'LANGUAGE_ID' => 'ru',
            'LID' => [
                's1'
            ],
        ]
    ));

    return true;
}
        
    

 

addSmsTemplateIfNotExists(string $eventName, array $fields, bool $silent = false)

Добавляет шаблон смс события, если его нет

Аргумент Описание
string $eventName Символьный код типа смс события
array $fields Поля шаблона смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->addSmsTemplateIfNotExists(
        'SMS_USER_RESTORE_PASSWORD',
        [
            'SENDER' => '#DEFAULT_SENDER#',
            'RECEIVER' => '#USER_PHONE#',
            'MESSAGE' => 'Код для восстановления пароля #CODE#',
            'LANGUAGE_ID' => 'ru',
            'LID' => [
                's1'
            ],
        ]
    ));

    return true;
}
        
    

 

updateSmsTemplates(string $eventName, array $fields, bool $silent = false): bool

Обновляет шаблон смс события

Аргумент Описание
string $eventName Символьный код типа смс события
array $fields Поля шаблона смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->updateSmsTemplates(
        'SMS_USER_RESTORE_PASSWORD',
        [
            'LANGUAGE_ID' => 'en',
        ]
    ));

    return true;
}
        
    

 

updateSmsTemplateById(int $id, array $fields, bool $silent = false): bool

Обновляет шаблон смс события по идентификатору

Аргумент Описание
int $id Идентификатор шаблона типа смс события
array $fields Поля шаблона смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->updateSmsTemplateById(
        11,
        [
            'LANGUAGE_ID' => 'en',
        ]
    ));

    return true;
}
        
    

 

saveSmsTemplate(string $eventName, array $fields, bool $silent = false)

Сохраняет шаблон смс события

Аргумент Описание
string $eventName Символьный код типа смс события
array $fields Поля шаблона смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->saveSmsTemplate(
        'SMS_USER_RESTORE_PASSWORD',
        [
            'LANGUAGE_ID' => 'en',
            'LID' => ['s1'],
        ]
    ));

    return true;
}
        
    

 

deleteSmsTemplate(array $fields, bool $silent = false): bool

Удаляет шаблон смс события

Аргумент Описание
array $fields Поля шаблона смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->deleteSmsTemplate(
        [
            'EVENT_NAME' => 'SMS_USER_RESTORE_PASSWORD',
            'RECEIVER' => '#USER_PHONE#',
        ]
    ));

    return true;
}
        
    

 

deleteSmsTemplateIfExists(array $fields, bool $silent = false): bool

Удаляет шаблон смс события, если он есть

Аргумент Описание
array $fields Поля шаблона смс события
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->deleteSmsTemplateIfExists(
        [
            'EVENT_NAME' => 'SMS_USER_RESTORE_PASSWORD',
            'RECEIVER' => '#USER_PHONE#',
        ]
    ));

    return true;
}
        
    

 

getSmsTemplateSites(int $id): array

Получает список сайтов для шаблона смс события

Аргумент Описание
int $id Идентификатор шаблона смс события
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $eventHelper = $helper->getEventHelper();

    $this->outDump($eventHelper->getSmsTemplateSites(1));

    return true;
}