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()
Signature
public array getAllGroupIds ( )
# getAllGroups()
Returns all category groups.
View source (opens new window)
Arguments
$indexBy(null (opens new window), string (opens new window))
Returns
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
Signature
public array getEditableGroupIds ( )
# getEditableGroups()
Returns all editable groups.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
Signature
public array getEditableGroups ( $indexBy = null )
# getGroupByHandle()
Signature
public Craft\CategoryGroupModel, null getGroupByHandle ( $groupHandle )
# getGroupById()
Signature
public Craft\CategoryGroupModel, null getGroupById ( $groupId )
# getTotalGroups()
Signature
public integer getTotalGroups ( )