Tags

Type: Class
Namespace: craft\services
Inherits: craft\services\Tags » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Since: 3.0.0

Tags service.

An instance of the service is available via Craft::$app->getTags().

Public Properties

Property	Description
allTagGroupIds	array
allTagGroups	craft\models\TagGroup[]
behaviors	yii\base\Behavior – List of behaviors attached to this component.
totalTagGroups	integer

`allTagGroupIds`

Type: array
Default value: null
Access: Read-only

View source

`allTagGroups`

Type: craft\models\TagGroup[]
Default value: null
Access: Read-only

View source

`totalTagGroups`

Type: integer
Default value: null
Access: Read-only

View source

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()	Constructor.
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__serialize()	Serializer
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
behaviors()	Returns a list of behaviors that this component should behave as.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
deleteTagGroup()	Deletes a tag group.
deleteTagGroupById()	Deletes a tag group by its ID.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
getAllTagGroupIds()	Returns all of the group IDs.
getAllTagGroups()	Returns all tag groups.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getTagById()	Returns a tag by its ID.
getTagGroupByHandle()	Gets a group by its handle.
getTagGroupById()	Returns a group by its ID.
getTagGroupByUid()	Returns a group by its UID.
getTotalTagGroups()	Gets the total number of tag groups.
handleChangedTagGroup()	Handle tag group change
handleDeletedTagGroup()	Handle Tag group getting deleted
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
pruneDeletedField()
saveTagGroup()	Saves a tag group.
trigger()	Triggers an event.