Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | List of all members
core_question\bank\menuable_action Interface Reference

Interface to indicate that a question bank column can go in the action menu. More...

Inheritance diagram for core_question\bank\menuable_action:
core_question\bank\menu_action_column_base core_question\bank\preview_action_column core_question\bank\tags_action_column core_question\bank\copy_action_column core_question\bank\delete_action_column core_question\bank\edit_action_column core_question\bank\export_xml_action_column

Public Member Functions

 get_action_menu_link (\stdClass $question)
 Return the appropriate action menu link, or null if it does not apply to this question. More...
 

Detailed Description

Interface to indicate that a question bank column can go in the action menu.

If a question bank column implements this interface, and if the edit_menu_column is present in the question bank view, then the 'column' will be shown as an entry in the edit menu instead of as a separate column.

Probably most columns that want to implement this will be subclasses of action_column_base, and most such columns should probably implement this interface.

If your column is a simple action, you can probably save duplicated code by using the base class action_column_menuable as an easy way to implement both action_column_base and this interface.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ get_action_menu_link()

core_question\bank\menuable_action::get_action_menu_link ( \stdClass  $question)

Return the appropriate action menu link, or null if it does not apply to this question.

Parameters
stdClass$questiondata about the question being displayed in this row.
Return values
action_menu_link|nullthe action, if applicable to this question.

Implemented in core_question\bank\menu_action_column_base, core_question\bank\preview_action_column, and core_question\bank\tags_action_column.


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