interface.ilCtrlInterface.php

Go to the documentation of this file.

<?php

interface ilCtrlInterface
{
    public const CMD_POST = 'post';

    public const PARAM_CSRF_TOKEN = 'rtoken';
    public const PARAM_CID_PATH = 'cmdNode';
    public const PARAM_REDIRECT = 'redirectSource';
    public const PARAM_BASE_CLASS = 'baseClass';
    public const PARAM_CMD_CLASS = 'cmdClass';
    public const PARAM_CMD_MODE = 'cmdMode';
    public const PARAM_CMD_FALLBACK = 'fallbackCmd';
    public const PARAM_CMD = 'cmd';

    public const PROTECTED_PARAMETERS = [
        self::PARAM_BASE_CLASS,
        self::PARAM_CMD_CLASS,
        self::PARAM_CID_PATH,
        self::PARAM_CSRF_TOKEN,
    ];

    public const CMD_MODE_PROCESS = 'execComm';
    public const CMD_MODE_ASYNC = 'asynch';
    public const CMD_MODE_HTML = 'getHtml';

    public function callBaseClass(string $a_base_class = null): void;

    public function forwardCommand(object $a_gui_object);

    public function getHTML(object $a_gui_object, array $a_parameters = null): string;

    public function getCmd(string $fallback_command = null): ?string;

    public function setCmd(?string $a_cmd): void;

    public function getCmdClass(): ?string;

    public function setCmdClass($a_cmd_class): void;

    public function getNextClass($a_gui_class = null): ?string;

    public function saveParameter(object $a_gui_obj, $a_parameter): void;

    public function saveParameterByClass(string $a_class, $a_parameter): void;

    public function setParameter(object $a_gui_obj, string $a_parameter, $a_value): void;

    public function setParameterByClass(string $a_class, string $a_parameter, $a_value): void;

    public function getParameterArray(object $a_gui_obj): array;

    public function getParameterArrayByClass(string $a_class): array;

    public function clearParameters(object $a_gui_obj): void;

    public function clearParametersByClass(string $a_class): void;

    public function clearParameterByClass(string $a_class, string $a_parameter): void;

    public function getLinkTarget(
        object $a_gui_obj,
        string $a_cmd = null,
        string $a_anchor = null,
        bool $is_async = false,
        bool $has_xml_style = false
    ): string;

    public function getLinkTargetByClass(
        $a_class,
        string $a_cmd = null,
        string $a_anchor = null,
        bool $is_async = false,
        bool $has_xml_style = false
    ): string;

    public function getFormAction(
        object $a_gui_obj,
        string $a_fallback_cmd = null,
        string $a_anchor = null,
        bool $is_async = false,
        bool $has_xml_style = false
    ): string;

    public function getFormActionByClass(
        $a_class,
        string $a_fallback_cmd = null,
        string $a_anchor = null,
        bool $is_async = false,
        bool $has_xml_style = false
    ): string;

    public function redirect(
        object $a_gui_obj,
        string $a_cmd = null,
        string $a_anchor = null,
        bool $is_async = false
    ): void;

    public function redirectByClass(
        $a_class,
        string $a_cmd = null,
        string $a_anchor = null,
        bool $is_async = false
    ): void;

    public function redirectToURL(string $target_url): void;

    public function setContextObject(int $obj_id, string $obj_type): void;

    public function getContextObjId(): ?int;

    public function getContextObjType(): ?string;

    public function getCallHistory(): array;

    public function lookupClassPath(string $a_class): string;

    public function lookupOriginalClassName(string $a_class): ?string;

    public function getClassForClasspath(string $a_class_path): string;

    public function setTargetScript(string $a_target_script): void;

    public function isAsynch(): bool;

    public function setReturn(object $a_gui_obj, string $a_cmd = null): void;

    public function setReturnByClass(string $a_class, string $a_cmd = null): void;

    public function getParentReturn(object $a_gui_obj): ?string;

    public function getParentReturnByClass(string $a_class): ?string;

    public function returnToParent(object $a_gui_obj, string $a_anchor = null): void;

    public function getRedirectSource(): ?string;

    public function insertCtrlCalls($a_parent, $a_child, string $a_comp_prefix): void;

    public function checkCurrentPathForClass(string $gui_class): bool;

    public function getCurrentClassPath(): array;

    public function attachObserver(ilCtrlObserver $observer, ilCtrlEvent $event = ilCtrlEvent::ALL): void;

    public function detachObserver(ilCtrlObserver $observer, ilCtrlEvent $event = ilCtrlEvent::ALL): void;
}