lav45/yii2-target-behavior

This extension allows you to link between multiple objects.

1.3.1 2020-12-21 14:52 UTC

Requires

• yiisoft/yii2: ~2.0

BSD-3-Clause

• Alexey Loban

• extension
• Behavior
• yii2
• target
• many to many

README

This extension provides behavior functions for linking the two elements through the relation.

Installation

The preferred way to install this extension is through composer.

Either run

$ composer require lav45/yii2-target-behavior

or add

"lav45/yii2-target-behavior": "^1.3"

to the require section of your composer.json file.

Configuring

First you need to configure model as follows:

use lav45\behavior\Target;

class Post extends ActiveRecord
{
    public function behaviors() {
        return [
            [
                'class' => Target::className(),
                'targetAttribute' => 'tagNames',
//                'targetRelation' => 'tags',
//                'targetRelationAttribute' => 'name',
//                'delimiter' => ',',
            ],
        ];
    }
}

Usage

First you need to create a tbl_tag (you can choose the name you wish) table with the following format, and build the correspondent ActiveRecord class (i.e. Tag):

+-----------+
|  tbl_tag  |
+-----------+
| id        |
| name      |
+-----------+

After, if you wish to link tags to a certain ActiveRecord (lets say Tour), you need to create the table that will link the Tour Model to the Tag:

+-------------------+
| tbl_tour_tag_assn |
+-------------------+
| tour_id           |
| tag_id            |
+-------------------+

Next, we need to configure the relationship with Tour:

/**
 * @return \yii\db\ActiveQuery
 */
public function getTags()
{
    return $this->hasMany(Tag::className(), ['id' => 'tag_id'])
        ->viaTable('tbl_tour_tag_assn', ['tour_id' => 'id']);
}

Its important to note that if you use a different name, the behavior's $relation attribute should be changed accordingly.

Finally, setup the behavior, and the attribute + rule that is going to work with it in our Tour class, on this case we are going to use defaults tagNames:

/**
 * @inheritdoc
 */
public function rules()
{
    return [
        // ...
        [['tagNames'], 'safe'],
        // ...
    ];
}

/**
 * @inheritdoc
 */
public function behaviors()
{
    return [
        // for different configurations, please see the code
        // we have created tables and relationship in order to
        // use defaults settings
        'class' => Target::className(),
        'targetAttribute' => 'tagNames',
    ];
}

Thats it, we are now ready to use tags with our model. For example, this is how to use it in our forms together with our Selectize Widget:

// On TagController (example)
// actionList to return matched tags
public function actionList($query)
{
    // We know we can use ContentNegotiator filter
    // this way is easier to show you here :)
    Yii::$app->response->format = Response::FORMAT_JSON;

    return Tag::find()
       ->select(['name'])
       ->where(['like', 'name', $query])
       ->asArray()
       ->limit(10)
       ->all();
}


// On our form
<?= $form->field($model, 'tagNames')->widget(SelectizeTextInput::className(), [
    // calls an action that returns a JSON object with matched
    // tags
    'loadUrl' => ['tag/list'],
    'options' => ['class' => 'form-control'],
    'clientOptions' => [
        'plugins' => ['remove_button'],
        'valueField' => 'name',
        'labelField' => 'name',
        'searchField' => ['name'],
        'create' => true,
    ],
])->hint('Use commas to separate tags') ?>

As you can see, tagNames is the attribute (by default) from which we can access our tags and they are stored in it as names separated by commas if you defined your attribute tagNames as string or null, if you define tagNames as an array, it will be filled with the related tags.

Once you post a form with the above field, the tags will be automatically saved and linked to our Tour model.

Testing

$ composer global require phpunit/phpunit
$ composer global require phpunit/dbunit
$ export PATH="$PATH:~/.composer/vendor/bin"
$ phpunit

License

The BSD 3-Clause License. Please see License File for more information.