ILIAS\UI\examples\Prompt\Standard Namespace Reference

Functions
	base ()
	form ()
	parameters ()

Function Documentation

base()

ILIAS\UI\examples\Prompt\Standard\base

(

)

---

description: > This example wraps a Message Box into a Prompt (State).

expected output: > A Message Box is rendered along with a Button triggering the Prompt. The action of the Message Box is without function. When clicking "Show Simple Prompt", a Prompt is shown, making controls on the original page inaccessible. The action of the Message Box is removed from the content and shown in

the button-section of the Prompt.

Definition at line 40 of file base.php.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $df = new \ILIAS\Data\Factory();
    $refinery = $DIC['refinery'];
 
    $here_uri = $df->uri($DIC->http()->request()->getUri()->__toString());
    $url_builder = new URLBuilder($here_uri);
 
    //The messagebox we are going to wrap into the prompt
    $message = $factory->messageBox()->success('some message box')
        ->withButtons([$factory->button()->standard('some Action', '#')]);
 
    //when expecting a state, we do not want to render other examples
    $example_namespace = ['prompt', 'endpoints'];
    list($url_builder, $endpointtoken) = $url_builder->acquireParameters($example_namespace, "endpoint");
    $url_builder = $url_builder->withParameter($endpointtoken, "true");
 
    //build the prompt
    $query_namespace = ['prompt', 'example0'];
    list($url_builder, $token) = $url_builder->acquireParameters($query_namespace, "show");
    $url_builder = $url_builder->withParameter($token, "true");
    $prompt = $factory->prompt()->standard($url_builder->buildURI());
 
    //build the endpoint returning the wrapped message
    $query = $DIC->http()->wrapper()->query();
    if ($query->has($token->getName())) {
        $response = $factory->prompt()->state()->show($message);
        echo($renderer->renderAsync($response));
        exit();
    }
 
    //a button to open the prompt:
    $show_button = $factory->button()->standard('Show Simple Prompt', $prompt->getShowSignal());
 
    if (!$query->has($endpointtoken->getName())) {
        return $renderer->render([
           $message,
           $prompt,
           $show_button
        ]);
    }
}

References $DIC, $message, ILIAS\UI\examples\Layout\Page\Standard\$refinery, $renderer, $response, $token, and exit.

form()

ILIAS\UI\examples\Prompt\Standard\form

(

)

---

description: > This shows a Form being used in a Prompt.

expected output: > Initially, there is but a button to open the Prompt. Clicking the button, a Prompt is shown with a required Text Input. Leave it blank and click 'Save', the Form's error messages should be shown. Enter any string and click 'Save' again; the error disappears, but the Prompt and Form are still shown.

Finally, enter the word 'close' and save again. The Prompt closes.

alternatively: $response = $response->withCloseModal(true);

Definition at line 39 of file form.php.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $df = new \ILIAS\Data\Factory();
    $refinery = $DIC['refinery'];
 
    $here_uri = $df->uri($DIC->http()->request()->getUri()->__toString());
    $url_builder = new URLBuilder($here_uri);
 
    //when expecting a state, we do not want to render other examples
    $example_namespace = ['prompt', 'endpoints'];
    list($url_builder, $endpointtoken) = $url_builder->acquireParameters($example_namespace, "endpoint");
    $url_builder = $url_builder->withParameter($endpointtoken, "true");
 
    //build the prompt
    $query_namespace = ['prompt', 'example2'];
    list($url_builder, $action_token) = $url_builder->acquireParameters($query_namespace, "action");
    $url_builder = $url_builder->withParameter($action_token, "form");
    $prompt = $factory->prompt()->standard($url_builder->buildURI());
 
    //fill the state according to (query-)parameters
    $query = $DIC->http()->wrapper()->query();
    if ($query->has($action_token->getName())
        && $query->has($action_token->getName())
        && $query->retrieve($action_token->getName(), $refinery->kindlyTo()->string()) === 'form'
    ) {
 
        //setup a form.
        $uri = $url_builder->buildURI()->__toString();
        $form = $factory->input()->container()->form()->standard(
            $uri,
            [
                $factory->input()->field()->text(
                    "Text Input",
                    "write 'close' to close the prompt."
                )->withRequired(true)
            ]
        );
 
        //set the response
        $response = $factory->prompt()->state()->show($form);
 
        $request = $DIC->http()->request();
        if ($request->getMethod() === 'POST') {
            $form = $form->withRequest($request);
            $data = $form->getData();
            if ($data !== null && reset($data) === 'close') {
                $response = $factory->prompt()->state()->close();
            } else {
                $response = $factory->prompt()->state()->show($form);
            }
        }
        $response = $response->withTitle('prompt form example');
        echo($renderer->renderAsync($response));
        exit();
    }
 
    if (!$query->has($endpointtoken->getName())) {
        $show_button = $factory->button()->standard('Show Prompt with Form', $prompt->getShowSignal());
        return $renderer->render([$prompt, $show_button]);
    }
}

References $data, $DIC, ILIAS\UI\examples\Layout\Page\Standard\$refinery, $renderer, $response, and exit.

parameters()

ILIAS\UI\examples\Prompt\Standard\parameters

(

)

---

description: > This shows how different states are being used in the same Prompt according to parameters, thus creating an 'internally navigational' Prompt. the additional buttons demonstrate the usage of JS within Prompts.

expected output: > Initially, there are three buttons to open the Prompt. The Prompt will display several links. Clicking a Link will display the

clicked number in the content, along with a "back"-Button.

Definition at line 39 of file parameters.php.

{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $df = new \ILIAS\Data\Factory();
    $refinery = $DIC['refinery'];
 
    $here_uri = $df->uri($DIC->http()->request()->getUri()->__toString());
    $url_builder = new URLBuilder($here_uri);
 
    //when expecting a state, we do not want to render other examples
    $example_namespace = ['prompt', 'endpoints'];
    list($url_builder, $endpointtoken) = $url_builder->acquireParameters($example_namespace, "endpoint");
    $url_builder = $url_builder->withParameter($endpointtoken, "true");
 
    //build a prompt
    $query_namespace = ['prompt', 'example1'];
    list($url_builder, $action_token, $amount_token) = $url_builder->acquireParameters($query_namespace, "action", "amount");
    $url_builder = $url_builder->withParameter($action_token, "showprompt");
 
    $default_uri = $url_builder->withParameter($amount_token, "1")->buildURI();
    $prompt = $factory->prompt()->standard($default_uri);
 
    //build some endpoint
    $query = $DIC->http()->wrapper()->query();
    $icon = $factory->symbol()->icon()->standard('someExample', 'Example');
    $item = $icon;
    $links = [];
 
    if ($query->has($action_token->getName())) {
        $action = $query->retrieve($action_token->getName(), $refinery->kindlyTo()->string());
        $amount = $query->retrieve($amount_token->getName(), $refinery->kindlyTo()->int()) ;
        switch ($action) {
            case 'showprompt':
                foreach (range(1, $amount) as $idx) {
                    $link_uri = $url_builder
                        ->withParameter($action_token, "promptlink")
                        ->withParameter($amount_token, (string) $idx)
                        ->buildURI()->__toString();
                    $links[] = $factory->link()->standard((string) $idx, $link_uri);
                }
                $buttons = [
                    $factory->button()->standard('OK', '#')->withOnLoadCode(
                        fn($id) => "$('#$id').on('click', (e)=> {alert('$id');});"
                    )
                ];
                \ilSession::set("full_amount", (string) $idx);
                $prompt_content = $factory->messageBox()->info('some text')
                    ->withLinks($links)
                    ->withButtons($buttons);
                break;
 
            case 'promptlink':
                $back_uri = $url_builder
                        ->withParameter($action_token, "showprompt")
                        ->withParameter($amount_token, (string) \ilSession::get("full_amount"))
                        ->buildURI()->__toString();
                $back = $factory->button()->standard('back', '#')->withOnLoadCode(
                    fn($id) => "$('#$id').on('click', (e)=> {
                        let promptId = e.target.closest('.il-prompt').id;
                        il.UI.prompt.get(promptId).show('$back_uri');
                    });"
                );
                $prompt_content = $factory->messageBox()->info((string) $amount)
                    ->withButtons([$back]);
                break;
 
            default:
                throw new \Exception('?' . $action . $amount);
        }
 
        $response = $factory->prompt()->state()->show($prompt_content);
        echo($renderer->renderAsync($response));
        exit();
    }
 
    if (!$query->has($endpointtoken->getName())) {
        $show_button = $factory->button()->standard('Show Simple Prompt', $prompt->getShowSignal());
        $close_button = $factory->button()->standard('close Simple Prompt', $prompt->getCloseSignal());
 
        $uri = $url_builder->withParameter($amount_token, "8")->buildURI();
        $show_button8 = $factory->button()->standard('Show Prompt with Parameter', $prompt->getShowSignal($uri));
 
        $uri = $url_builder->withParameter($amount_token, "78")->buildURI();
        $show_button78 = $factory->button()->standard('Show Prompt with a lot of Items', $prompt->getShowSignal($uri));
 
        return $renderer->render([
            $prompt,
            $show_button, $show_button8, $show_button78
        ]);
    }
}

References $DIC, $id, ILIAS\UI\examples\Layout\Page\Standard\$refinery, $renderer, $response, exit, ilSession\get(), and ilSession\set().

Referenced by ilMediaItem\__construct(), ilStyleClassAddedObjective\__construct(), ilWebLinkBaseItem\__construct(), ilStyleClassAddedObjective\achieve(), ilWebLinkDraftItem\addParameter(), ilSessionAppEventListener\fetchRecipientParticipants(), ILIAS\MetaData\Editor\Http\LinkBuilder\get(), ilMediaItem\getParameter(), ilMediaItem\getParameterString(), ilMailAppEventListener\handle(), ilSessionAppEventListener\handle(), ilCertificateAppEventListener\handleDeletedUser(), ilCertificateAppEventListener\handleLPUpdate(), ilMediaItem\resetParameters(), ilSessionAppEventListener\sendMail(), ilMediaItem\setParameter(), ilSCORMItem\setParameters(), ilWACPath\setParameters(), ilWACPath\setTimestamp(), ilWACPath\setToken(), and ilWACPath\setTTL().

Here is the call graph for this function:

Here is the caller graph for this function: