MediaGallery
extends Component
in package
implements
ComponentV2
Media gallery components allow you to group images, videos or gifs into a gallery grid.
Tags
Table of Contents
Interfaces
- ComponentV2
- This interface is a contract for V2 components.
Constants
- TYPE_ACTION_ROW = 1
- TYPE_BUTTON = 2
- TYPE_CHANNEL_SELECT = 8
- TYPE_CONTAINER = 17
- TYPE_CONTENT_INVENTORY_ENTRY = 16
- TYPE_FILE = 13
- TYPE_MEDIA_GALLERY = 12
- TYPE_MENTIONABLE_SELECT = 7
- TYPE_ROLE_SELECT = 6
- TYPE_SECTION = 9
- TYPE_SELECT_MENU = 3
- TYPE_SEPARATOR = 14
- TYPE_STRING_SELECT = 3
- TYPE_TEXT_DISPLAY = 10
- TYPE_TEXT_INPUT = 4
- TYPE_THUMBNAIL = 11
- TYPE_USER_SELECT = 5
Properties
- $items : array<string|int, MediaGalleryItem>
- Array of media gallery items.
Methods
- addItem() : $this
- Adds a media item to the gallery.
- getItems() : array<string|int, MediaGalleryItem>
- Returns all the media items in the gallery.
- jsonSerialize() : array<string|int, mixed>
- {@inheritDoc}
- new() : self
- Creates a new media gallery.
- generateUuid() : string
- Generates a UUID which can be used for component custom IDs.
Constants
TYPE_ACTION_ROW
public
mixed
TYPE_ACTION_ROW
= 1
TYPE_BUTTON
public
mixed
TYPE_BUTTON
= 2
TYPE_CHANNEL_SELECT
public
mixed
TYPE_CHANNEL_SELECT
= 8
TYPE_CONTAINER
public
mixed
TYPE_CONTAINER
= 17
TYPE_CONTENT_INVENTORY_ENTRY
public
mixed
TYPE_CONTENT_INVENTORY_ENTRY
= 16
TYPE_FILE
public
mixed
TYPE_FILE
= 13
TYPE_MEDIA_GALLERY
public
mixed
TYPE_MEDIA_GALLERY
= 12
TYPE_MENTIONABLE_SELECT
public
mixed
TYPE_MENTIONABLE_SELECT
= 7
TYPE_ROLE_SELECT
public
mixed
TYPE_ROLE_SELECT
= 6
TYPE_SECTION
public
mixed
TYPE_SECTION
= 9
TYPE_SELECT_MENU
Use Component::TYPE_STRING_SELECT
public
mixed
TYPE_SELECT_MENU
= 3
TYPE_SEPARATOR
public
mixed
TYPE_SEPARATOR
= 14
TYPE_STRING_SELECT
public
mixed
TYPE_STRING_SELECT
= 3
TYPE_TEXT_DISPLAY
public
mixed
TYPE_TEXT_DISPLAY
= 10
TYPE_TEXT_INPUT
public
mixed
TYPE_TEXT_INPUT
= 4
TYPE_THUMBNAIL
public
mixed
TYPE_THUMBNAIL
= 11
TYPE_USER_SELECT
public
mixed
TYPE_USER_SELECT
= 5
Properties
$items
Array of media gallery items.
private
array<string|int, MediaGalleryItem>
$items
= []
Methods
addItem()
Adds a media item to the gallery.
public
addItem(MediaGalleryItem|string $item[, string|null $description = null ][, bool $spoiler = false ]) : $this
Parameters
- $item : MediaGalleryItem|string
-
Media gallery item or URL of the media item.
- $description : string|null = null
-
Description for the media item (max 1024 characters).
- $spoiler : bool = false
-
Whether the media item is a spoiler.
Tags
Return values
$thisgetItems()
Returns all the media items in the gallery.
public
getItems() : array<string|int, MediaGalleryItem>
Return values
array<string|int, MediaGalleryItem>jsonSerialize()
{@inheritDoc}
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>new()
Creates a new media gallery.
public
static new() : self
Return values
selfgenerateUuid()
Generates a UUID which can be used for component custom IDs.
protected
static generateUuid() : string