xtetis/xpagemessage

xEngine 模块创建简单的消息页面

dev-master 2023-12-29 14:42 UTC

This package is auto-updated.

Last update: 2024-09-29 16:12:26 UTC


README

为 xEngine 驱动的用户消息页面模块

页面 URL 相同。用于显示用户服务消息。例如,成功的注册文本、激活账户等。

由 xTetis 提供

模块安装

  • 如果您使用 xEngine (https://bitbucket.org/xtetis/xengine/),则它包含 composer.json 文件,因此将自动安装。
    "xtetis/xpagemessage": "dev-master",
    
  • 模块安装后,必须在 engine/config 参数中指定以下常量
常量类型示例描述
COMPONENT_URL_LIST字符串,序列化数组define("COMPONENT_URL_LIST", serialize(['pagemessage' => 'xtetis\\xpagemessage']));xEngine 模块 URL 列表
DEFAULT_LAYOUT字符串define("DEFAULT_LAYOUT", 'page');默认模板

在代码中使用

用于创建将在消息页面上显示的内容

    // Устанавливаем параметры для отображения страницы с сообщением для пользователя с единым урлом
    \xtetis\xpagemessage\Component::setPageMessageParams([
        'message' => $message,
        'name'    => 'Письмо с подтверждением',
        'title'   => 'Вам отправлено письмо',
    ]);

如果需要定义其他页面布局(使用其他块) - 可以传递参数

用于创建将在消息页面上显示的内容

    // Устанавливаем параметры для отображения страницы с сообщением для пользователя с единым урлом
    \xtetis\xpagemessage\Component::setPageMessageParams([
        'message' => $message,
        'name'    => 'Письмо с подтверждением',
        'title'   => 'Вам отправлено письмо',
        'block'   => 'blocks/custom_pagemessage'
    ]);

在代码块中使用自定义模板时,需要设置 layout 参数

    // Установка кастомного шаблона
    \xtetis\xengine\App::setParam('layout', 'layout_name');

生成显示消息的页面 URL

   // Урл страницы для сообщения пользователю после регистрации
    $url_pagemessage = \xtetis\xpagemessage\Component::getModuleUrl('pagemessage');

也可以在当前页面上显示消息(例如,错误消息)

    // Метод, который выполняется когда нужно прекратить выполнение 
    // и показать пользователю сообщение об ошибке
    define('CUSTOM_DIE', '\xtetis\xcms\Component::cmsCustomDie');
    
    /**
     * Страница кастомной ошибки
     */
    public static function cmsCustomDie($message)
    {
        \xtetis\xpagemessage\Component::setPageMessageParams([
            'message'=>$message,
            'name'=>'Ошибка',
            'title'=>'Ошибка',
        ]);
        \xtetis\xpagemessage\Component::renderPageMessage();
        exit;
    }

反馈

联系作者

  • skype: xtetis
  • telegram: @xtetis