pistej/yii2-faq

Simple Yii2 FAQ extension

0.1.0 2019-01-26 10:34 UTC

Requires

• php: >=7.1
• yiisoft/yii2: ~2.0.14

BSD-3-Clause

• pistej

• module
• extension
• help
• FAQ
• yii2

README

Simple Yii2 FAQ extension - show help text based on visited application URL and application language.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist pistej/yii2-faq "~0.1"

or add

"pistej/yii2-faq": "~0.1"

to the require section of your composer.json file.

To run database migrations, simply call:

php yii migrate/up --migrationPath=vendor/pistej/yii2-faq/migrations/

Usage

You should add module to your config:

'modules' => [
    ...
    'faq' => [
        'class' => 'pistej\faq\Faq',
    ],
],

To display FAQ CRUD (administration pages) just go to URL:
example.com/faq/qa/index
example.com/faq/group/index Actions are allowed for authenticated users only.

Once the extension is installed, simply use it in your code or layout by:

<?= \pistej\faq\widgets\FaqWidget\FaqWidget::widget(); ?>

Translations

To add new language, (clone repository, install composer) add new language code into message/config.php file

'languages' => ['sk', 'pl'],

and run yii command to extract messages from root folder

php vendor/bin/yii message messages/config.php 

translate newly created messages and create PR.