Class Mentions

This really is a pseudo class, I couldn't justify having instance of it while mentioning so I just made every method static

Package: SMF
Copyright: 2020 Simple Machines and individual contributors
License: BSD
Author: Simple Machines https://www.simplemachines.org
Located at Sources/Mentions.php

Methods summary
`public static array`	# `getMentionsByContent( string $content_type, integer $content_id, array $members = array() )` Returns mentions for a specific content Returns mentions for a specific content Parameters `$content_type` The content type `$content_id` The ID of the desired content `$members` Whether to limit to a specific sect of members Returns array An array of arrays containing info about each member mentioned
`public static`	# `insertMentions( string $content_type, integer $content_id, array $members, integer $id_member )` Inserts mentioned members Inserts mentioned members Parameters `$content_type` The content type `$content_id` The ID of the specified content `$members` An array of members who have been mentioned `$id_member` The ID of the member who mentioned them
`public static string`	# `getBody( string $body, array $members )` Gets appropriate mentions replaced in the body Gets appropriate mentions replaced in the body Parameters `$body` The text to look for mentions in `$members` An array of arrays containing info about members (each should have 'id' and 'member') Returns string The body with mentions replaced
`public static array`	# `getMentionedMembers( string $body )` Takes a piece of text and finds all the mentioned members in it Takes a piece of text and finds all the mentioned members in it Parameters `$body` The body to get mentions from Returns array An array of arrays containing members who were mentioned (each has 'id_member' and 'real_name')
`protected static array`	# `getPossibleMentions( string $body )` Parses a body in order to see if there are any mentions, returns possible mention names Parses a body in order to see if there are any mentions, returns possible mention names Names are tagged by "@" format in post, but they can contain any type of character up to 60 characters length. So we extract, starting from @ up to 60 characters in length (or if we encounter a line break) and make several combination of strings after splitting it by anything that's not a word and join by having the first word, first and second word, first, second and third word and so on and search every name. One potential problem with this is something like "@Admin Space" can match "Admin Space" as well as "Admin", so we sort by length in descending order. One disadvantage of this is that we can only match by one column, hence I've chosen real_name since it's the most obvious. If there's an @ symbol within the name, it is counted in the ongoing string and a new combination string is started from it as well in order to account for all the possibilities. This makes the @ symbol to not be required to be escaped Parameters `$body` The text to look for mentions in Returns array An array of names of members who have been mentioned

Properties summary
`protected static string`	`$char`	# `'@'`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class Mentions

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns