Allows active record model to manage tags.
Create a table where you want to store tags and cross-table to store tag-model connections.
You can use sample SQL from schema.sql file.
In your ActiveRecord model define behaviors() method:
[php]
function behaviors() {
return array(
'tags' => array(
'class' => 'ext.yiiext.behaviors.model.taggable.ETaggableBehavior',
// Table where tags are stored
'tagTable' => 'Tag',
// Cross-table that stores tag-model connections.
// By default it's your_model_tableTag
'tagBindingTable' => 'PostTag',
// Foreign key field field in cross-table.
// By default it's your_model_tableId
'modelTableFk' => 'post_id',
// tagTableCondition - empty by default. Can be used in cases where e.g. the tag is composed of
// two fields and a custom search expression is needed to find the tag. Example for user table:
// 'tagTableCondition' => new CDbExpression("CONCAT(t.name,' ',t.surname) = :tag "),
// Tag table PK field
'tagTablePk' => 'id',
// Tag name field
'tagTableName' => 'name',
// Tag counter field
// if null (default) does not write tag counts to DB
'tagTableCount' => 'count',
// Tag binding table tag ID
'tagBindingTableTagId' => 'tagId',
// Caching component ID. If false don't use cache.
// Defaults to false.
'cacheID' => 'cache',
// Save nonexisting tags.
// When false, throws exception when saving nonexisting tag.
'createTagsAutomatically' => true,
// Default tag selection criteria
'scope' => array(
'condition' => ' t.user_id = :user_id ',
'params' => array( ':user_id' => Yii::app()->user->id ),
),
// Values to insert to tag table on adding tag
'insertValues' => array(
'user_id' => Yii::app()->user->id,
),
)
);
}
For using AR model for tags (for example, to bind custom behavior), use EARTaggableBehavior.
To do it add following to your config:
[php]
return array(
// ...
'import'=>array(
'application.models.*',
'application.components.*',
'ext.yiiext.behaviors.model.taggable.*',
// ...
// other imports
),
// ...
);
In your AR model implement behaviors() method:
[php]
function behaviors() {
return array(
'tags_with_model' => array(
'class' => 'ext.yiiext.behaviors.model.taggable.EARTaggableBehavior',
// tag table name
'tagTable' => 'Tag',
// tag model class
'tagModel' => 'Tag',
// ...
// other options as shown above
)
);
}
Replace model tags with new tags set.
[php]
$post = new Post();
$post->setTags('tag1, tag2, tag3')->save();
Add one or more tags to existing set.
[php]
$post->addTags('new1, new2')->save();
Remove tags specified (if they do exist).
[php]
$post->removeTags('new1')->save();
Remove all tags from the model.
[php]
$post->removeAllTags()->save();
Get array of model's tags.
[php]
$tags = $post->getTags();
foreach($tags as $tag){
echo $tag;
}
Returns true if all tags specified are assigned to current model and false otherwise.
[php]
$post = Post::model()->findByPk(1);
if($post->hasTags("yii, php")){
//…
}
Get all possible tags for this model class.
[php]
$tags = Post::model()->getAllTags();
foreach($tags as $tag){
echo $tag;
}
Get all possible tags with models count for each for this model class.
[php]
$tags = Post::model()->getAllTagsWithModelsCount();
foreach($tags as $tag){
echo $tag['name']." (".$tag['count'].")";
}
Limits AR query to records with all tags specified.
[php]
$posts = Post::model()->taggedWith('php, yii')->findAll();
$postCount = Post::model()->taggedWith('php, yii')->count();
could be used to reset getAllTags() or getAllTagsWithModelsCount() cache.
You can print comma separated tags following way:
[php]
$post->addTags('new1, new2')->save();
echo $post->tags->toString();
You can use multiple tag groups for a single model. For example, we will create OS and Category tag groups for Software model.
First we need to create DB tables. Two for each group:
[sql]
/* Tag table */
CREATE TABLE `Os` (
`id` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
`name` VARCHAR(255) NOT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `Os_name` (`name`)
);
/* Tag binding table */
CREATE TABLE `PostOs` (
`post_id` INT(10) UNSIGNED NOT NULL,
`osId` INT(10) UNSIGNED NOT NULL,
PRIMARY KEY (`post_id`,`osId`)
);
/* Tag table */
CREATE TABLE `Category` (
`id` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT,
`name` VARCHAR(255) NOT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `Category_name` (`name`)
);
/* Tag binding table */
CREATE TABLE `PostCategory` (
`post_id` INT(10) UNSIGNED NOT NULL,
`categoryId` INT(10) UNSIGNED NOT NULL,
PRIMARY KEY (`post_id`,`categoryId`)
);
Then we are attaching behaviors:
[php]
return array(
'categories' => array(
'class' => 'ext.yiiext.behaviors.model.taggable.ETaggableBehavior',
'tagTable' => 'Category',
'tagBindingTable' => 'PostCategory',
'tagBindingTableTagId' => 'categoryId',
),
'os' => array(
'class' => 'ext.yiiext.behaviors.model.taggable.ETaggableBehavior',
'tagTable' => 'Os',
'tagBindingTable' => 'PostOs',
'tagBindingTableTagId' => 'osId',
),
);
That's it. Now we can use it:
[php]
$soft = Software::model()->findByPk(1);
// fist attached taggable behavior is used by default
// so we can use short syntax instead of $soft->categories->addTag("Antivirus"):
$soft->addTag("Antivirus");
$soft->os->addTag("Windows");
$soft->save();
[php]
<?$this->widget('CAutoComplete', array(
'name' => 'tags',
'value' => $model->tags->toString(),
'url'=>'/autocomplete/tags', //path to autocomplete URL
'multiple'=>true,
'mustMatch'=>false,
'matchCase'=>false,
)) ?>
Saving tags will look like following:
[php]
function actionUpdate(){
$model = Post::model()->findByPk($_GET['id']);
if(isset($_POST['Post'])){
$model->attributes=$_POST['Post'];
$model->setTags($_POST['tags']);
// if you have multiple tag fields:
// $model->tags1->setTags($_POST['tags1']);
// $model->tags1->setTags($_POST['tags2']);
if($model->save()) $this->redirect(array('index'));
}
$this->render('update',array(
'model'=>$model,
));
}