tunect/yii2-page-help

Yii2 extention to attach help pages to any controller action

Controller action-based page help storage extension for Yii2 framework

This module provides ability to create help pages and link them to your app controller's actions. Widged can be used to display modal pop-over with help page linked to particular (current) action for end users., _(*1)

Installation

Run to install extension:, _(*2)

composer require tunect/yii2-page-help

Run migration:, _(*3)

./yii migrate

It's possible to add custom migration paths since Yii2 2.0.10 (module adds it's path in tunect\Yii2PageHelp\Bootstrap file), _(*4)

Additional settings are optional., _(*5)

Module settings

To specify module name (default name is help) set it in index.php or in config file (before config goes to Application constructor):, _(*6)

\tunect\Yii2PageHelp\Module::$moduleName = 'custom-help';

Module settings can be changed in app config:, _(*7)

'modules' => [
    'help' => [
        'class' => 'tunect\Yii2PageHelp\Module',
        'tableName' => '{{%custom_table_name}}',
        'roles' => function () {
            return [\app\models\User::ROLE_ADMIN];
        },
    ],
],

Note: Settings should be specified both in web and console app configs since this module has a migration. Or you can use common config, merge config parts, etc., _(*8)

By default '@' (any authenticated user) role will be used, but any other role(s) can be defined in roles module property (see example above). It can take scalar value, array or callable., _(*9)

Usage

To create or update help for any page of your website visit /<module_name>/index page (by default /help/index). <module_name> is the name module was registred with, if you changed Module::$moduleName - use your value., _(*10)

Page field should contain page path in format <controller>/<action> OR <module>/<controller>/<action>, check looks like:, _(*11)

$this->page = Yii::$app->controller->id . '/' . Yii::$app->controller->action->id;
// Add module prefix
if (Yii::$app->controller->module->id !== Yii::$app->id) {
    $this->page = Yii::$app->controller->module->id . '/' . $this->page;
}

Module name being checked only if current action is not an application's controller action:, _(*12)

• help/default/index for help module default controller and index action
• site/login for main application site controller and login action

Content field can contain any help info with Markdown support. This content will be displayed in modal available for particular page., _(*13)

To add help modal button to layout just add widget to any place in view (layout) file (e.g. next to page header h1):, _(*14)

<?= \tunect\Yii2PageHelp\widgets\HelpButton::widget(); ?>

On button click modal will be displayed. Button will be visible only if help record exists for current page., _(*15)

(the name module was registred with, if you changed Module::$moduleName - use your value as a path)., _(*16)

TODO

• Implement global search