Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_message\helper Class Reference

Helper class for the message area. More...

Static Public Member Functions

static create_contact ($contact, $prefix='')
 Helper function for creating a contact object.
 
static create_messages ()
 
static format_conversation_messages (int $userid, int $convid, array $messages)
 Helper function to return a conversation messages with the involved members (only the ones who have sent any of these messages).
 
static get_conversation_hash (array $userids)
 Returns the conversation hash between users for easy look-ups in the DB.
 
static get_conversation_messages (int $userid, int $convid, int $timedeleted=0, int $limitfrom=0, int $limitnum=0, string $sort='timecreated ASC', int $timefrom=0, int $timeto=0)
 Helper function to retrieve conversation messages.
 
static get_conversations_legacy_formatter ()
 
static get_last_message_time_created_cache_key (int $convid)
 Returns the cache key for the time created value of the last message of this conversation.
 
static get_member_info (int $referenceuserid, array $userids, bool $includecontactrequests=false, bool $includeprivacyinfo=false)
 Returns conversation member info for the supplied users, relative to the supplied referenceuserid.
 
static get_messages ()
 
static get_providers_preferences ($providers, $userid)
 Get providers preferences.
 
static is_online ($lastaccess)
 Helper function for checking the time meets the 'online' condition.
 
static legacy_messages_exist ($userid)
 Checks if legacy messages exist for a given user.
 
static messageuser_link_params (int $useridto)
 Returns the attributes to place on the message user button.
 
static messageuser_requirejs ()
 Requires the JS libraries for the message user button.
 
static prevent_unclosed_html_tags (string $message, bool $removebody=false)
 Prevent unclosed HTML elements in a message.
 
static render_messaging_widget (bool $isdrawer, int $sendtouser=null, int $conversationid=null, string $view=null)
 Renders the messaging widget.
 
static search_get_user_details (\stdClass $user, array $userfields=[])
 Returns user details for a user, if they are visible to the current user in the message search.
 
static show_online_status ($user)
 Helper function for checking if we should show the user's online status.
 
static togglecontact_link_params ($user, $iscontact=false, bool $displaytextlabel=true)
 Returns the attributes to place on a contact button.
 
static togglecontact_requirejs ()
 Requires the JS libraries for the toggle contact button.
 

Detailed Description

Helper class for the message area.

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

Member Function Documentation

◆ create_contact()

static core_message\helper::create_contact ( $contact,
$prefix = '' )
static

Helper function for creating a contact object.

Parameters
stdClass$contact
string$prefix
Return values
stdClass

◆ create_messages()

static core_message\helper::create_messages ( )
static
Deprecated
since 3.6

◆ format_conversation_messages()

static core_message\helper::format_conversation_messages ( int $userid,
int $convid,
array $messages )
static

Helper function to return a conversation messages with the involved members (only the ones who have sent any of these messages).

Parameters
int$useridThe current userid.
int$convidThe conversation id.
array$messagesThe formated array messages.
Return values
arrayA conversation array with the messages and the involved members.

◆ get_conversation_hash()

static core_message\helper::get_conversation_hash ( array $userids)
static

Returns the conversation hash between users for easy look-ups in the DB.

Parameters
array$userids
Return values
string

◆ get_conversation_messages()

static core_message\helper::get_conversation_messages ( int $userid,
int $convid,
int $timedeleted = 0,
int $limitfrom = 0,
int $limitnum = 0,
string $sort = 'timecreated ASC',
int $timefrom = 0,
int $timeto = 0 )
static

Helper function to retrieve conversation messages.

Parameters
int$useridThe current user.
int$convidThe conversation identifier.
int$timedeletedThe time the message was deleted
int$limitfromReturn a subset of records, starting at this point (optional).
int$limitnumReturn a subset comprising this many records in total (optional, required if $limitfrom is set).
string$sortThe column name to order by including optionally direction.
int$timefromThe time from the message being sent.
int$timetoThe time up until the message being sent.
Return values
arrayof messages

◆ get_conversations_legacy_formatter()

static core_message\helper::get_conversations_legacy_formatter ( )
static
Deprecated
since 3.6

◆ get_last_message_time_created_cache_key()

static core_message\helper::get_last_message_time_created_cache_key ( int $convid)
static

Returns the cache key for the time created value of the last message of this conversation.

Parameters
int$convidThe conversation identifier.
Return values
stringThe key.

◆ get_member_info()

static core_message\helper::get_member_info ( int $referenceuserid,
array $userids,
bool $includecontactrequests = false,
bool $includeprivacyinfo = false )
static

Returns conversation member info for the supplied users, relative to the supplied referenceuserid.

This is the basic structure used when returning members, and includes information about the relationship between each member and the referenceuser, such as a whether the referenceuser has marked the member as a contact, or has blocked them.

Parameters
int$referenceuseridthe id of the user which check contact and blocked status.
array$userids
bool$includecontactrequestsDo we want to include contact requests with this data?
bool$includeprivacyinfoDo we want to include whether the user can message another, and if the user requires a contact.
Return values
arraythe array of objects containing member info, indexed by userid.
Exceptions
coding_exception
dml_exception

◆ get_messages()

static core_message\helper::get_messages ( )
static
Deprecated
since 3.6

◆ get_providers_preferences()

static core_message\helper::get_providers_preferences ( $providers,
$userid )
static

Get providers preferences.

Parameters
array$providers
int$userid
Return values
stdClass

◆ is_online()

static core_message\helper::is_online ( $lastaccess)
static

Helper function for checking the time meets the 'online' condition.

Parameters
int$lastaccess
Return values
boolean

◆ legacy_messages_exist()

static core_message\helper::legacy_messages_exist ( $userid)
static

Checks if legacy messages exist for a given user.

Parameters
int$userid
Return values
bool

◆ messageuser_link_params()

static core_message\helper::messageuser_link_params ( int $useridto)
static

Returns the attributes to place on the message user button.

Parameters
int$useridto
Return values
array

◆ messageuser_requirejs()

static core_message\helper::messageuser_requirejs ( )
static

Requires the JS libraries for the message user button.

Return values
void

◆ prevent_unclosed_html_tags()

static core_message\helper::prevent_unclosed_html_tags ( string $message,
bool $removebody = false )
static

Prevent unclosed HTML elements in a message.

Parameters
string$messageThe html message.
bool$removebodyTrue if we want to remove tag body.
Return values
stringThe html properly structured.

◆ render_messaging_widget()

static core_message\helper::render_messaging_widget ( bool $isdrawer,
int $sendtouser = null,
int $conversationid = null,
string $view = null )
static

Renders the messaging widget.

Parameters
bool$isdrawerAre we are rendering the drawer or is this on a full page?
int | null$sendtouserThe ID of the user we want to send a message to
int | null$conversationidThe ID of the conversation we want to load
string | null$viewThe first view to load in the message widget
Return values
stringThe HTML.

◆ search_get_user_details()

static core_message\helper::search_get_user_details ( \stdClass $user,
array $userfields = [] )
static

Returns user details for a user, if they are visible to the current user in the message search.

This method checks the visibility of a user specifically for the purpose of inclusion in the message search results. Visibility depends on the site-wide messaging setting 'messagingallusers': If enabled, visibility depends only on the core notion of visibility; a visible site or course profile. If disabled, visibility requires that the user be sharing a course with the searching user, and have a visible profile there. The current user is always returned.

You can use the $userfields parameter to reduce the amount of a user record that is required by the method. The minimum user fields are:

  • id
  • deleted
  • all potential fullname fields
Parameters
stdClass$user
array$userfieldsAn array of userfields to be returned, the values must be a subset of user_get_default_fields (optional)
Return values
arraythe array of userdetails, if visible, or an empty array otherwise.

◆ show_online_status()

static core_message\helper::show_online_status ( $user)
static

Helper function for checking if we should show the user's online status.

Parameters
stdClass$user
Return values
boolean

◆ togglecontact_link_params()

static core_message\helper::togglecontact_link_params ( $user,
$iscontact = false,
bool $displaytextlabel = true )
static

Returns the attributes to place on a contact button.

Parameters
object$userUser object.
bool$iscontact
bool$displaytextlabelInstructs whether to display a text label.
Return values
array

◆ togglecontact_requirejs()

static core_message\helper::togglecontact_requirejs ( )
static

Requires the JS libraries for the toggle contact button.

Return values
void

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