Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_moodlenet

Namespaces

namespace  tool_moodlenet
  
 
namespace  tool_moodlenet\local
  
 
namespace  tool_moodlenet\output
  
 
namespace  tool_moodlenet\privacy
  
 
namespace  tool_moodlenet\task
  
 

Classes

class  tool_moodlenet\external
 This is the external API for this component. More...
 
class  tool_moodlenet\local\import_backup_helper
 The import_backup_helper class. More...
 
class  tool_moodlenet\local\import_handler_info
 The import_handler_info class. More...
 
class  tool_moodlenet\local\import_handler_registry
 The import_handler_registry class. More...
 
class  tool_moodlenet\local\import_info
 Class import_info, describing objects which represent a resource being imported by a user. More...
 
class  tool_moodlenet\local\import_processor
 The import_processor class. More...
 
interface  tool_moodlenet\local\import_strategy
 The import_strategy interface. More...
 
class  tool_moodlenet\local\import_strategy_file
 The import_strategy_file class. More...
 
class  tool_moodlenet\local\import_strategy_link
 The import_strategy_link class. More...
 
class  tool_moodlenet\local\url
 The url class, providing a representation of a url and operations on its component parts. More...
 
class  tool_moodlenet\moodlenet_user_profile
 A class to represent the moodlenet profile. More...
 
class  tool_moodlenet\output\renderer
 Renderer class. More...
 
class  tool_moodlenet\output\select_page
 Select page renderable. More...
 
class  tool_moodlenet\privacy\provider
 Privacy class for tool_moodlenet. More...
 
class  tool_moodlenet\profile_manager
 Class for handling interaction with the moodlenet profile. More...
 
class  tool_moodlenet\task\post_install
 
class  tool_moodlenet\task\send_enable_notification
 
class  tool_moodlenet\task\send_mnet_profiles_data_removed_notification
 

Functions

 generate_mnet_endpoint (string $profileurl, int $course, int $section=0)
 Generate the endpoint url to the user's moodlenet site.
 
 tool_moodlenet_custom_chooser_footer (int $courseid, int $sectionid)
 Hooking function to build up the initial Activity Chooser footer information for MoodleNet.
 
 xmldb_tool_moodlenet_install ()
 Perform the post-install procedures.
 
 xmldb_tool_moodlenet_upgrade (int $oldversion)
 Upgrade the plugin.
 

Variables

 $functions
 
 $plugin = 2023041800
 
$plugin component = 'tool_moodlenet'
 
$plugin maturity = MATURITY_ALPHA
 
const MOODLENET_DEFAULT_ENDPOINT "lms/moodle/search"
 The default endpoint to MoodleNet.
 
$plugin version = 2023042400
 

Detailed Description

Function Documentation

◆ generate_mnet_endpoint()

generate_mnet_endpoint ( string $profileurl,
int $course,
int $section = 0 )

Generate the endpoint url to the user's moodlenet site.

Parameters
string$profileurlThe user's moodlenet profile page
int$courseThe moodle course the mnet resource will be added to
int$sectionThe section of the course will be added to. Defaults to the 0th element.
Return values
stringthe resulting endpoint
Exceptions
moodle_exception

◆ tool_moodlenet_custom_chooser_footer()

tool_moodlenet_custom_chooser_footer ( int $courseid,
int $sectionid )

Hooking function to build up the initial Activity Chooser footer information for MoodleNet.

Parameters
int$courseidThe course the user is currently in and wants to add resources to
int$sectionidThe section the user is currently in and wants to add resources to
Return values
activity_chooser_footer
Exceptions
dml_exception
moodle_exception

◆ xmldb_tool_moodlenet_upgrade()

xmldb_tool_moodlenet_upgrade ( int $oldversion)

Upgrade the plugin.

Parameters
int$oldversion
Return values
boolalways true

Variable Documentation

◆ $functions

$functions
Initial value:
= [
'tool_moodlenet_verify_webfinger' => [
'classname' => 'tool_moodlenet\external',
'methodname' => 'verify_webfinger',
'description' => 'Verify if the passed information resolves into a WebFinger profile URL',
'type' => 'read',
'ajax' => true,
],
'tool_moodlenet_search_courses' => [
'classname' => 'tool_moodlenet\external',
'methodname' => 'search_courses',
'description' => 'For some given input search for a course that matches',
'type' => 'read',
'ajax' => true,
],
]
const MOODLE_OFFICIAL_MOBILE_SERVICE
Moodle mobile app service name.
Definition moodlelib.php:530