class category_support

internal  
 

Utility functions for Moodle course categories.

Methods

static category|null
get_category(int $categoryid)

Retrieves a category entity by its ID.

static array
get_category_context_options(int $visible = 1)

Retrieves category contexts as an options list [contextid => label].

static void
get_subcategories_recursive(int $categoryid, array $subcategories)

Recursively collects subcategory IDs for a given category ID.

Details

at line 41
static category|null get_category(int $categoryid)

Retrieves a category entity by its ID.

Parameters

int $categoryid

Category ID

Return Value

category|null

Category entity or null if not found

at line 63
static array get_category_context_options(int $visible = 1)

Retrieves category contexts as an options list [contextid => label].

Parameters

int $visible

visibility filter (default: 1)

Return Value

array

Map of context ID to formatted label

at line 92
static void get_subcategories_recursive(int $categoryid, array $subcategories)

Recursively collects subcategory IDs for a given category ID.

Parameters

int $categoryid

Parent category ID

array $subcategories

array passed by reference to be filled with subcategory IDs

Return Value

void

Exceptions

moodle_exception