README

Plugin for highlights.

Installation

1. The preferred way to install this extension is through composer.

Either run

composer require amos/highlights

or add this row

"amos/highlights": "dev-master"

to the require section of your composer.json file.

2. Apply migrations

php yii migrate/up --migrationPath=@vendor/amos/highlights/src/migrations

or add this row to your migrations config in console:

<?php
return [
    '@vendor/amos/highlights/src/migrations',
];

3. Backend configuration

To enable the plugin in backend add this configuration in backend/config/modules-amos.php file or in your main-local.php file.

<?php
'modules' => [
    'highlights' => [
        'class' => 'amos\highlights\Module',
    ],
],

Configurable fields

Here the list of configurable fields, properties of module. If some property default is not suitable for your project, you can configure it in module, eg:

 'highlights' => [
	'class' => 'amos\highlights\Module',
	'modelsSearchEnabled' => [
		/**
		 * Add here the classnames of the models where you want the highlights
		 * (i.e. 'elitedivision\amos\news\models\search\NewsSearch')
		 */
	],
 ],