interface.ilGlobalTemplateInterface.php

Go to the documentation of this file.

<?php

interface ilGlobalTemplateInterface
{
    public const MESSAGE_TYPE_FAILURE = 'failure';
    public const MESSAGE_TYPE_SUCCESS = "success";
    public const MESSAGE_TYPE_QUESTION = "question";
    public const MESSAGE_TYPE_INFO = "info";

    public const MESSAGE_TYPES = [
        self::MESSAGE_TYPE_FAILURE,
        self::MESSAGE_TYPE_INFO,
        self::MESSAGE_TYPE_SUCCESS,
        self::MESSAGE_TYPE_QUESTION,
    ];

    public const DEFAULT_BLOCK = 'DEFAULT';

    public function hideFooter(): void;

    public function setOnScreenMessage(string $type, string $a_txt, bool $a_keep = false): void;

    public function addJavaScript(string $a_js_file, bool $a_add_version_parameter = true, int $a_batch = 2): void;

    public function addOnLoadCode(string $a_code, int $a_batch = 2): void;

    public function getOnLoadCodeForAsynch(): string;

    public function resetJavascript(): void;

    public function fillJavaScriptFiles(bool $a_force = false): void;

    public function addCss(string $a_css_file, string $media = "screen"): void;

    public function addInlineCss(string $a_css, string $media = "screen"): void;

    public function setBodyClass(string $a_class = ""): void;

    public function loadStandardTemplate(): void;

    public function setTitle(string $a_title, bool $hidden = false): void;

    public function setDescription(string $a_descr): void;

    public function setTitleIcon(string $a_icon_path, string $a_icon_desc = ""): void;

    public function setAlertProperties(array $alerts): void;

    public function clearHeader(): void;

    public function setHeaderActionMenu(string $a_header): void;

    public function setHeaderPageTitle(string $a_title): void;

    public function setLocator(): void;

    public function setTabs(string $a_tabs_html): void;

    public function setSubTabs(string $a_tabs_html): void;

    public function setContent(string $a_html): void;

    public function setLeftContent(string $a_html): void;

    public function setLeftNavContent(string $a_content): void;

    public function setRightContent(string $a_html): void;

    public function setPageFormAction(string $a_action): void;

    public function setLoginTargetPar(string $a_val): void;

    public function getSpecial(
        string $part = self::DEFAULT_BLOCK,
        bool $add_error_mess = false,
        bool $handle_referer = false,
        bool $add_ilias_footer = false,
        bool $add_standard_elements = false,
        bool $a_main_menu = true,
        bool $a_tabs = true
    ): string;

    public function printToStdout(
        string $part = self::DEFAULT_BLOCK,
        bool $has_tabs = true,
        bool $skip_main_menu = false
    ): void;

    public function printToString(): string;

    public function setTreeFlatIcon(string $a_link, string $a_mode): void;

    public function addLightbox(string $a_html, string $a_id): void;

    public function addAdminPanelToolbar(
        ilToolbarGUI $toolbar,
        bool $is_bottom_panel = true,
        bool $has_arrow = false
    ): void;

    public function setPermanentLink(
        string $a_type,
        ?int $a_id,
        string $a_append = "",
        string $a_target = "",
        string $a_title = ""
    ): void;

    public function resetHeaderBlock(bool $a_reset_header_action = true): void;

    public function setFileUploadRefId(int $a_ref_id): void;

    public function get(string $part = self::DEFAULT_BLOCK): string;

    public function setVariable(string $variable, $value = ''): void;

    public function setCurrentBlock(string $part = self::DEFAULT_BLOCK): bool;

    public function parseCurrentBlock(string $block_name = self::DEFAULT_BLOCK): bool;

    public function touchBlock(string $block): bool;

    public function addBlockFile(string $var, string $block, string $template_name, string $in_module = null): bool;

    public function blockExists(string $block_name): bool;
}