wdmg/yii2-turbo

Yandex Turbo-pages generator

Installs: 309

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Type:yii2-extension

1.0.3 2020-06-28 15:14 UTC

This package is auto-updated.

Last update: 2022-08-16 04:20:58 UTC


README

Yii2 Downloads Packagist Version Progress GitHub license

Yii2 Yandex.Turbo

Yii2 Yandex.Turbo

Yandex.Turbo pages generator.

This module is an integral part of the Butterfly.СMS content management system, but can also be used as an standalone extension.

Copyrights (c) 2019-2021 W.D.M.Group, Ukraine

Requirements

Installation

To install the module, run the following command in the console:

$ composer require "wdmg/yii2-turbo"

After configure db connection, run the following command in the console:

$ php yii turbo/init

And select the operation you want to perform:

  1. Apply all module migrations
  2. Revert all module migrations
  3. Flush Yandex turbo-pages cache

Migrations

In any case, you can execute the migration and create the initial data, run the following command in the console:

$ php yii migrate --migrationPath=@vendor/wdmg/yii2-turbo/migrations

Configure

To add a module to the project, add the following data in your configuration file:

'modules' => [
    ...
    'turbo' => [
        'class' => 'wdmg\turbo\Module',
        'supportModels'  => [ // list of supported models for displaying a Turbo-pages feed
            'news' => 'wdmg\news\models\News',
        ],
        'cacheExpire' => 3600, // cache lifetime, `0` - for not use cache
        'channelOptions' => [], // default channel options
        'turboRoute' => '/' // default route to render Turbo-pages feed (use "/" - for root)
    ],
    ...
],

Routing

Use the Module::dashboardNavItems() method of the module to generate a navigation items list for NavBar, like this:

<?php
    echo Nav::widget([
    'options' => ['class' => 'navbar-nav navbar-right'],
        'label' => 'Modules',
        'items' => [
            Yii::$app->getModule('turbo')->dashboardNavItems(),
            ...
        ]
    ]);
?>

Status and version [ready to use]

  • v.1.0.3 - Update dependencies, README.md
  • v.1.0.2 - Added support for Blog module, fixed models items retrieved
  • v.1.0.1 - Added pagination, up to date dependencies
  • v.1.0.0 - Added console, migrations and controller, support for Pages and News models