From 2d6ac6ad742e76343c9d1696cacbca78c8ac1fe7 Mon Sep 17 00:00:00 2001 From: Josh Date: Mon, 3 Nov 2025 10:48:43 -0500 Subject: [PATCH] chore: Update docblock for getMentions method Updated the docblock for the getMentions method to clarify its return value and sorting behavior. Signed-off-by: Josh --- lib/public/Comments/IComment.php | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/lib/public/Comments/IComment.php b/lib/public/Comments/IComment.php index cdfcf188761..dfe3bacb1a6 100644 --- a/lib/public/Comments/IComment.php +++ b/lib/public/Comments/IComment.php @@ -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 * @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 */