ILIAS  trunk Revision v5.2.0beta1-34132-g2d4d73d4a0
ILIAS\UI\Implementation\Component\Modal\LightboxImagePage Class Reference

Class LightboxImagePage. More...

+ Inheritance diagram for ILIAS\UI\Implementation\Component\Modal\LightboxImagePage:
+ Collaboration diagram for ILIAS\UI\Implementation\Component\Modal\LightboxImagePage:

Public Member Functions

 __construct (Image $image, string $title, string $description='')
 
 getTitle ()
 Get the title of this page, displayed as title in the lightbox modal. More...
 
 getDescription ()
 Get the description of this page, displayed along with the media item. More...
 
 getComponent ()
 Get the component representing the media item to be displayed in the modals content section, e.g.an image. More...
 

Protected Attributes

Image $image
 
string $title
 
string $description
 

Detailed Description

Class LightboxImagePage.

Used to display an image in a lightbox page inside a lightbox modal. If no description is provided, the alt tag of the image is substituted.

Author
Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 36 of file LightboxImagePage.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\UI\Implementation\Component\Modal\LightboxImagePage::__construct ( Image  $image,
string  $title,
string  $description = '' 
)

Member Function Documentation

◆ getComponent()

ILIAS\UI\Implementation\Component\Modal\LightboxImagePage::getComponent ( )

Get the component representing the media item to be displayed in the modals content section, e.g.an image.

Implements ILIAS\UI\Component\Modal\LightboxPage.

Definition at line 70 of file LightboxImagePage.php.

References ILIAS\UI\Implementation\Component\Modal\LightboxImagePage\$image.

◆ getDescription()

ILIAS\UI\Implementation\Component\Modal\LightboxImagePage::getDescription ( )

Get the description of this page, displayed along with the media item.

Implements ILIAS\UI\Component\Modal\LightboxDescriptionEnabledPage.

Definition at line 62 of file LightboxImagePage.php.

62  : string
63  {
64  return $this->description ?: $this->image->getAlt();
65  }

◆ getTitle()

ILIAS\UI\Implementation\Component\Modal\LightboxImagePage::getTitle ( )

Get the title of this page, displayed as title in the lightbox modal.

Implements ILIAS\UI\Component\Modal\LightboxPage.

Definition at line 54 of file LightboxImagePage.php.

References ILIAS\UI\Implementation\Component\Modal\LightboxImagePage\$title.

54  : string
55  {
56  return $this->title;
57  }

Field Documentation

◆ $description

string ILIAS\UI\Implementation\Component\Modal\LightboxImagePage::$description
protected

◆ $image

Image ILIAS\UI\Implementation\Component\Modal\LightboxImagePage::$image
protected

◆ $title

string ILIAS\UI\Implementation\Component\Modal\LightboxImagePage::$title
protected

The documentation for this class was generated from the following file: