\JHelperTags

Tags helper class, provides methods to perform various tasks relevant tagging of content.

Synopsis

class JHelperTags extends JHelper {

• // members
• protected  $tagsChanged;
• protected  $replaceTags;
• public  $typeAlias;
• // methods
• public boolean addTagMapping()
• public static array convertPathsToNames()
• public mixed createTagsFromField()
• public mixed createTagsFromMetadata()
• public boolean deleteTagData()
• public array getItemTags()
• public string getTagIds()
• public JDatabaseQuery getTagItemsQuery()
• public array getTagNames()
• public mixed getTagTreeArray()
• public string getTypeId()
• public static array getTypes()
• public boolean postStoreProcess()
• public null preStoreProcess()
• public static array searchTags()
• public void tagDeleteInstances()
• public boolean tagItem()
• public boolean unTagItem()
• // Inherited methods from JHelper
• public string getCurrentLanguage()
• public integer getLanguageId()
• public array getRowData()
• public  getDataObject()
}


Hierarchy

Extends

• JHelper

Members

protected

• $replaceTags — boolean
  Whether up replace all tags or just add tags
• $tagsChanged — boolean
  Helper object for storing and deleting tag information.

public

• $typeAlias — string
  Alias for querying mapping and content type table.

Methods

public

• addTagMapping() — Method to add tag rows to mapping table.
• convertPathsToNames() — Function that converts tags paths into paths of names
• createTagsFromField() — Create any new tags by looking for #new# in the strings
• createTagsFromMetadata() — Create any new tags by looking for #new# in the metadata
• deleteTagData() — Method to delete the tag mappings and #__ucm_content record for for an item
• getItemTags() — Method to get a list of tags for an item, optionally with the tag data.
• getTagIds() — Method to get a list of tags for a given item.
• getTagItemsQuery() — Method to get a query to retrieve a detailed list of items for a tag.
• getTagNames() — Function that converts tag ids to their tag names
• getTagTreeArray() — Method to get an array of tag ids for the current tag and its children
• getTypeId() — Method to get the type id for a type alias.
• getTypes() — Method to get a list of types with associated data.
• postStoreProcess() — Function that handles saving tags used in a table class after a store()
• preStoreProcess() — Function that preProcesses data from a table prior to a store() to ensure proper tag handling
• searchTags() — Function to search tags
• tagDeleteInstances() — Method to delete all instances of a tag from the mapping table. Generally used when a tag is deleted.
• tagItem() — Method to add or update tags associated with an item.
• unTagItem() — Method to untag an item

Inherited from JHelper

public

• getCurrentLanguage() — Gets the current language
• getDataObject() — Method to get an object containing all of the table columns and values.
• getLanguageId() — Gets the associated language ID
• getRowData() — Gets a row of data from a table