Renderer.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\Implementation\Component\Layout\Page;
 
use ILIAS\UI\Implementation\Render\AbstractComponentRenderer;
use ILIAS\UI\Renderer as RendererInterface;
use ILIAS\UI\Component;
use ilGlobalPageTemplate;
use ILIAS\UI\Implementation\Render\Template;
use ILIAS\UI\Implementation\Render\ResourceRegistry;
use iljQueryUtil;
 
class Renderer extends AbstractComponentRenderer
{
    public const string COOKIE_NAME_SLATES_ENGAGED = 'il_mb_slates';
 
    public function render(Component\Component $component, RendererInterface $default_renderer): string
    {
        if ($component instanceof Component\Layout\Page\Standard) {
            return $this->renderStandardPage($component, $default_renderer);
        } elseif ($component instanceof Mail) {
            return $this->renderMailPage($component, $default_renderer);
        }
 
        $this->cannotHandleComponent($component);
    }
 
    protected function renderStandardPage(
        Component\Layout\Page\Standard $component,
        RendererInterface $default_renderer
    ): string {
        $tpl = $this->getTemplate("tpl.standardpage.html", true, true);
 
        $tpl->setVariable('FAVICON_PATH', $component->getFaviconPath());
 
        $id = $this->bindJavaScript($component);
        $tpl->setVariable("ID", $id);
 
        if ($component->hasOverlay()) {
            $tpl->setVariable('OVERLAY', $default_renderer->render($component->getOverlay()));
        }
        if ($component->hasMetabar()) {
            $tpl->setVariable('METABAR', $default_renderer->render($component->getMetabar()));
        }
        if ($component->hasMainbar()) {
            $tpl->setVariable('MAINBAR', $default_renderer->render($component->getMainbar()));
            // There is a roadmap entry for this.
            $slates_cookie = $_COOKIE[self::COOKIE_NAME_SLATES_ENGAGED] ?? '';
            if ($slates_cookie && json_decode($slates_cookie, true)['engaged']) {
                $tpl->touchBlock('slates_engaged');
            }
        }
        if ($component->hasModeInfo()) {
            $tpl->setVariable('MODEINFO', $default_renderer->render($component->getModeInfo()));
        }
        if ($component->hasSystemInfos()) {
            $tpl->setVariable('SYSTEMINFOS', $default_renderer->render($component->getSystemInfos()));
        }
 
        $breadcrumbs = $component->getBreadcrumbs();
        if ($breadcrumbs && $breadcrumbs->getItems()) {
            $tpl->setVariable('BREADCRUMBS', $default_renderer->render($breadcrumbs));
 
            $dropdown = $this->convertBreadcrumbsToDropdownLocator($breadcrumbs);
            $tpl->setVariable('HEADER_BREADCRUMBS', $default_renderer->render($dropdown));
        }
        if ($component->hasLogo()) {
            $tpl->setVariable('LOGO', $default_renderer->render($component->getLogo()));
        }
        if ($component->hasResponsiveLogo()) {
            $tpl->setVariable('RESPONSIVE_LOGO', $default_renderer->render($component->getResponsiveLogo()));
        } elseif ($component->hasLogo()) {
            $tpl->setVariable('RESPONSIVE_LOGO', $default_renderer->render($component->getLogo()));
        }
 
        $tpl->setVariable("TITLE", $component->getTitle());
        $tpl->setVariable("SHORT_TITLE", $component->getShortTitle());
        $tpl->setVariable("VIEW_TITLE", $component->getViewTitle());
        $tpl->setVariable("LANGUAGE", $this->getLangKey());
        $tpl->setVariable("TEXT_DIRECTION", $component->getTextDirection());
        $tpl->setVariable('CONTENT', $default_renderer->render($component->getContent()));
 
        if ($component->hasFooter()) {
            $tpl->setVariable('FOOTER', $default_renderer->render($component->getFooter()));
        }
 
        if ($component->getWithHeaders()) {
            $tpl = $this->setHeaderVars($tpl, $component->getIsUIDemo());
        }
 
        $tpl->setVariable('META_DATA', $this->getDataFactory()->htmlMetadata()->collection(
            $component->getMetaData()
        )->toHtml());
 
        return $tpl->get();
    }
 
    protected function renderMailPage(
        Mail $component,
        RendererInterface $default_renderer
    ): string {
 
        $tpl = $this->getTemplate('tpl.mailpage.html', true, true);
 
        $tpl->setVariable('LOGO_SRC', $component->getLogoURL());
        $tpl->setVariable('INSTALLATION_TITLE', $component->getInstallationTitle());
        $tpl->setVariable('CONTENT', $default_renderer->render($component->getContent()));
        $tpl->setVariable('FOOTER_URL', $default_renderer->render($this->getUIFactory()->link()->standard($component->getFooterURL()->getLabel(), $component->getFooterURL()->getURL()->getBaseURI())));
        $tpl->setVariable('CSS_CONTENT', file_get_contents($component->getStyleSheetPath()) ?: '');
 
        return $tpl->get();
    }
 
    protected function convertBreadcrumbsToDropdownLocator(
        Component\Breadcrumbs\Breadcrumbs $breadcrumbs
    ): Component\Dropdown\Dropdown {
        $f = $this->getUIFactory();
        $buttons = [];
        $items = array_reverse($breadcrumbs->getItems());
        $current = array_shift($items);
        foreach ($items as $item) {
            $button = $f->button()->shy(
                $item->getLabel(),
                $item->getAction()
            );
            $buttons[] = $button;
        }
        return $f->dropdown()->standard($buttons)->withLabel($current->getLabel());
    }
 
    protected function setHeaderVars(Template $tpl, bool $for_ui_demo = false): Template
    {
        global $DIC;
        $il_tpl = $DIC["tpl"] ?? null;
 
        $js_files = [];
        $js_inline = [];
        $css_files = [];
        $css_inline = [];
 
        if ($il_tpl instanceof ilGlobalPageTemplate) {
            $layout = $DIC->globalScreen()->layout();
            foreach ($layout->meta()->getJs()->getItemsInOrderOfDelivery() as $js) {
                $js_files[] = $js->getContent();
            }
            foreach ($layout->meta()->getCss()->getItemsInOrderOfDelivery() as $css) {
                $css_files[] = ['file' => $css->getContent(), 'media' => $css->getMedia()];
            }
            foreach ($layout->meta()->getInlineCss()->getItemsInOrderOfDelivery() as $inline_css) {
                $css_inline[] = $inline_css->getContent();
            }
            foreach ($layout->meta()->getOnloadCode()->getItemsInOrderOfDelivery() as $on_load_code) {
                $js_inline[] = $on_load_code->getContent();
            }
        }
 
        if ($for_ui_demo) {
            $additional_js_files = [
                iljQueryUtil::getLocaljQueryPath(),
                'assets/js/Basic.js',
                './assets/js/jquery.js',
                './assets/js/jquery-migrate.min.js',
            ];
 
            array_unshift($js_files, ...$additional_js_files);
 
            $css_files[] = ['file' => './assets/css/delos.css'];
        }
 
        foreach ($js_files as $js_file) {
            $tpl->setCurrentBlock("js_file");
            $tpl->setVariable("JS_FILE", $js_file);
            $tpl->parseCurrentBlock();
        }
        foreach ($css_files as $css_file) {
            $tpl->setCurrentBlock("css_file");
            $tpl->setVariable("CSS_FILE", $css_file['file']);
            $tpl->parseCurrentBlock();
        }
 
        $tpl->setVariable("CSS_INLINE", implode(PHP_EOL, $css_inline));
        $tpl->setVariable("OLCODE", implode(PHP_EOL, $js_inline));
 
        return $tpl;
    }
 
    public function registerResources(ResourceRegistry $registry): void
    {
        parent::registerResources($registry);
        $registry->register('assets/js/stdpage.js');
    }
}