J3.x:Using Tags in an Extension

Introduction

Joomla's tagging system is used in all core content extensions and is designed to be easy to integrate into other extensions that use standard Joomla design patterns.

Using tags in an extension is fairly straightforward. It requires these changes to a typical extension:

• Register a Content type for the extension view(s)
• Add Observer methods to the extension table class(es)
• Add Tag fields to the extension edit forms
• Add Tag display code to the extension view files
• Optionally, add a batch tagging method to the extension administration

Register a Content Type for Each View

In Joomla! 3, content types (articles, weblinks, contacts and so on) are registered in the #__content_types table with a separate record for each content view.

Your extension installer needs to create a new record for each view.

Here is the structure of the #__content_types table. Each column is described in the following sections.

Column name	Column type	Purpose
type_id	int(10)	Record key
type_title	varchar(255)	Type title e.g. Article
type_alias	varchar(255)	Type alias e.g. com_content.article
table	varchar(255)	Information about the Table class
rules	text	Not currently used
field_mappings	text	Maps the table column names to standard Joomla! names
router	varchar(255)	Optional: name of a router method
content_history_options	varchar(5120)	Optional: ????

type_id

This is the auto-incremented record key, nothing to be done here.

type_title

The title for your Content Type. For example, Article, Contact, Weblink. You can do this either using sql or postflight by creating an instance of JTableContenttype. Don't forget a category type if you use the Joomla categories API.

type_alias

A string identifying the component and view. (That would be in the page request, typically matching the model name.) For example, com_contact.contact, com_weblinks.weblink.

table

Identify which tables used by your component contain records to be tagged. For example, the Contact view of the Contacts component uses #__contact_details. Similarly the Weblinks view of the Weblinks component uses #__weblinks .

Each of these components uses a class to write to the table: ContactTableContact for the Contacts component and WeblinksTableWeblink for the Weblinks component. You will need the class prefixes e.g. ContactTable, WeblinksTable.

Note that Category types all use the #__categories table.

The type_table entry gives the complete table class information for the table class as a JSON object with two elements. The first element represents your "special" table and the second an optional common table. (Otherwise it will default to JTableCorecontent.)

Here is the JSON entry for the Weblink content type:

{
  "special": {
    "dbtable": "#__weblinks",
    "key": "id",
    "type": "Weblink",
    "prefix": "WeblinksTable",
    "config": "array()"
  },
  "common": {
    "dbtable": "#__ucm_content",
    "key": "ucm_id",
    "type": "Corecontent",
    "prefix": "JTable",
    "config": "array()"
  }
}

The values to be included are:

Entry name	Content
dbtable	Table name
key	Primary key name
type	Content type
prefix	Class prefix
config	An option array, as used in your component constructor and getInstance() methods. It may be empty.

This information enables the tagging system (and other APIs) to access your table easily.

If you are using Joomla categories, be sure to create a category type so that they can be tagged. In Joomla 3.1 and 3.1.1, there is an error where the tag field will show even if there is not a type. This is corrected in Joomla 3.1.4.

Notes

• The table name for the common table is #__ucm_content. This is incorrect in Joomla 3.1 and 3.1.1 data but is not currently used. The data was updated in Joomla 3.1.4.

• The type_title field would potentially be used for display although this is not implemented currently except in the contenttype field. Usually it should begin with an upper case letter if it is in English. See the note about how to make this translatable. To make your type names translatable, add COM_TAGS_CONTENT_TYPE_+type_title="Type Title" in both the .ini and .sys.ini files.

rules

Rules is currently not used. It will likely be removed in favor of an asset_id for each type. You can ignore this field which will be managed by JTable.

field_mappings

This entry maps the names of specific fields in your table to a set of standard Joomla! names. This mapping is stored as a JSON array with the first 'common' element mapping to the common fields and the second 'special' element mapping the other fields from the table.

Here is the field_mappings entry for the Banner Content Type (chosen because it is a richer example than Article or WebLink). Note that 'common' mappings that have no equivalent are included as null (Leaving them blank may cause SQL issues.) The names and values in the 'special' element all match as they are limited to this component.

{
  "common": {
    "core_content_item_id": "id",
    "core_title": "name",
    "core_state": "published",
    "core_alias": "alias",
    "core_created_time": "created",
    "core_modified_time": "modified",
    "core_body": "description",
    "core_hits": "null",
    "core_publish_up": "publish_up",
    "core_publish_down": "publish_down",
    "core_access": "access",
    "core_params": "params",
    "core_featured": "null",
    "core_metadata": "metadata",
    "core_language": "language",
    "core_images": "images",
    "core_urls": "link",
    "core_version": "version",
    "core_ordering": "ordering",
    "core_metakey": "metakey",
    "core_metadesc": "metadesc",
    "core_catid": "catid",
    "core_xreference": "null",
    "asset_id": "null"
  },
  "special": {
    "imptotal": "imptotal",
    "impmade": "impmade",
    "clicks": "clicks",
    "clickurl": "clickurl",
    "custombannercode": "custombannercode",
    "cid": "cid",
    "purchase_type": "purchase_type",
    "track_impressions": "track_impressions",
    "track_clicks": "track_clicks"
  }
}

At a minimum for common fields you need to map: content_item_id, alias and title in order to successfully create URLs in the tagged items list. You also will probably want: access, status, and language. The special fields are optional.

Note

• The JHelperTags and JUcm APIs at Joomla 3.1.1 supported arrays for this field. As of Joomla 3.1.4, either arrays or objects are supported. The default is objects.

router

This is an optional entry to include the name of a static helper router method for this type found in its front end helpers folder. For example, WeblinksHelperRoute::getWeblinkRoute.

If you do not have a custom router, Tags falls back to the rules in JHelperRoute.

If you only store data in #__ucm_content, you will eventually be able to leave the router field blank although this option is not currently implemented.

content_history_options

This section was added in Joomla! 3.2 to link to the Content History component.

Here's the entry for the Banner Content Type:

{
  "formFile": "administrator\/components\/com_banners\/models\/forms\/banner.xml",
  "hideFields": [
    "checked_out",
    "checked_out_time",
    "version",
    "reset"
  ],
  "ignoreChanges": [
    "modified_by",
    "modified",
    "checked_out",
    "checked_out_time",
    "version",
    "imptotal",
    "impmade",
    "reset"
  ],
  "convertToInt": [
    "publish_up",
    "publish_down",
    "ordering"
  ],
  "displayLookup": [
    {
      "sourceColumn": "catid",
      "targetTable": "#__categories",
      "targetColumn": "id",
      "displayColumn": "title"
    },
    {
      "sourceColumn": "cid",
      "targetTable": "#__banner_clients",
      "targetColumn": "id",
      "displayColumn": "name"
    },
    {
      "sourceColumn": "created_by",
      "targetTable": "#__users",
      "targetColumn": "id",
      "displayColumn": "name"
    },
    {
      "sourceColumn": "modified_by",
      "targetTable": "#__users",
      "targetColumn": "id",
      "displayColumn": "name"
    }
  ]
}

Creating the Record

You can create records in the installer in one of three ways:

1. in the postflight method
2. by creating a JTableContenttype instance and adding a row, or
3. by using SQL to create a record directly

Modify your Component's Table Class (or Classes for Multiple Tables)

Add the following to your JTable constructor:

$this->_observers = new JObserverUpdater($this); JObserverMapper::attachAllObservers($this);

The additional material formerly located here is no longer needed after Joomla 3.1.4 Please read the document history for this page if you are required to support Joomla 3.1.0 or 3.1.1.

For Joomla 3.2, I needed this line: (Replace Weblinks by your component name.)

JObserverMapper::addObserverClassToClass('JTableObserverTags', 'WeblinksTableWeblink', array('typeAlias' => 'com_weblinks.weblink'));

For Joomla 3.4.1, use this: (Replace content by your component name.)

JTableObserverTags::createObserver($this, array('typeAlias' => 'com_content.item'));

Add Tags to the getItem() Method of the Model

This is still required for Joomla 3.4.1. Add the following to your model getItem. (Replace com_content.article with your component name/model.):

 if (!empty($item->id))
 {
  $item->tags = new JHelperTags;
  $item->tags->getTagIds($item->id, 'com_content.article');
 }

Note this was only required in Joomla 3.1.0 and 3.1.1. It should not be used in Joomla 3.1.4. Please read the history of this page if you need instructions for older versions.

Add a Tag Field to Edit Screens

In any edit layouts where you want to allow tagging, add the field to the .xml and the appropriate layouts if necessary. The core layouts use a JLayout to manage this and the same layout by any extension.

Note that in Joomla 3.1.1 only, there is special handling of this in the core. Tags in the edit screen must be part of a metadata <fields></fields> group. The core provides two JLayouts to help you manage standard layouts—one (details) for the metadata and one for the sidebar that includes the tabs. In updating an extension to Joomla 3.1.4, you might need to adjust your edit views.

In Joomla 3.1.4 and later, this special handling is not necessary. The best practice is to use the standard JLayouts bacause this provides a consistent experience for users.

		<field name="tags" type="tag"
			label="JTAG" description="JTAG_DESC"
			class="inputbox span12 small" multiple="true"
		>
		</field>

The field loads all the JavaScript libraries required. You don't need to worry about that.

The field supports two modes:

1. Nested tags mode. The hierarchical tag list that does not support on the fly tag creation.
2. AJAX mode. Tags are searched while user types. (A minimum of three characters are required to launch the AJAX search.) Custom tags are added by pressing ENTER or COMMA keys. The tags show the global route/path. Example: grandpa/parent/tag

The field mode can be forced or use the com_tags setting Tag field mode to determine its mode. To set or force the field mode, add mode="ajax" or mode="nested" to the tag field definition.

An example of the forced AJAX mode:

		<field name="tags" type="tag" mode="ajax"
			label="JTAG" description="JTAG_DESC"
			class="inputbox span12 small" multiple="true"
		>
		</field>

The field also includes an attribute to allow or deny the entry of custom values by the user. This only works in AJAX mode. The attribute has to be added to the field definition like custom="allow" or custom="deny".

An example field definition with custom tags denied:

		<field name="tags" type="tag" mode="ajax" custom="denied"
			label="JTAG" description="JTAG_DESC"
			class="inputbox span12 small" multiple="true"
		>
		</field>

...if it is not already there. Usually multiple should be true unless you have a specific reason for it not to be false. In the core components in administrator, the field is in the group shown on the right, below the language field.

Note: As of Joomla 3.1.2 if you wish to use the field to designate parent tags, you must add parent="parent" to the .xml definition of the field.

Prepare the View

Add an appropriate version of this to your view.html.php file before loading the layout:

$item->tags = new JHelperTags;
$item->tags->getItemTags('com_newsfeeds.newsfeed' , $this->item->id);

The first parameter should match a type in the types table. The second parameter is the primary key under which this record is stored in your table. This would be used in any display in any view where you want the tags associated with the item to display.

Set Up the Display

In any layout where you want to display the tags associated with an item add:

		<?php $this->item->tagLayout = new JLayoutFile('joomla.content.tags'); ?>
		<?php echo $this->item->tagLayout->render($this->item->tags->itemTags); ?>

...changing the object and property names as appropriate.

You will most likely want to add the show_tags parameter to the item parameters, menu item parameters and component configuration as appropriate for your use case.

	<?php if ($this->params->get('show_tags', 1) && !empty($this->item->tags)) : ?>
		<?php $this->item->tagLayout = new JLayoutFile('joomla.content.tags'); ?>
		<?php echo $this->item->tagLayout->render($this->item->tags->itemTags); ?>
	<?php endif; ?>

Batch Processing

If you want to add the ability to do batch tagging to a backend list view, do the following.

Add tag to the default_batch layout

	<div class="control-group">
			<div class="controls">
				<?php echo JHtml::_('batch.tag');?>
			</div>
		</div>

Also add a tag to the button class in the modal footer. (It is not necessary at this point, but good for potential future changes. For example, if unTag is added.

<button class="btn" type="button" onclick="document.id('batch-category-id').value='';document.id('batch-access').value='';document.id('batch-language-id').value='';document.id('batch-user-id').value='';document.id('batch-tag-id)').value=''" data-dismiss="modal">

Add a Batch Method to Your Model If Not Extending JModelAdmin or Overriding the Batch Method

	/**
	 * Batch tag a list of item.
	 *
	 * @param   integer  $value     The value of the new tag.
	 * @param   array    $pks       An array of row IDs.
	 * @param   array    $contexts  An array of item contexts.
	 *
	 * @return  void.
	 *
	 * @since   3.1
	 */
	protected function batchTag($value, $pks, $contexts)
	{
		$tagsHelper = new JHelperTags();
		$tagsHelper->tagItems($value, $pks, $contexts);
		return true;
	}

Also modify your batch method by adding:

		if (!empty($commands['tag']))
		{
			if (!$this->batchTag($commands['tag'], $pks, $contexts))
			{
				return false;
			}
			$done = true;
		}

Pay attention to any JSON-encoded strings for which special handling for in batch processing is required. You are saving a copy of the core fields and you need the save to work as expected.