CategoryGroupsVariable

Type
Class
Namespace
Craft
Inherits
Craft\CategoryGroupsVariable
Since
2.4

Class CategoryGroupsVariable

See also http://craftcms.com

View source (opens new window)

# Public Methods

Method Description
getAllGroupIds() Returns all of the group IDs.
getAllGroups() Returns all category groups.
getEditableGroupIds() Returns all of the category group IDs that are editable by the current user.
getEditableGroups() Returns all editable groups.
getGroupByHandle() Returns a group by its handle.
getGroupById() Returns a group by its ID.
getTotalGroups() Gets the total number of category groups.

# getAllGroupIds()

Returns all of the group IDs.

View source (opens new window)

Returns

array (opens new window)

Signature

public array getAllGroupIds ( )

# getAllGroups()

Signature

public array getAllGroups ( $indexBy = null )

# getEditableGroupIds()

Returns all of the category group IDs that are editable by the current user.

View source (opens new window)

Returns

array (opens new window)

Signature

public array getEditableGroupIds ( )

# getEditableGroups()

Signature

public array getEditableGroups ( $indexBy = null )

# getGroupByHandle()

Returns a group by its handle.

View source (opens new window)

Arguments

  • $groupHandle

Returns

Craft\CategoryGroupModel, null (opens new window)

Signature

public Craft\CategoryGroupModel, null getGroupByHandle ( $groupHandle )

# getGroupById()

Returns a group by its ID.

View source (opens new window)

Arguments

  • $groupId

Returns

Craft\CategoryGroupModel, null (opens new window)

Signature

public Craft\CategoryGroupModel, null getGroupById ( $groupId )

# getTotalGroups()

Gets the total number of category groups.

View source (opens new window)

Returns

integer (opens new window)

Signature

public integer getTotalGroups ( )