ILIAS\UI\examples\Tree\Expandable Namespace Reference

Functions
	expandable ()
	expandable2 ()
if( $request_wrapper->has( 'async_ref') &&$request_wrapper->retrieve( 'async_ref', $refinery->kindlyTo() ->bool()))	expandable_async_repo ($ref=null)

Variables
global	$DIC
	$refinery = $DIC->refinery()
	$request_wrapper = $DIC->http()->wrapper()->query()

Function Documentation

expandable()

ILIAS\UI\examples\Tree\Expandable\expandable

(

)

---

description: > Example for rendering an expandable tree.

expected output: > ILIAS shows a navigation tree with different numbered sub-points. The sub-point can be collapsed by clicking the ">".

The last entries in a branch are clickable and open a modal window with an image.

Definition at line 33 of file expandable.php.

{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $data = [
        ['label' => 'root', 'children' => [
            ['label' => '1', 'children' => [
                ['label' => '1.1', 'children' => [
                    ['label' => '1.1.1', 'children' => []],
                    ['label' => '1.1.2', 'children' => []]
                ]],
                ['label' => '1.2', 'children' => []],
                ['label' => '1.3', 'children' => []]
            ]],
            ['label' => '2', 'children' => [
                ['label' => '2.1', 'children' => []],
            ]],
            ['label' => '3', 'children' => [
                ['label' => '3.1', 'children' => [
                    ['label' => '3.1.1', 'children' => [
                        ['label' => '3.1.1.1', 'children' => []],
                    ]],
                ]],
 
            ]],
        ]]
    ];
 
    $recursion = new class () implements \ILIAS\UI\Component\Tree\TreeRecursion {
        public function getChildren($record, $environment = null): array
        {
            return $record['children'];
        }
 
        public function build(
            \ILIAS\UI\Component\Tree\Node\Factory $factory,
            $record,
            $environment = null
        ): \ILIAS\UI\Component\Tree\Node\Node {
            $label = $record['label'];
            $node = $factory->simple($label);
 
            if (count($record['children']) === 0) {
                $node = $node->withOnClick($environment['modal']->getShowSignal());
            }
 
            if ($label === "root" || $label === "2") {
                $node = $node->withExpanded(true);
            }
            if ($label === "2") {
                $node = $node->withHighlighted(true);
            }
 
            return $node;
        }
    };
 
    $image = $f->image()->responsive("assets/ui-examples/images/Image/mountains.jpg", "Image source: https://stocksnap.io, Creative Commons CC0 license");
    $page = $f->modal()->lightboxImagePage($image, 'Mountains');
    $modal = $f->modal()->lightbox($page);
    $environment = [
        'modal' => $modal
    ];
 
    $tree = $f->tree()->expandable("Label", $recursion)
        ->withEnvironment($environment)
        ->withData($data)
        ->withHighlightOnNodeClick(true);
 
    return $renderer->render([
        $modal,
        $tree
    ]);
}

References $data, ILIAS\UI\examples\Tree\Expandable\$DIC, Vendor\Package\$f, $page, $renderer, and ILIAS\UI\Component\Clickable\withOnClick().

Referenced by ILIAS\Style\Content\Characteristic\CharacteristicTableBuilder\__construct(), ILIAS\Style\Content\Characteristic\CharacteristicTableBuilder\build(), and ILIAS\Style\Content\Characteristic\CharacteristicTableBuilder\getOrderingCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

expandable2()

ILIAS\UI\examples\Tree\Expandable\expandable2

(

)

---

description: > Example for rendering an expandable tree.

expected output: > ILIAS shows an example very simliar to the "expandable" example but with less sub-points. Also the sub-points have

got no functions, therefore clicking them will do nothing.

Definition at line 33 of file expandable2.php.

                      : string
{
    global $DIC;
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
 
    $getDataNode = function (string $label, array $children = []) {
        return new class ($label, $children) {
            protected string $label = '';
            protected array $children = [];
 
            public function __construct(string $label, array $children = [])
            {
                $this->label = $label;
                $this->children = $children;
            }
 
            public function getLabel(): string
            {
                return $this->label;
            }
 
            public function getChildren(): array
            {
                return $this->children;
            }
        };
    };
 
    $n11 = $getDataNode('1.1');
    $n12 = $getDataNode('1.2', [$getDataNode('1.2.1')]);
    $n1 = $getDataNode('1', [$n11, $n12]);
    $data = [$n1];
 
    $recursion = new class () implements \ILIAS\UI\Component\Tree\TreeRecursion {
        public function getChildren($record, $environment = null): array
        {
            return $record->getChildren();
        }
 
        public function build(
            \ILIAS\UI\Component\Tree\Node\Factory $factory,
            $record,
            $environment = null
        ): \ILIAS\UI\Component\Tree\Node\Node {
            return $factory->simple($record->getLabel());
        }
    };
 
    $tree = $f->tree()->expandable("Label", $recursion)
        ->withData($data);
 
    return $renderer->render($tree);
}

References $data, ILIAS\UI\examples\Tree\Expandable\$DIC, Vendor\Package\$f, $renderer, ILIAS\__construct(), and ILIAS\Questions\Definitions\getLabel.

Here is the call graph for this function:

expandable_async_repo()

if($request_wrapper->has('async_ref') && $request_wrapper->retrieve('async_ref', $refinery->kindlyTo() ->bool())) ILIAS\UI\examples\Tree\Expandable\expandable_async_repo

(

$ref = null

)

---

description: > Example for rendering an expandable tree with asynchronous repositories.

expected output: >

This example can be ignored for the time being.

Definition at line 42 of file expandable_async_repo.php.

{
    global $DIC;
    $ilTree = $DIC['tree'];
 
    if (is_null($ref)) {
        $do_async = false;
        $ref = 1;
        $data = array(
            $ilTree->getNodeData(1)
        );
    } else {
        $do_async = true;
        $data = $ilTree->getChilds($ref);
        if (count($data) === 0) {
            return;
        }
    }
 
    $recursion = new class () implements \ILIAS\UI\Component\Tree\TreeRecursion {
        public function getChildren($record, $environment = null): array
        {
            return [];
        }
 
        public function build(
            \ILIAS\UI\Component\Tree\Node\Factory $factory,
            $record,
            $environment = null
        ): \ILIAS\UI\Component\Tree\Node\Node {
            $ref_id = $record['ref_id'];
            $label = $record['title']
                . ' (' . $record['type'] . ', ' . $ref_id . ')';
 
            $icon = $environment['icon_factory']->standard($record["type"], '');
            $url = $this->getAsyncURL($environment, (string) $ref_id);
 
            $node = $factory->simple($label, $icon)
                ->withAsyncURL($url);
 
            //find these under ILIAS->Administration in the example tree
            if ((int) $ref_id > 9 && (int) $ref_id < 20) {
                $label = $environment['modal']->getShowSignal()->getId();
                $node = $factory->simple($label)
                    ->withAsyncURL($url)
                    ->withOnClick($environment['modal']->getShowSignal());
            }
 
            return $node;
        }
 
        protected function getAsyncURL($environment, string $ref_id): string
        {
            $url = $environment['url'];
            $base = substr($url, 0, strpos($url, '?') + 1);
            $query = parse_url($url, PHP_URL_QUERY);
            if ($query) {
                parse_str($query, $params);
            } else {
                $params = [];
            }
            $params['async_ref'] = $ref_id;
            $url = $base . http_build_query($params);
            return $url;
        }
    };
 
    $f = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $image = $f->image()->responsive("assets/ui-examples/images/Image/mountains.jpg", "Image source: https://stocksnap.io, Creative Commons CC0 license");
    $page = $f->modal()->lightboxImagePage($image, 'Mountains');
    $modal = $f->modal()->lightbox($page);
 
    $environment = [
        'url' => $DIC->http()->request()->getRequestTarget(),
        'modal' => $modal,
        'icon_factory' => $f->symbol()->icon()
    ];
 
    $tree = $f->tree()->expandable("Label", $recursion)
        ->withEnvironment($environment)
        ->withData($data);
 
    if (!$do_async) {
        return $renderer->render([$modal, $tree]);
    } else {
        echo $renderer->renderAsync([$modal, $tree->withIsSubTree(true)]);
    }
}

References $data, ILIAS\UI\examples\Tree\Expandable\$DIC, Vendor\Package\$f, $page, and $renderer.

Variable Documentation

$DIC

global ILIAS::UI::examples::Tree::Expandable\$DIC

Definition at line 23 of file expandable_async_repo.php.

Referenced by ILIAS\UI\examples\Tree\Expandable\expandable(), ILIAS\UI\examples\Tree\Expandable\expandable2(), and ILIAS\UI\examples\Tree\Expandable\expandable_async_repo().

$refinery

ILIAS::UI::examples::Tree::Expandable\$refinery = $DIC->refinery()

Definition at line 24 of file expandable_async_repo.php.

$request_wrapper

ILIAS::UI::examples::Tree::Expandable\$request_wrapper = $DIC->http()->wrapper()->query()

Definition at line 25 of file expandable_async_repo.php.