README

Yii2 的 FAQ 模块

安装

安装此扩展的首选方式是通过 composer。

运行以下命令：

php composer.phar require --prefer-dist usesgraphcrt/yii2-faq "*"

或者在您的 composer.json 文件的 require 部分添加：

"usesgraphcrt/yii2-faq": "*"

执行迁移

php yii migrate --migrationPath=@vendor/usesgraphcrt/yii2-faq/migrations/

使用方法

您应该将模块添加到您的配置中

'modules' => [
        ...
        'faq' => [
                    'class' => \usesgraphcrt\faq\Module::className(),
                    'imagesUrl' => 'http://my_site_name/upload/faq/',
                    'imagesPath' => '@frontend/web/upload/faq/',//realpath(__DIR__.'/../../frontend/web/upload/faq/')
                ],
    ],

您应该使用 'imagesUrl' 和 'imagesPath' 来定义用于存储 FAQ 图片的文件夹。这些变量应该定义相同的目录。在上面的例子中，图片将保存在 '@frontend/web/upload/faq' 目录中。您应该定义这两个变量，因为此模块中使用了 Imperavi 小部件，它们需要这个小部件。

如果您使用的是高级项目模板，您应该使用相同的值配置 config.php

您可以在您的后端导航栏中添加对模块的链接

$menuItems[] = ['label' => 'FAQ', 'url' => ['/faq/main/view']];

要显示 FAQ，只需添加

echo \usesgraphcrt\faq\widgets\FaqWidget\FaqWidget::widget();

小部件有两个参数 - 'title' 和 'breadcrumbs'，默认值为 'false'，这意味着不会在带有小部件的页面上应用标题和面包屑。如果您将小部件放置在包含其他信息的现有页面上，这很有用。如果您将小部件放置在单独的页面上并想要指定标题或面包屑（或者两者都指定），您可以像这样调用小部件

echo \usesgraphcrt\faq\widgets\FaqWidget\FaqWidget::widget([
    'title' => Yii::t('app', 'FAQ'),
    'breadcrumbs' => Yii::t('app', 'FAQ page'),
]);

您可能需要将 composer.json 文件中的 minimum stability 部分更改为 dev

"minimum-stability": "dev",

模块支持俄语和英语。默认情况下，Imperavi 小部件的语言为俄语 ('ru')。您可以通过向模块配置中添加来将其更改为英语

'imperaviLanguage' => 'en'

该模块正在建设中