Alias module for Yii2

2.0.4 2016-03-03 14:43 UTC

README

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require infoweb-internet-solutions/yii2-cms-alias "*"

or add

"infoweb-internet-solutions/yii2-cms-alias": "*"

to the require section of your composer.json file.

Usage

Once the extension is installed, simply modify your application configuration as follows:

Your backend configuration as follows:

'modules' => [
    ...
    'alias' => [
        'class' => 'infoweb\alias\Module',
        'reservedUrls' => ['page'] // Url's that are reserved by the application
    ],
],

Import the translations and use category 'infoweb/alias':

yii i18n/import @infoweb/alias/messages

To use the module, execute yii migration

yii migrate/up --migrationPath=@vendor/infoweb-internet-solutions/yii2-cms-alias/migrations

Behavior

The AliasBehavior is used to manage the url field for the entity that the Alias is attached to. The behavior has to be attached to an ActiveRecord class that has a language identifier. Below is an example of how it can be attached to \infoweb\pages\models\Lang

use infoweb\alias\behaviors\AliasBehavior;

public function behaviors()
{
    return [
        'alias' => [
            'class' => AliasBehavior::className(),
            'entityType' => Page::className(),
            'entityIdField' => 'page_id'
        ],
    ];
}

The url field can be rendered in your ActiveForm view

 // Initialize the tabs
<?= $this->render('@infoweb/alias/views/behaviors/alias/_url', [
        'form' => $form,
        'model' => $model,
        'alias' => $alias,
        'readonly' => false,
        'duplicateable' => true,
        'urlPrefix' => ''
    ]) ?>

If you want to automatically generate the alias based on the content of another field add this to its configuration:

'data-slugable' => 'true',
'data-slug-target' => "#alias-{$model->language}-url"

Trait

The AliasRelationTrait is used to extend the entity for which you want to enable the usage of Alias. It defines custom event(s), thegetAlias relation for the model and the findByAlias method. Below is an example of how it can be attached to infoweb\pages\models\Page

use infoweb\alias\traits\AliasRelationTrait;

class Page extends ActiveRecord
{
	use AliasRelationTrait;
}

You should also add a getUrl method to the entity (or modify it if it already exists) that uses the url field of the getAlias relation.