ILIAS\UI\examples\Progress\Bar Namespace Reference

Functions
	client ()
	description: > This example shows how a Progress Bar can be rendered and used on the client. More...
	server ()
	description: > This example shows how a Progress Bar can be rendered and updated by the server. More...
	callArtificialTaskEndpoint (GlobalHttpState $http, UI\Factory $factory, UI\Renderer $renderer)
	initialiseArtificialTaskOnce ()
	incrementTaskProgress ()
	getTaskProgress ()
	resetTask ()

Function Documentation

callArtificialTaskEndpoint()

ILIAS\UI\examples\Progress\Bar\callArtificialTaskEndpoint	(	GlobalHttpState	$http,
		UI\Factory	$factory,
		UI\Renderer	$renderer
	)

Definition at line 77 of file server.php.

References ILIAS\HTTP\GlobalHttpState\close(), ILIAS\UI\examples\Progress\Bar\getTaskProgress(), ILIAS\UI\examples\Progress\Bar\incrementTaskProgress(), ILIAS\UI\examples\Progress\Bar\initialiseArtificialTaskOnce(), ILIAS\UI\examples\Progress\Bar\resetTask(), ILIAS\HTTP\GlobalHttpState\response(), ILIAS\HTTP\GlobalHttpState\saveResponse(), and ILIAS\HTTP\GlobalHttpState\sendResponse().

Referenced by ILIAS\UI\examples\Progress\Bar\server().

                                                                                                      : void
{
    initialiseArtificialTaskOnce();

    $task_progress = getTaskProgress();

    $state = match ($task_progress) {
        1 => $state = $factory->progress()->state()->bar()->determinate(10, 'Start processing...'),
        2 => $state = $factory->progress()->state()->bar()->determinate(20),
        3 => $state = $factory->progress()->state()->bar()->determinate(30),
        4 => $state = $factory->progress()->state()->bar()->determinate(40),
        5 => $state = $factory->progress()->state()->bar()->determinate(50, 'Still processing...'),
        6 => $state = $factory->progress()->state()->bar()->determinate(60),
        7 => $state = $factory->progress()->state()->bar()->determinate(70),
        8 => $state = $factory->progress()->state()->bar()->determinate(80),
        9 => $state = $factory->progress()->state()->bar()->determinate(90),
        10 => $state = $factory->progress()->state()->bar()->success("All done!"),
        default => $state = $factory->progress()->state()->bar()->failure("An error ocurred."),
    };

    if (10 > $task_progress) {
        incrementTaskProgress();
    } else {
        resetTask();
    }

    $html = $renderer->renderAsync($state);

    $http->saveResponse(
        $http->response()
             ->withHeader('Content-Type', 'text/html; charset=utf-8')
             ->withBody(Streams::ofString($html))
    );
    $http->sendResponse();
    $http->close();
}

Here is the call graph for this function:

Here is the caller graph for this function:

client()

ILIAS\UI\examples\Progress\Bar\client

(

)

---

description: > This example shows how a Progress Bar can be rendered and used on the client.

The trigger button is supplied with the according JavaScript code, which uses the clientside facility of a Progress Bar.

expected output: > ILIAS shows the rendered Progress Bar and Standard Button. The Progress Bar is initially empty (no progress), and cannot be operated in any way. When the Standard Button is clicked, the Progress Bar value us increased by 10% each time.

After the 10th click, the Progress Bar is finished showing a successful state.

Definition at line 37 of file client.php.

References $DIC, $id, and $renderer.

Referenced by XapiProxy\XapiProxyPolyFill\__construct(), ilCmiXapiStatementsDeleteRequest\__construct(), ilCmiXapiStatementsDeleteRequest\_lookUpDataCount(), ilSoapClient\call(), ilCmiXapiStatementsDeleteRequest\deleteData(), ilAuthProviderCAS\doAuthentication(), ilAuthProviderSoap\handleSoapAuth(), ilSoapClient\init(), ilAuthProviderSoap\initClient(), ilCmiXapiStatementsDeleteRequest\queryBatch(), ilWACToken\setClient(), and ilWACPath\setClient().

                 : string
{
    global $DIC;
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();

    $progress_bar = $factory->progress()->bar('clicking the button 10 times');

    $make_progress = $factory->button()->standard('make some progress', '#');
    $make_progress = $make_progress->withAdditionalOnLoadCode(
        static fn(string $id) => "
            let progress = 0;
            document.getElementById('$id')?.addEventListener('click', (event) => {
                if (90 === progress) {
                    event.target.disabled = true;
                    il.UI.Progress.Bar.success('{$progress_bar->getUpdateSignal()}', 'all done!');
                    return;
                }
                
                progress += 10;
                il.UI.Progress.Bar.determinate('{$progress_bar->getUpdateSignal()}', progress);
            });
        ",
    );

    return $renderer->render([$progress_bar, $make_progress]);
}

Here is the caller graph for this function:

getTaskProgress()

ILIAS\UI\examples\Progress\Bar\getTaskProgress

(

)

Definition at line 127 of file server.php.

References ILIAS\GlobalScreen\get().

Referenced by ILIAS\UI\examples\Progress\Bar\callArtificialTaskEndpoint().

                          : int
{
    return \ilSession::get(__NAMESPACE__ . '_example_task_progress') ?? 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

incrementTaskProgress()

ILIAS\UI\examples\Progress\Bar\incrementTaskProgress

(

)

Definition at line 121 of file server.php.

References ilSession\get(), and ilSession\set().

Referenced by ILIAS\UI\examples\Progress\Bar\callArtificialTaskEndpoint().

                                : void
{
    $previous_value = \ilSession::get(__NAMESPACE__ . '_example_task_progress');
    \ilSession::set(__NAMESPACE__ . '_example_task_progress', (int) $previous_value + 1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

initialiseArtificialTaskOnce()

ILIAS\UI\examples\Progress\Bar\initialiseArtificialTaskOnce

(

)

Definition at line 114 of file server.php.

References ilSession\has(), and ilSession\set().

Referenced by ILIAS\UI\examples\Progress\Bar\callArtificialTaskEndpoint().

                                       : void
{
    if (!\ilSession::has(__NAMESPACE__ . '_example_task_progress')) {
        \ilSession::set(__NAMESPACE__ . '_example_task_progress', 1);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

resetTask()

ILIAS\UI\examples\Progress\Bar\resetTask

(

)

Definition at line 132 of file server.php.

References ilSession\clear().

Referenced by ILIAS\UI\examples\Progress\Bar\callArtificialTaskEndpoint().

                    : void
{
    \ilSession::clear(__NAMESPACE__ . '_example_task_progress');
}

Here is the call graph for this function:

Here is the caller graph for this function:

server()

ILIAS\UI\examples\Progress\Bar\server

(

)

---

description: > This example shows how a Progress Bar can be rendered and updated by the server.

The artificial endpoint uses Progres Bar Instructions to order the clientside Progress Bar to perform a desired update. A Standard Button can be used to start this process.

expected output: > ILIAS shows the rendered Progress Bar and Standard Button. The Progress Bar is initially empty (no progress), and cannot be operated in any way. When the Standard Button is clicked, the Progress Bar value us increased by 10% ~every second. After the ~10 seconds, the Progress Bar will be finished showing a

successful state.

Definition at line 43 of file server.php.

References $DIC, $http, $id, $renderer, and ILIAS\UI\examples\Progress\Bar\callArtificialTaskEndpoint().

Referenced by ilSoapUserAdministrationAdapter\__construct(), ilECSCmsTreeCommandQueueHandler\__construct(), ilECSCommunityTableGUI\__construct(), ilECSCmsCourseCommandQueueHandler\__construct(), ilECSEnrolmentStatusCommandQueueHandler\__construct(), ilECSCmsCourseMemberCommandQueueHandler\__construct(), ilECSCourseCreationHandler\__construct(), ilECSCmsTreeSynchronizer\__construct(), ilNusoapUserAdministrationAdapter\__construct(), ilECSMappingSettingsGUI\__construct(), ilSoapDummyAuthServer\__construct(), ilLDAPSettingsGUI\activateServer(), ilLDAPSettingsGUI\addRoleMapping(), ilECSCmsTreeSynchronizer\checkTreeUpdates(), ilLDAPSettingsGUI\createRoleMapping(), ilLDAPSettingsGUI\deactivateServer(), ILIAS\Cache\Adaptor\Memcached\delete(), ilNusoapUserAdministrationAdapter\enableWSDL(), ilSoapDummyAuthServer\enableWSDL(), ILIAS\Cache\Adaptor\Memcached\flush(), ILIAS\Cache\Adaptor\Memcached\flushContainer(), ILIAS\Cache\Adaptor\Memcached\get(), ilLDAPSettingsGUI\getRoleAssignmentTable(), ilNusoapUserAdministrationAdapter\handleSoapPlugins(), ilECSCmsTreeSynchronizer\handleTreeUpdate(), ILIAS\Cache\Adaptor\Memcached\has(), ILIAS\Cache\Adaptor\Memcached\initServer(), ilAuthProviderLDAP\initServer(), ilLDAPUserSynchronisation\initServer(), ilLDAPSettingsGUI\initServer(), ILIAS\Cache\Adaptor\Memcached\isAvailable(), ilCASSettings\read(), ilSoapUserAdministrationAdapter\registerMethods(), ilSoapDummyAuthServer\registerMethods(), ilLDAPSettingsGUI\roleAssignments(), ilLDAPSettingsGUI\roleMapping(), ilLDAPSettingsGUI\save(), ilLDAPSettingsGUI\saveSyncronizationSettings(), ilLDAPSettingsGUI\serverList(), ILIAS\Cache\Adaptor\Memcached\set(), ilCASSettings\setServer(), ilECSCourseMemberAssignment\setServer(), ilECSSetting\setServer(), ilLDAPSettingsGUI\setServerFormValues(), ilSoapUserAdministrationAdapter\start(), ilNusoapUserAdministrationAdapter\start(), ilSoapDummyAuthServer\start(), ilECSCmsTreeSynchronizer\sync(), ilECSCmsTreeSynchronizer\syncCategory(), ilECSCmsTreeSynchronizer\syncNode(), and ilLDAPSettingsGUI\updateRoleMapping().

                 : string
{
    global $DIC;
    $http = $DIC->http();
    $uri = $http->request()->getUri();
    $request = $http->wrapper()->query();
    $factory = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $data_factory = new \ILIAS\Data\Factory();

    $endpoint_flag = 'progress_bar_example_endpoint';
    $endpoint_url = $uri . "&$endpoint_flag=1";
    $endpoint_url = $data_factory->uri($endpoint_url);

    $progress_bar = $factory->progress()->bar('waiting about 10 seconds', $endpoint_url);

    $trigger = $factory->button()->standard('start making progress', '#');
    $trigger = $trigger->withAdditionalOnLoadCode(
        static fn(string $id) => "
            document.getElementById('$id')?.addEventListener('click', (event) => {
                // always 'kick off' async progress bars with an indeterminate state.
                il.UI.Progress.Bar.indeterminate('{$progress_bar->getUpdateSignal()}', 'Estimating...');
                event.target.disabled = true;
            });
        "
    );

    if ($request->has($endpoint_flag)) {
        callArtificialTaskEndpoint($http, $factory, $renderer);
    }

    return $renderer->render([$progress_bar, $trigger]);
}

Here is the call graph for this function:

Here is the caller graph for this function: