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

Namespaces

namespace  message_popup
  
 
namespace  message_popup\output
  
 
namespace  message_popup\privacy
  
 

Classes

class  behat_message_popup
 Message popup steps definitions. More...
 
class  message_popup\api
 Class used to return information to display for the message popup. More...
 
class  message_popup\output\popup_notification
 Class to prepare a popup notification for display. More...
 
class  message_popup\privacy\provider
 Privacy Subsystem for message_popup implementing null_provider. More...
 
class  message_popup_external
 Message external functions. More...
 

Functions

 message_popup_render_navbar_output (\renderer_base $renderer)
 Renders the popup.
 
 xmldb_message_popup_install ()
 Install the popup message processor.
 
 xmldb_message_popup_upgrade ($oldversion)
 Upgrade code for the popup message processor.
 

Variables

 $functions
 
 $plugin = 2023041800
 
$plugin component = 'message_popup'
 
$plugin version = 2023042400
 

Detailed Description

Function Documentation

◆ message_popup_render_navbar_output()

message_popup_render_navbar_output ( \renderer_base $renderer)

Renders the popup.

Parameters
renderer_base$renderer
Return values
stringThe HTML

◆ xmldb_message_popup_upgrade()

xmldb_message_popup_upgrade ( $oldversion)

Upgrade code for the popup message processor.

Parameters
int$oldversionThe version that we are upgrading from

Variable Documentation

◆ $functions

$functions
Initial value:
= array(
'message_popup_get_popup_notifications' => array(
'classname' => 'message_popup_external',
'methodname' => 'get_popup_notifications',
'classpath' => 'message/output/popup/externallib.php',
'description' => 'Retrieve a list of popup notifications for a user',
'type' => 'read',
'ajax' => true,
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
'message_popup_get_unread_popup_notification_count' => array(
'classname' => 'message_popup_external',
'methodname' => 'get_unread_popup_notification_count',
'classpath' => 'message/output/popup/externallib.php',
'description' => 'Retrieve the count of unread popup notifications for a given user',
'type' => 'read',
'ajax' => true,
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
'readonlysession' => true,
),
)
const MOODLE_OFFICIAL_MOBILE_SERVICE
Moodle mobile app service name.
Definition moodlelib.php:530