Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_moodlenet\local\import_handler_info Class Reference

The import_handler_info class. More...

Public Member Functions

 __construct (string $modulename, string $description, import_strategy $strategy)
 The import_handler_info constructor.
 
 get_description ()
 Get a human readable, localised description of how the file is handled by the module.
 
 get_module_name ()
 Get the name of the module.
 
 get_strategy ()
 Get the import strategy used by this handler.
 

Protected Attributes

string $description
 $description the description.
 
import_strategy $importstrategy
 $importstrategy the strategy which will be used to import resources handled by this handler
 
string $modulename
 $modulename the name of the module.
 

Detailed Description

The import_handler_info class.

An import_handler_info object represent an resource import handler for a particular module.

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

Constructor & Destructor Documentation

◆ __construct()

tool_moodlenet\local\import_handler_info::__construct ( string $modulename,
string $description,
import_strategy $strategy )

The import_handler_info constructor.

Parameters
string$modulenamethe name of the module handling the file extension. E.g. 'label'.
string$descriptionA description of how the module handles files of this extension type.
import_strategy$strategythe strategy which will be used to import the resource.
Exceptions
coding_exception

Member Function Documentation

◆ get_description()

tool_moodlenet\local\import_handler_info::get_description ( )

Get a human readable, localised description of how the file is handled by the module.

Return values
stringthe localised description.

◆ get_module_name()

tool_moodlenet\local\import_handler_info::get_module_name ( )

Get the name of the module.

Return values
stringthe module name, e.g. 'label'.

◆ get_strategy()

tool_moodlenet\local\import_handler_info::get_strategy ( )

Get the import strategy used by this handler.

Return values
import_strategythe import strategy object.

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