Class craft\web\twig\variables\CategoryGroups
- Inheritance
- craft\web\twig\variables\CategoryGroups
- Available since version
- 3.0
- Deprecated since version
- in 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/web/twig/variables/CategoryGroups.php
Class CategoryGroupsVariable
| Method | Description | Defined By |
|---|---|---|
getAllGroupIds() |
Returns all of the group IDs. | craft\web\twig\variables\CategoryGroups |
getAllGroups() |
Returns all category groups. | craft\web\twig\variables\CategoryGroups |
getEditableGroupIds() |
Returns all of the category group IDs that are editable by the current user. | craft\web\twig\variables\CategoryGroups |
getEditableGroups() |
Returns all editable groups. | craft\web\twig\variables\CategoryGroups |
getGroupByHandle() |
Returns a group by its handle. | craft\web\twig\variables\CategoryGroups |
getGroupById() |
Returns a group by its ID. | craft\web\twig\variables\CategoryGroups |
getTotalGroups() |
Gets the total number of category groups. | craft\web\twig\variables\CategoryGroups |
Method Details
getAllGroupIds()
public method
#
Returns all of the group IDs.
public integer[] getAllGroupIds ( )
getAllGroups()
public method
#
Returns all category groups.
public craft\models\CategoryGroup[] getAllGroups ( \craft\web\twig\variables\string $indexBy = null )$indexBy |
string, null |
getEditableGroupIds()
public method
#
Returns all of the category group IDs that are editable by the current user.
public integer[] getEditableGroupIds ( )
getEditableGroups()
public method
#
Returns all editable groups.
public craft\models\CategoryGroup[] getEditableGroups ( \craft\web\twig\variables\string $indexBy = null )$indexBy |
string, null |
getGroupByHandle()
public method
#
Returns a group by its handle.
public craft\models\CategoryGroup, null getGroupByHandle ( \craft\web\twig\variables\string $groupHandle )$groupHandle |
string |
getGroupById()
public method
#
Returns a group by its ID.
public craft\models\CategoryGroup, null getGroupById ( \craft\web\twig\variables\int $groupId )$groupId |
integer |
getTotalGroups()
public method
#
Gets the total number of category groups.
public integer getTotalGroups ( )