CategoryGroups

Type
Class
Namespace
craft\web\twig\variables
Inherits
craft\web\twig\variables\CategoryGroups
Since
3.0
Deprecated in
in 3.0

Class CategoryGroupsVariable

View source

Public Methods

MethodDescription
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

Returns

integer[]

Signature

public integer[] getAllGroupIds ( )

getAllGroups()

Returns all category groups.

View source

Arguments

Returns

craft\models\CategoryGroup[]

Signature

public craft\models\CategoryGroup[] getAllGroups ( \craft\web\twig\variables\string $indexBy = null )

getEditableGroupIds()

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

View source

Returns

integer[]

Signature

public integer[] getEditableGroupIds ( )

getEditableGroups()

Returns all editable groups.

View source

Arguments

Returns

craft\models\CategoryGroup[]

Signature

public craft\models\CategoryGroup[] getEditableGroups ( \craft\web\twig\variables\string $indexBy = null )

getGroupByHandle()

Returns a group by its handle.

View source

Arguments

Returns

craft\models\CategoryGroup, null

Signature

public craft\models\CategoryGroup, null getGroupByHandle ( \craft\web\twig\variables\string $groupHandle )

getGroupById()

Returns a group by its ID.

View source

Arguments

Returns

craft\models\CategoryGroup, null

Signature

public craft\models\CategoryGroup, null getGroupById ( \craft\web\twig\variables\int $groupId )

getTotalGroups()

Gets the total number of category groups.

View source

Returns

integer

Signature

public integer getTotalGroups ( )