ILIAS\UI\examples\Image\Standard Namespace Reference

Functions
	base ()
	decorative ()
	with_additional_on_load_code ()
	with_signal_action ()
	with_string_action ()

Function Documentation

base()

ILIAS\UI\examples\Image\Standard\base

(

)

---

description: > Base example for rendering an Image.

expected output: > ILIAS shows a rendered image with a grey background. While changing the size of the browser window the

image won't decrease in size. If the element gets analyzed a text entry for "alt" is shown within the HTML.

Definition at line 33 of file base.php.

{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Generating and rendering the image
    $image = $f->image()->standard(
        "assets/ui-examples/images/Image/HeaderIconLarge.svg",
        "Thumbnail Example"
    );
    $html = $renderer->render($image);
 
    return $html;
}

References ILIAS\UI\examples\Layout\Page\Mail\$DIC, Vendor\Package\$f, and $renderer.

decorative()

ILIAS\UI\examples\Image\Standard\decorative

(

)

---

description: > Base example for rendering an Image with only decorative purpose (see accessibility rules in images)

expected output: > ILIAS shows a rendered image with a grey background. While changing the size of the browser window the

image won't decrease in size. If the element gets analyzed no text entry for "alt" is shown within the HTML.

Definition at line 34 of file decorative.php.

{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Generating and rendering the image
    $image = $f->image()->standard(
        "assets/ui-examples/images/Image/HeaderIconLarge.svg",
        ""
    );
    $html = $renderer->render($image);
 
    return $html;
}

References $DIC, Vendor\Package\$f, and $renderer.

with_additional_on_load_code()

ILIAS\UI\examples\Image\Standard\with_additional_on_load_code

(

)

---

description: > Example showing how JS-Code can be attached to images.

expected output: >

ILIAS shows an image. An alert pops up as soon as the image is clicked.

Definition at line 32 of file with_additional_on_load_code.php.

{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Generating and rendering the image and modal
    $image = $f->image()->standard(
        "assets/ui-examples/images/Image/HeaderIconLarge.svg",
        "Thumbnail Example"
    )->withAction("#")
     ->withAdditionalOnLoadCode(function ($id) {
         return "$('#$id').click(function(e) { e.preventDefault(); alert('Image Onload Code')});";
     });
 
    $html = $renderer->render($image);
 
    return $html;
}

References $DIC, Vendor\Package\$f, $id, and $renderer.

with_signal_action()

ILIAS\UI\examples\Image\Standard\with_signal_action

(

)

---

description: > Example for rendering an Image with a signal as action

expected output: >

Clicking onto the rendered image will open a modal.

Definition at line 32 of file with_signal_action.php.

{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Generating and rendering the image and modal
    $image_in_modal = $f->image()->standard(
        "assets/ui-examples/images/Image/mountains.jpg",
        ""
    );
    $page = $f->modal()->lightboxImagePage($image_in_modal, "Nice view");
    $modal = $f->modal()->lightbox($page);
 
    $image = $f->image()->standard(
        "assets/ui-examples/images/Image/HeaderIconLarge.svg",
        "Thumbnail Example"
    )->withAction($modal->getShowSignal());
 
    $html = $renderer->render([$image, $modal]);
 
    return $html;
}

References $DIC, Vendor\Package\$f, and $renderer.

with_string_action()

ILIAS\UI\examples\Image\Standard\with_string_action

(

)

---

description: > Example for rendering an Image with a string as action

expected output: >

Clicking onto the rendered image will open a new tab to ilias.de.

Definition at line 32 of file with_string_action.php.

{
    //Loading factories
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    //Generating and rendering the image and modal
    $image = $f->image()->standard(
        "assets/ui-examples/images/Image/HeaderIconLarge.svg",
        "Thumbnail Example"
    )->withAction("https://www.ilias.de");
 
    $html = $renderer->render($image);
 
    return $html;
}

References $DIC, Vendor\Package\$f, and $renderer.