tool_admin_presets\local\action\load Class Reference

This class extends base class and handles load function. More...

Inheritance diagram for tool_admin_presets\local\action\load:

Public Member Functions
	display ()
	Main display method.
	execute ()
	Executes the settings load into the system.
	log ()
	Trigger an event based on the current action.
	preview ()
	Displays a preset information (name, description, settings different from the current configuration...).
	show ()
	Displays the select preset settings to select what to import.

Protected Member Functions
	display_header ()
	Displays the header.
	display_preset (bool $displayform=true, bool $raiseexception=true)
	Method to prepare the information to preview/load the preset.
	get_explanatory_description ()
	Get explanatory description to be displayed below the heading.
	get_title ()
	Get page title for this action.

Protected Attributes
string	$action
	The main action (delete, export, import, load...).
int	$id
	Admin preset identifier.
manager	$manager
	The manager helper class instance.
string	$mode
	The mode (show, execute...).
moodleform	$moodleform
	The moodle form to display in the page.
int	$outputs
	The output content to display in the page.

Static Protected Attributes
static array	$eventsactionsmap
	Array map for the events.

Detailed Description

This class extends base class and handles load function.

Copyright

2021 Pimenko suppo.nosp@m.rt@p.nosp@m.imenk.nosp@m.o.co.nosp@m.m<pimenko.com>

Author

Jordan Kesraoui | Sylvain Revenu | Pimenko based on David Monllaó david.nosp@m..mon.nosp@m.llao@.nosp@m.urv..nosp@m.cat code

License

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

Member Function Documentation

display()

tool_admin_presets\local\action\base::display ( )

inherited

Main display method.

Prints the block header and the common block outputs, the selected action outputs, his form and the footer

$outputs value depends on $mode and $action selected

display_preset()

tool_admin_presets\local\action\load::display_preset ( bool $displayform = true, bool $raiseexception = true )

protected

Method to prepare the information to preview/load the preset.

Parameters

bool	$displayform	Whether the form should be displayed in the page or not.
bool	$raiseexception	Whether the exception should be raised or not when the preset doesn't exist. When it's set to false, a message is displayed, instead of raising the exception.

get_explanatory_description()

tool_admin_presets\local\action\load::get_explanatory_description ( )

protected

Get explanatory description to be displayed below the heading.

It's optional and might change depending on the action and the mode.

Return values

string|null

The explanatory description for the current action and mode.

Reimplemented from tool_admin_presets\local\action\base.

get_title()

tool_admin_presets\local\action\base::get_title ( )

protectedinherited

Get page title for this action.

Return values

string

The page title to display into the page.

Reimplemented in tool_admin_presets\local\action\rollback.

log()

tool_admin_presets\local\action\base::log ( )

inherited

Trigger an event based on the current action.

Return values

void

show()

tool_admin_presets\local\action\load::show

(

)

Displays the select preset settings to select what to import.

Loads the preset data and displays a settings tree.

It checks the Moodle version and it only allows users to import the preset available settings.

Reimplemented from tool_admin_presets\local\action\base.

Member Data Documentation

$eventsactionsmap

array tool_admin_presets\local\action\base::$eventsactionsmap

staticprotectedinherited

Initial value:

= [
        'base' => 'presets_listed',
        'delete' => 'preset_deleted',
        'export' => 'preset_exported',
        'import' => 'preset_imported',
        'preview' => 'preset_previewed',
        'load' => 'preset_loaded',
        'rollback' => 'preset_reverted',
        'download_xml' => 'preset_downloaded'
    ]

Array map for the events.

---

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

• admin/tool/admin_presets/classes/local/action/load.php