CategoryGroupsVariable

Type
Class
Namespace
Craft
Inherits
Craft\CategoryGroupsVariable
Since
2.4

Class CategoryGroupsVariable

See also http://craftcms.com

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

array

Signature

public array getAllGroupIds ( )

getAllGroups()

Returns all category groups.

View source

Arguments

Returns

array

Signature

public array getAllGroups ( $indexBy = null )

getEditableGroupIds()

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

View source

Returns

array

Signature

public array getEditableGroupIds ( )

getEditableGroups()

Returns all editable groups.

View source

Arguments

Returns

array

Signature

public array getEditableGroups ( $indexBy = null )

getGroupByHandle()

Returns a group by its handle.

View source

Arguments

  • $groupHandle

Returns

Craft\CategoryGroupModel, null

Signature

public Craft\CategoryGroupModel, null getGroupByHandle ( $groupHandle )

getGroupById()

Returns a group by its ID.

View source

Arguments

  • $groupId

Returns

Craft\CategoryGroupModel, null

Signature

public Craft\CategoryGroupModel, null getGroupById ( $groupId )

getTotalGroups()

Gets the total number of category groups.

View source

Returns

integer

Signature

public integer getTotalGroups ( )