TagsService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\TagsService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.1
Class TagsService
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| deleteTagGroupById() | Deletes a tag group by its ID. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getAllTagGroupIds() | Returns all of the group IDs. |
| getAllTagGroups() | Returns all tag groups. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getTagById() | Returns a tag by its ID. |
| getTagGroupByHandle() | Gets a group by its handle. |
| getTagGroupById() | Returns a group by its ID. |
| getTotalTagGroups() | Gets the total number of tag groups. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| onBeforeSaveTag() | Fires an 'onBeforeSaveTag' event. |
| onSaveTag() | Fires an 'onSaveTag' event. |
| onSaveTagContent() | Fires an 'onSaveTagContent' event. |
| raiseEvent() (opens new window) | Raises an event. |
| saveTag() | Saves a tag. |
| saveTagGroup() | Saves a tag group. |
# deleteTagGroupById()
Deletes a tag group by its ID.
View source (opens new window)
Arguments
$tagGroupId(integer (opens new window))
Returns
Throws
Signature
public boolean deleteTagGroupById ( $tagGroupId )
# getAllTagGroupIds()
Signature
public array getAllTagGroupIds ( )
# getAllTagGroups()
Returns all tag groups.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getAllTagGroups ( $indexBy = null )
# getTagById()
Returns a tag by its ID.
View source (opens new window)
Arguments
$tagId(integer (opens new window))$localeId(string (opens new window), null (opens new window))
Returns
Signature
public Craft\TagModel, null getTagById ( $tagId, $localeId )
# getTagGroupByHandle()
Gets a group by its handle.
View source (opens new window)
Arguments
$groupHandle(string (opens new window))
Returns
Signature
public Craft\TagGroupModel, null getTagGroupByHandle ( $groupHandle )
# getTagGroupById()
Returns a group by its ID.
View source (opens new window)
Arguments
$groupId(integer (opens new window))
Returns
Signature
public Craft\TagGroupModel, null getTagGroupById ( $groupId )
# getTotalTagGroups()
Signature
public integer getTotalTagGroups ( )
# onBeforeSaveTag()
Fires an 'onBeforeSaveTag' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onBeforeSaveTag ( Craft\Event $event )
# onSaveTag()
Signature
public null onSaveTag ( Craft\Event $event )
# onSaveTagContent()
DEPRECATED
Deprecated Deprecated in 2.0. Use {@link onSaveTag() tags.onSaveTag} instead.
Fires an 'onSaveTagContent' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onSaveTagContent ( Craft\Event $event )
# saveTag()
Saves a tag.
View source (opens new window)
Arguments
$tag(Craft\TagModel)
Returns
Throws
\Craft\Exception|\Exception
Signature
public boolean saveTag ( Craft\TagModel $tag )
# saveTagGroup()
Saves a tag group.
View source (opens new window)
Arguments
$tagGroup(Craft\TagGroupModel)
Returns
Throws
Signature
public boolean saveTagGroup ( Craft\TagGroupModel $tagGroup )