ILIAS\UI\examples\Input\Field Namespace Reference

Namespaces
	Checkbox
	ColorSelect
	DateTime
	Duration
	File
	Group
	Hidden
	Image
	Link
	Markdown
	MultiSelect
	Numeric
	OptionalGroup
	Password
	Radio
	Rating
	Section
	Select
	SwitchableGroup
	Tag
	Text
	Textarea
	TreeMultiSelect
	TreeSelect
	Url

Functions
	with_dedicated_name ()
	description: > Example showing an Input with an optional dedicated name which is used as NAME attribute on the rendered input. More...
	with_dedicated_name_and_path ()
	description: > Example showing Inputs with dedicated names that are contained within a named group. More...
	with_required ()
	description: > Example showing the use of the withRequired() method More...
	with_required_custom_constraint ()
	description: > Example showing the use of the withRequired() method with a custom constraint that replaces the default requirement constraint. More...

Function Documentation

with_dedicated_name()

ILIAS\UI\examples\Input\Field\with_dedicated_name

(

)

---

description: > Example showing an Input with an optional dedicated name which is used as NAME attribute on the rendered input.

This option is available for all Input/Fields. Inputs without a dedicated name will get an auto-generated name. Please see the interface of withDedicatedName() for further details on naming.

expected output: >

ILIAS shows the rendered Component.

Definition at line 36 of file with_dedicated_name.php.

References $DIC, and $renderer.

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

    $text_input = $ui->input()->field()
        ->text("Username", "A username")
        ->withDedicatedName('username');

    // Inputs with and without dedicated names can be mixed
    $password_input = $ui->input()->field()
         ->password("Password", "A secret password");

    $duration_input = $ui->input()->field()
         ->duration("Valid from/to")
         ->withDedicatedName('valid');

    $form = $ui->input()->container()->form()->standard("", [$text_input, $password_input, $duration_input]);
    return $renderer->render($form);
}

with_dedicated_name_and_path()

ILIAS\UI\examples\Input\Field\with_dedicated_name_and_path

(

)

---

description: > Example showing Inputs with dedicated names that are contained within a named group.

The name of the group is added to the 'path' and included in the name of the sub-inputs.

expected output: >

ILIAS shows the rendered Component.

Definition at line 33 of file with_dedicated_name_and_path.php.

References $DIC, and $renderer.

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

    $street = $ui->input()->field()
        ->text("Street", "Street and No.")
        ->withDedicatedName('street');

    $city = $ui->input()->field()
       ->text("City")
       ->withDedicatedName('city');

    // This creates inputs named 'address/street' and 'address/city'
    $address = $ui->input()->field()
         ->group([$street, $city], "Address")
         ->withDedicatedName('address');

    $form = $ui->input()->container()->form()->standard("", [$address]);
    return $renderer->render($form);
}

with_required()

ILIAS\UI\examples\Input\Field\with_required

(

)

---

description: > Example showing the use of the withRequired() method

expected output: >

ILIAS shows the rendered Component.

Definition at line 32 of file with_required.php.

References $DIC, and $renderer.

{
    //Step 0: Declare dependencies
    global $DIC;
    $ui = $DIC->ui()->factory();
    $renderer = $DIC->ui()->renderer();
    $request = $DIC->http()->request();

    // Step 1: define the text field and make it a required field,
    // i.e. checking for its default requirement constraint
    // (for text fields: value must have a minimum length of 1)
    $text_input = $ui->input()->field()->text("Enter a name", "And make it a good one!");
    $text_input = $text_input->withRequired(true);

    //Step 2: define form and form actions
    $form = $ui->input()->container()->form()->standard('#', [ $text_input]);

    //Step 3: implement some form data processing.
    if ($request->getMethod() == "POST") {
        $form = $form->withRequest($request);
        $result = $form->getData();
    } else {
        $result = "No result yet.";
    }

    //Step 4: Render the checkbox with the enclosing form.
    return
        "<pre>" . print_r($result, true) . "</pre><br/>" .
        $renderer->render($form);
}

with_required_custom_constraint()

ILIAS\UI\examples\Input\Field\with_required_custom_constraint

(

)

---

description: > Example showing the use of the withRequired() method with a custom constraint that replaces the default requirement constraint.

A custom constraint SHOULD be explained in the byline of the input.

expected output: >

ILIAS shows the rendered Component.

Definition at line 36 of file with_required_custom_constraint.php.

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

{
    //Step 0: Declare dependencies
    global $DIC;
    $ui = $DIC->ui()->factory();
    $refinery = $DIC->refinery();
    $renderer = $DIC->ui()->renderer();
    $request = $DIC->http()->request();

    // Step 1: define the text field, make it a required field
    // and add a custom constraint
    $text_input = $ui->input()->field()->text("Enter a name", "Needs to start with an H");
    $custom_constraint = $refinery->custom()->constraint(function ($value) {
        return (substr($value, 0, 1) === 'H') ? true : false;
    }, "Name does not start with an H");
    $text_input = $text_input->withRequired(true, $custom_constraint);

    //Step 2: define form and form actions
    $form = $ui->input()->container()->form()->standard('#', [ $text_input]);

    //Step 3: implement some form data processing.
    if ($request->getMethod() == "POST") {
        $form = $form->withRequest($request);
        $result = $form->getData();
    } else {
        $result = "No result yet.";
    }

    //Step 4: Render the checkbox with the enclosing form.
    return
        "<pre>" . print_r($result, true) . "</pre><br/>" .
        $renderer->render($form);
}