Documentation

Kitchen Sink documentation of style: 'Delos' of skin: 'ILIAS'

Group

Description

Purpose: This view control is only used for logical grouping of other view controls provided by this factory, to comply with the monoid-structure of UI Inputs.
Composition: The view control must consist of 0, 1 or more view controls.
Effect: Each view control will be rendered in the same order as provided.

Example 1: Base

Array
(
    [0] => Array
        (
            [0] => ILIAS\Data\Range Object
                (
                    [start:protected] => 30
                    [length:protected] => 10
                )

            [1] => ILIAS\Data\Order Object
                (
                    [order:protected] => Array
                        (
                            [field1] => ASC
                        )

                )

        )

)

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Input\ViewControl\Group;
 
use ILIAS\Data\Factory as DataFactory;
use ILIAS\Data\Order;
use ILIAS\UI\Implementation\Component\Input\ViewControl\Pagination;
 
function base(): string
{
    global $DIC;
    $f = $DIC->ui()->factory();
    $r = $DIC->ui()->renderer();
    $d = new DataFactory();
 
    $pagination = $f
        ->input()
        ->viewControl()
        ->pagination()
        ->withTotalCount(932)
        ->withValue([Pagination::FNAME_OFFSET => 31, Pagination::FNAME_LIMIT => 10]);
 
    $sortation = $f->input()->viewControl()->sortation([
        'Field 1, ascending' => $d->order('field1', Order::ASC),
        'Field 1, descending' => $d->order('field1', Order::DESC),
        'Field 2, descending' => $d->order('field2', Order::DESC),
    ]);
 
    $group = $f->input()->viewControl()->group([$pagination, $sortation]);
 
    // view this in a ViewControlContainer with active request
    $vc_container = $f->input()->container()->viewControl()->standard([$group])->withRequest(
        $DIC->http()->request()
    );
 
    return $r->render([
        $f->legacy('<pre>' . print_r($vc_container->getData(), true) . '</pre>'),
        $vc_container
    ]);
}

Relations

Parents

UIComponent
Input
View Control