FUEL CMS User Guide : Version 1.5.2

Tags & Categories

FUEL CMS 1.0 provides a generic tags and categories modules that can you incorporate into your own modules. They are hidden by default. To turn them on, you must comment out the lines in the fuel/application/config/MY_fuel_modules.php making them hidden. The differences between tags and categories can be a little confusing at first but the best way to think of their differences is that tags provide a flat many-to-many relationship between things whereas categories provide a one-to-many relationship and can often be hierarchical. In fact, the tags module uses categories to group tags together.

Tags

To utilize the tags module, add a has_many property to your module's model. This will use FUEL's relationship table to store tag relationships and will create a multi-select for the module form in the CMS. It will also automatically assign the belongs_to relationship to your tag.

<?php  if (!defined('BASEPATH')) exit('No direct script access allowed');

require_once('Base_module_model.php');

class Widgets_model extends Base_module_model {
	....
	public $has_many = array('tags' => 'fuel_tags_model');
	....

This will allow you to do something like the following from the widget record object:

$widgets = fuel_model('widgets');
foreach($widgets as $widget)
{
	$widget_tags = $widget->tags;
	foreach($widget_tags as $tag)
	{
		echo $tag->name;
	}
}

This will allow you to do something like the following from the tag object:

$tag = $this->fuel->tags->find_by_tag('my_tag');
foreach($tag->widgets as $widget) {
	echo $widget->name;
}

Categories

The category module is helpful for categorizing records. A category's context value can be used to further group categories together. You can use the a model's foreign_key property as well as the addition of the where parameter to target a particular context (if needed) and associate a single category to a particular record. This will create a dropdown select for the module form in the CMS:

<?php  if (!defined('BASEPATH')) exit('No direct script access allowed');

require_once('Base_module_model.php');

class Widgets_model extends Base_module_model {
	....
	public $foreign_keys  = array('category_id' => array(FUEL_FOLDER => 'fuel_categories_model', 'where' => array('context' => 'product_categories')));
	....

From the widget records perspective, you can do something like the following:

// also can use $this->widgets_model->find_all();
$widgets = fuel_model('widgets');
foreach($widgets as $widget) {
	echo $widget->category->name;
}

From the category perspective, you can do something like the following:

// also could use $this->fuel_categories_model->find_one(array('slug' => 'my_category')); assuming the model is loaded
$category = $this->fuel->categories->find_by_slug('my_category'); 

foreach($category->widgets as $widget) {
	echo $widget->name;
}