TagsService

Type
Class
Namespace
Craft
Inherits
Craft\TagsService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.1

Class TagsService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
deleteTagGroupById()Deletes a tag group by its ID.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()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()Returns the list of attached event handlers for an event.
getIsInitialized()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()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()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()Raises an event.
saveTag()Saves a tag.
saveTagGroup()Saves a tag group.

deleteTagGroupById()

Deletes a tag group by its ID.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean deleteTagGroupById ( $tagGroupId )

getAllTagGroupIds()

Returns all of the group IDs.

View source

Returns

array

Signature

public array getAllTagGroupIds ( )

getAllTagGroups()

Returns all tag groups.

View source

Arguments

Returns

array

Signature

public array getAllTagGroups ( $indexBy = null )

getTagById()

Returns a tag by its ID.

View source

Arguments

Returns

Craft\TagModel, null

Signature

public Craft\TagModel, null getTagById ( $tagId, $localeId )

getTagGroupByHandle()

Gets a group by its handle.

View source

Arguments

Returns

Craft\TagGroupModel, null

Signature

public Craft\TagGroupModel, null getTagGroupByHandle ( $groupHandle )

getTagGroupById()

Returns a group by its ID.

View source

Arguments

Returns

Craft\TagGroupModel, null

Signature

public Craft\TagGroupModel, null getTagGroupById ( $groupId )

getTotalTagGroups()

Gets the total number of tag groups.

View source

Returns

integer

Signature

public integer getTotalTagGroups ( )

onBeforeSaveTag()

Fires an 'onBeforeSaveTag' event.

View source

Arguments

Returns

null

Signature

public null onBeforeSaveTag ( Craft\Event $event )

onSaveTag()

Fires an 'onSaveTag' event.

View source

Arguments

Returns

null

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

Arguments

Returns

null

Signature

public null onSaveTagContent ( Craft\Event $event )

saveTag()

Saves a tag.

View source

Arguments

Returns

boolean

Throws

  • \Craft\Exception|\Exception

Signature

public boolean saveTag ( Craft\TagModel $tag )

saveTagGroup()

Saves a tag group.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean saveTagGroup ( Craft\TagGroupModel $tagGroup )