Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
tool_mobile

Namespaces

namespace  tool_mobile
  
 
namespace  tool_mobile\local\hooks\output
  
 
namespace  tool_mobile\local\hooks\user
  
 
namespace  tool_mobile\output
  
 
namespace  tool_mobile\privacy
  
 

Classes

class  tool_mobile\api
 API exposed by tool_mobile, to be used mostly by external functions and the plugin settings. More...
 
class  tool_mobile\external
 This is the external API for this tool. More...
 
class  tool_mobile\hook_callbacks
 
class  tool_mobile\local\hooks\output\before_http_headers
 
class  tool_mobile\local\hooks\user\after_user_passed_mfa
 
class  tool_mobile\output\renderer
 Renderer class. More...
 
class  tool_mobile\output\subscription
 Subscription page. More...
 
class  tool_mobile\privacy\provider
 Privacy provider for tool_mobile. More...
 

Functions

 tool_mobile_create_app_download_url ()
 Generate the app download url to promote moodle mobile.
 
 tool_mobile_get_token ($userid)
 Return the user mobile app WebService access token.
 
 tool_mobile_myprofile_navigation (\core_user\output\myprofile\tree $tree, $user, $iscurrentuser)
 User profile page callback.
 
 tool_mobile_pre_processor_message_send ($procname, $data)
 Callback to be able to change a message/notification data per processor.
 
 tool_mobile_user_has_token ($userid)
 Checks if the given user has a mobile token (has used recently the app).
 
 xmldb_tool_mobile_upgrade ($oldversion)
 Upgrade the plugin.
 

Variables

 $callbacks
 
 $definitions
 
 $functions
 
 $plugin = 2024041600
 
$plugin component = 'tool_mobile'
 
$plugin dependencies
 
$plugin version = 2024042200
 

Detailed Description

Function Documentation

◆ tool_mobile_create_app_download_url()

tool_mobile_create_app_download_url ( )

Generate the app download url to promote moodle mobile.

Return values
moodle_url|voidApp download moodle_url object or return if setuplink is not set.

◆ tool_mobile_get_token()

tool_mobile_get_token ( $userid)

Return the user mobile app WebService access token.

Parameters
int$useridthe user to return the token from
Return values
stdClass|falsethe token or false if the token doesn't exists
Since
3.10

◆ tool_mobile_myprofile_navigation()

tool_mobile_myprofile_navigation ( \core_user\output\myprofile\tree $tree,
$user,
$iscurrentuser )

User profile page callback.

Used add a section about the moodle mobile app.

Parameters
core_user\output\myprofile\tree$treeMy profile tree where the setting will be added.
stdClass$userThe user object.
bool$iscurrentuserIs this the current user viewing
Return values
voidReturn if the mobile web services setting is disabled or if not the current user.

◆ tool_mobile_pre_processor_message_send()

tool_mobile_pre_processor_message_send ( $procname,
$data )

Callback to be able to change a message/notification data per processor.

Parameters
str$procnameprocessor name
stdClass$datamessage or notification data

◆ tool_mobile_user_has_token()

tool_mobile_user_has_token ( $userid)

Checks if the given user has a mobile token (has used recently the app).

Parameters
int$useridthe user to check
Return values
booltrue if the user has a token, false otherwise.

◆ xmldb_tool_mobile_upgrade()

xmldb_tool_mobile_upgrade ( $oldversion)

Upgrade the plugin.

Parameters
int$oldversion
Return values
boolalways true

Variable Documentation

◆ $callbacks

$callbacks
Initial value:
= [
[
'hook' => core\hook\output\before_standard_head_html_generation::class,
'callback' => [\tool_mobile\hook_callbacks::class, 'before_standard_head_html_generation'],
],
[
'hook' => core\hook\output\before_standard_footer_html_generation::class,
'callback' => [\tool_mobile\hook_callbacks::class, 'before_standard_footer_html_generation'],
'priority' => 0,
],
[
'hook' => core_user\hook\after_login_completed::class,
'callback' => [\tool_mobile\hook_callbacks::class, 'after_login_completed'],
'priority' => 500,
],
[
'hook' => tool_mfa\hook\after_user_passed_mfa::class,
'callback' => 'tool_mobile\local\hooks\user\after_user_passed_mfa::callback',
'priority' => 500,
],
[
'hook' => core\hook\output\before_http_headers::class,
'callback' => [\tool_mobile\local\hooks\output\before_http_headers::class, 'callback'],
],
]

◆ $definitions

$definitions
Initial value:
= array(
'plugininfo' => array(
'mode' => cache_store::MODE_APPLICATION,
'simplekeys' => true,
'staticacceleration' => true,
'staticaccelerationsize' => 1
),
'subscriptiondata' => array(
'mode' => cache_store::MODE_SESSION,
'simplekeys' => true,
'simpledata' => false,
),
)

◆ dependencies

$plugin dependencies
Initial value:
= [
'webservice_rest' => 2024041600,
]