Gallery
extends Entity
in package
implements
JsonSerializable
This class contains a gallery, galleries are used to arrange files in a list or masonry layout and horizontal or vertical orientation. They can be embedded into segment pages and blog posts
Tags
Interfaces, Classes, Traits and Enums
- JsonSerializable
Table of Contents
- ORIENTATION_HORIZONTAL = 'horizontal'
- ORIENTATION_VERTICAL = 'vertical'
- TYPE_MASONRY = 'masonry'
- TYPE_SEQUENCE = 'sequence'
- $createdAt : DateTime
- $creatorId : int
- $description : string
- $id : int
- $lastUpdatedAt : DateTime
- $name : string
- $orientation : string
- $type : string
- $updatedById : int
- create() : void
- Creates the current artist
- format() : array<string, array<string, array<string, string|null>|string>|int|string>
- Formats the gallery into an array
- getCreator() : Artist|null
- Gets the creator of this gallery
- getFiles() : Iterator<string|int, GalleryFilePosition>
- Get all files in the gallery
- getUpdatedBy() : Artist|null
- Gets the artist that last updated this gallery
- jsonSerialize() : mixed
- update() : void
- Updates the current gallery
Constants
ORIENTATION_HORIZONTAL
public
string
ORIENTATION_HORIZONTAL
= 'horizontal'
Used to mark a gallery for horizontal orientation
Tags
ORIENTATION_VERTICAL
public
string
ORIENTATION_VERTICAL
= 'vertical'
Used to mark a gallery for vertical orientation
Tags
TYPE_MASONRY
public
string
TYPE_MASONRY
= 'masonry'
Used to mark a gallery for masonry layout
Tags
TYPE_SEQUENCE
public
string
TYPE_SEQUENCE
= 'sequence'
Used to mark a gallery for list or sequential layout
Tags
Properties
$createdAt
public
DateTime
$createdAt
The time the gallery was created
Tags
$creatorId
public
int
$creatorId
The ID of the artist that created the gallery
Tags
$description
public
string
$description
= ''
The description of the gallery. Currently ignored by the default theme. May contain HTML
Tags
$id
public
int
$id
Tags
$lastUpdatedAt
public
DateTime
$lastUpdatedAt
The time the gallery was last updated
Tags
$name
public
string
$name
The name of the gallery
Tags
$orientation
public
string
$orientation
= self::ORIENTATION_HORIZONTAL
The orientation of the gallery. The selected orientation should be respected in themes
Tags
$type
public
string
$type
= self::TYPE_SEQUENCE
The type or layout of the gallery. The selected layout should be respected in themes
Tags
$updatedById
public
int
$updatedById
The ID of the artist that last touched the gallery
Tags
Methods
create()
Creates the current artist
public
create() : void
Tags
Return values
void —format()
Formats the gallery into an array
public
format() : array<string, array<string, array<string, string|null>|string>|int|string>
Tags
Return values
array<string, array<string, array<string, string|null>|string>|int|string> —getCreator()
Gets the creator of this gallery
public
getCreator() : Artist|null
Tags
Return values
Artist|null —getFiles()
Get all files in the gallery
public
getFiles() : Iterator<string|int, GalleryFilePosition>
Tags
Return values
Iterator<string|int, GalleryFilePosition> —getUpdatedBy()
Gets the artist that last updated this gallery
public
getUpdatedBy() : Artist|null
Tags
Return values
Artist|null —jsonSerialize()
public
jsonSerialize() : mixed
Tags
Return values
mixed —update()
Updates the current gallery
public
update() : void