core_course\output\category_action_bar Class Reference

Inheritance diagram for core_course\output\category_action_bar:

Public Member Functions
	__construct (moodle_page $page, object $category, ?object $course=null, ?string $searchvalue=null)
	Constructor category_action_bar.
	export_for_template (\renderer_base $output)
	Export the content to be displayed on the category page.

Protected Member Functions
	get_additional_category_options ()
	Gets the additional options to be displayed within a 'More' dropdown in the tertiary navigation.
	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	$category
	The current category we are referring to.
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\category_action_bar::__construct	(	moodle_page	$page,
		object	$category,
		?object	$course = null,
		?string	$searchvalue = null )

Constructor category_action_bar.

Parameters

moodle_page	$page	The page object
object	$category
object | null	$course	The course that we are generating the nav for
string | null	$searchvalue

Member Function Documentation

export_for_template()

core_course\output\category_action_bar::export_for_template

(

\renderer_base

$output

)

Export the content to be displayed on the category page.

Parameters

renderer_base

$output

Return values

array

Consists of the following: categoryselect A list of available categories to be fed into a urlselect search The course search form additionaloptions Additional actions that can be performed in a category

Reimplemented from core_course\output\manage_categories_action_bar.

get_additional_category_options()

core_course\output\category_action_bar::get_additional_category_options ( )

protected

Gets the additional options to be displayed within a 'More' dropdown in the tertiary navigation.

The predefined order defined by UX is:

• Add a course
• Add a sub cat
• Manage course
• Request a course
• Course pending approval

Return values

array

get_category_select()

core_course\output\category_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|null

The content required to render the url_select

Reimplemented from core_course\output\manage_categories_action_bar.

get_dropdown()

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

protectedinherited

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

Parameters

renderer_base

$output

Return values

object|null

The content required to render the url_select

get_search_form()

core_course\output\manage_categories_action_bar::get_search_form ( )

protectedinherited

Get the search box.

Return values

array

---

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

• course/classes/output/category_action_bar.php