Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2amigos/yii2-taggable-behavior
This extension allows you to get functional for tagging.
https://github.com/2amigos/yii2-taggable-behavior
behavior php yii2
Last synced: about 2 months ago
JSON representation
This extension allows you to get functional for tagging.
- Host: GitHub
- URL: https://github.com/2amigos/yii2-taggable-behavior
- Owner: 2amigos
- License: other
- Archived: true
- Created: 2014-01-14T12:25:39.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-04-09T10:57:23.000Z (about 5 years ago)
- Last Synced: 2024-03-26T23:02:31.479Z (3 months ago)
- Topics: behavior, php, yii2
- Language: PHP
- Homepage: https://2amigos.us
- Size: 52.7 KB
- Stars: 85
- Watchers: 29
- Forks: 27
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Lists
- list - 2amigos/yii2-taggable-behavior - Behavior functions for tagging. (Extensions / Database)
- list - 2amigos/yii2-taggable-behavior - Behavior functions for tagging. (Extensions / Database)
- awesome-yii - 2amigos/yii2-taggable-behavior - behavior functions for tagging. (Extensions / Database)
README
# Taggable Behavior for Yii 2
[](https://github.com/2amigos/yii2-taggable-behavior/tags)
[](LICENSE.md)
[](https://travis-ci.org/2amigos/yii2-taggable-behavior)
[](https://scrutinizer-ci.com/g/2amigos/yii2-taggable-behavior/code-structure)
[](https://scrutinizer-ci.com/g/2amigos/yii2-taggable-behavior)
[](https://packagist.org/packages/2amigos/yii2-taggable-behavior)
This extension provides behavior functions for tagging.
## Installation
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```bash
$ composer require 2amigos/yii2-taggable-behavior:~1.0
```
or add
```
"2amigos/yii2-taggable-behavior": "~1.0"
```
to the `require` section of your `composer.json` file.
## Configuring
First you need to configure model as follows:
```php
use dosamigos\taggable\Taggable;
class Tour extends ActiveRecord
{
public function behaviors() {
return [
[
'class' => Taggable::className(),
],
];
}
}
```
## 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 |
| frequency |
| 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`:
```php
/**
* @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`:
```php
/**
* @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
Taggable::className(),
];
}
```
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](https://github.com/2amigos/yii2-selectize-widget):
```php
// On TagController (example)
// actionList to return matched tags
public function actionList($query)
{
$models = Tag::findAllByName($query);
$items = [];
foreach ($models as $model) {
$items[] = ['name' => $model->name];
}
// We know we can use ContentNegotiator filter
// this way is easier to show you here :)
Yii::$app->response->format = Response::FORMAT_JSON;
return $items;
}
// 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
```bash
$ ./vendor/bin/phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Antonio Ramirez](https://github.com/tonydspaniard)
- [Alexander Kochetov](https://github.com/creocoder)
- [All Contributors](https://github.com/2amigos/yii2-selectize-widget/graphs/contributors)
## License
The BSD License (BSD). Please see [License File](LICENSE.md) for more information.
web development has never been so fun
www.2amigos.us