upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-06-14 03:02:01 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

chore: Update docblock for getMentions method

Browse source 
Updated the docblock for the getMentions method to clarify its return value and sorting behavior.

Signed-off-by: Josh <josh.t.richards@gmail.com>
This commit is contained in:
Josh 2025-11-03 10:48:43 -05:00 committed by GitHub
parent f98cabc20f
commit 2d6ac6ad74
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
lib/public/Comments/IComment.php
View file

@ -121,13 +121,19 @@ interface IComment {
public function setMessage($message, $maxLength = self::MAX_MESSAGE_LENGTH);
/**
* returns an array containing mentions that are included in the comment
* Returns all mentions from the comment message.
*
* @return array each mention provides a 'type' and an 'id', see example below
* Parses the message, returning an array of mentions.
* Mentions are sorted by descending length of their id before being returned.
*
* Supported mention types: 'user', 'group', 'team', 'guest', 'email', 'federated_group', 'federated_team', 'federated_user'.
*
* @return array Each mention is an associative array with 'type' and 'id' keys, sorted by descending length.
* @psalm-return list<array{type: 'guest'|'email'|'federated_group'|'group'|'federated_team'|'team'|'federated_user'|'user', id: non-empty-lowercase-string}>
* @since 30.0.2 Type 'email' is supported
* @since 29.0.0 Types 'federated_group', 'federated_team', 'team' and 'federated_user' are supported
* @since 23.0.0 Type 'group' is supported
* @since 21.0.1 Sort returned results by
* @since 17.0.0 Type 'guest' is supported
* @since 11.0.0
*/