Documentation

DiscordEmbed
in package

Builds a Discord embed to represent an event.

Tags
author

Aberdeener

version
2.2.0
license

MIT

Table of Contents

Properties

$_author  : array<string|int, mixed>|null
$_color  : float|int|null
$_description  : string|null
$_fields  : array<string|int, mixed>|null
$_footer  : array<string|int, mixed>|null
$_image  : array<string|int, mixed>|null
$_thumbnail  : array<string|int, mixed>|null
$_title  : string|null
$_url  : string|null

Methods

addField()  : self
getAuthor()  : array<string|int, mixed>|null
getColor()  : int|null
getDescription()  : string|null
getFields()  : array<string|int, mixed>|null
getFooter()  : array<string|int, mixed>|null
getImage()  : array<string|int, mixed>|null
getThumbnail()  : array<string|int, mixed>|null
getTitle()  : string|null
getUrl()  : string|null
setAuthor()  : self
setColor()  : self
setDescription()  : self
setFooter()  : self
setImage()  : self
setThumbnail()  : self
setTitle()  : self
setUrl()  : self
toArray()  : array<string|int, mixed>

Properties

$_author

private array<string|int, mixed>|null $_author = \null

$_fields

private array<string|int, mixed>|null $_fields = \null

$_footer

private array<string|int, mixed>|null $_footer = \null

$_image

private array<string|int, mixed>|null $_image = \null

$_thumbnail

private array<string|int, mixed>|null $_thumbnail = \null

Methods

addField()

public addField(string $name, string $value[, bool $inline = false ]) : self
Parameters
$name : string
$value : string
$inline : bool = false
Return values
self

getAuthor()

public getAuthor() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getColor()

public getColor() : int|null
Return values
int|null

getDescription()

public getDescription() : string|null
Return values
string|null

getFields()

public getFields() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getFooter()

public getFooter() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getImage()

public getImage() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getThumbnail()

public getThumbnail() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getTitle()

public getTitle() : string|null
Return values
string|null

getUrl()

public getUrl() : string|null
Return values
string|null

setAuthor()

public setAuthor(string $name[, string|null $icon_url = null ][, string|null $url = null ]) : self
Parameters
$name : string
$icon_url : string|null = null
$url : string|null = null
Return values
self

setColor()

public setColor(mixed $color) : self
Parameters
$color : mixed
Return values
self

setDescription()

public setDescription(string $description) : self
Parameters
$description : string
Return values
self

setFooter()

public setFooter(string|null $footer_text[, string|null $footer_icon_url = null ]) : self
Parameters
$footer_text : string|null
$footer_icon_url : string|null = null
Return values
self

setImage()

public setImage(string $image_url) : self
Parameters
$image_url : string
Return values
self

setThumbnail()

public setThumbnail(string $thumbnail_url) : self
Parameters
$thumbnail_url : string
Return values
self

setTitle()

public setTitle(string|null $title) : self
Parameters
$title : string|null
Return values
self

setUrl()

public setUrl(string|null $url) : self
Parameters
$url : string|null
Return values
self

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results