Commentary
Table of Contents
- $onlineStatus : mixed
- $templateCommentaryBlock : mixed
- $textDomain : string
- Default text domain for translator.
- addComment() : string
- Add form for add comment.
- commentaryBlock() : string
- Display de commentary block.
- displayOneComment() : string
- Display a comment.
- displayStatusOnlinePlayer() : string
- Show if status of player (Online, Offline, Nearby).
- saveComment() : void
- Save comment to data base.
- commentaryFormUrl() : string
- Get a valid url to use in commentary form.
- getStatusMessages() : array<string|int, mixed>
- Get status messages of player.
- statusCommandSingleIcon() : string|null
Properties
$onlineStatus
protected
mixed
$onlineStatus
$templateCommentaryBlock
protected
mixed
$templateCommentaryBlock
$textDomain
Default text domain for translator.
protected
string
$textDomain
Methods
addComment()
Add form for add comment.
public
addComment(Environment $env, array<string|int, mixed> $commentary, string $textDomain) : string
Parameters
- $env : Environment
- $commentary : array<string|int, mixed>
-
Array with commentary data
- $textDomain : string
-
Text domain for translator
Return values
string —commentaryBlock()
Display de commentary block.
public
commentaryBlock(Environment $env, array<string|int, mixed> $commentary, string $textDomain[, string|null $paginationLinkUrl = null ][, bool $showPagination = true ][, bool $canAddComment = true ][, int $limit = 25 ]) : string
Parameters
- $env : Environment
- $commentary : array<string|int, mixed>
- $textDomain : string
- $paginationLinkUrl : string|null = null
- $showPagination : bool = true
- $canAddComment : bool = true
- $limit : int = 25
Return values
string —displayOneComment()
Display a comment.
public
displayOneComment(Environment $env, array<string|int, mixed> $comment, string $textDomain, array<string|int, mixed> $commentary) : string
Parameters
- $env : Environment
- $comment : array<string|int, mixed>
- $textDomain : string
- $commentary : array<string|int, mixed>
Return values
string —displayStatusOnlinePlayer()
Show if status of player (Online, Offline, Nearby).
public
displayStatusOnlinePlayer(array<string|int, mixed> $comment[, string $textDomain = null ]) : string
Parameters
- $comment : array<string|int, mixed>
- $textDomain : string = null
Return values
string —saveComment()
Save comment to data base.
public
saveComment() : void
Return values
void —commentaryFormUrl()
Get a valid url to use in commentary form.
protected
commentaryFormUrl() : string
Return values
string —getStatusMessages()
Get status messages of player.
protected
getStatusMessages(string $textDomain) : array<string|int, mixed>
Parameters
- $textDomain : string
Return values
array<string|int, mixed> —statusCommandSingleIcon()
private
statusCommandSingleIcon(array<string|int, mixed> $comment, array<string|int, mixed> $status) : string|null
Parameters
- $comment : array<string|int, mixed>
- $status : array<string|int, mixed>