Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
core_course\output\manage_categories_action_bar Class Reference
Inheritance diagram for core_course\output\manage_categories_action_bar:
renderable core_course\output\category_action_bar

Public Member Functions

 __construct (moodle_page $page, string $viewmode, ?object $course, ?string $searchvalue)
 Constructor for the manage_categories_action_bar.
 
 export_for_template (\renderer_base $output)
 Export the content to be displayed on the participants page.
 

Protected Member Functions

 get_category_select (\renderer_base $output)
 Gets the url_select to be displayed in the participants page if available.
 
 get_dropdown (\renderer_base $output)
 Gets the url_select to be displayed in the participants page if available.
 
 get_search_form ()
 Get the search box.
 

Protected Attributes

object $course
 $course The course we are dealing with.
 
string null $heading
 $heading The heading to display
 
moodle_page $page
 $page The current page.
 
string null $searchvalue
 $searchvalue The search value if any
 
string null $viewmode
 $viewmode The viewmode of the underlying page - Course and categories, categories or courses
 

Constructor & Destructor Documentation

◆ __construct()

core_course\output\manage_categories_action_bar::__construct ( moodle_page $page,
string $viewmode,
?object $course,
?string $searchvalue )

Constructor for the manage_categories_action_bar.

Parameters
moodle_page$pageThe page object
string$viewmodeThe type of page we are viewing.
object | null$courseThe course that we are generating the nav for
string | null$searchvalueThe search value if applicable

Member Function Documentation

◆ export_for_template()

core_course\output\manage_categories_action_bar::export_for_template ( \renderer_base $output)

Export the content to be displayed on the participants page.

Parameters
renderer_base$output
Return values
arrayConsists of the following:
  • urlselect A stdclass representing the standard navigation options to be fed into a urlselect
  • renderedcontent Rendered content to be displayed in line with the tertiary nav

Reimplemented in core_course\output\category_action_bar.

◆ get_category_select()

core_course\output\manage_categories_action_bar::get_category_select ( \renderer_base $output)
protected

Gets the url_select to be displayed in the participants page if available.

Parameters
renderer_base$output
Return values
object|nullThe content required to render the url_select

Reimplemented in core_course\output\category_action_bar.

◆ get_dropdown()

core_course\output\manage_categories_action_bar::get_dropdown ( \renderer_base $output)
protected

Gets the url_select to be displayed in the participants page if available.

Parameters
renderer_base$output
Return values
object|nullThe content required to render the url_select

◆ get_search_form()

core_course\output\manage_categories_action_bar::get_search_form ( )
protected

Get the search box.

Return values
array

The documentation for this class was generated from the following file: