with_required_custom_constraint.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\UI\examples\Input\Field;
 
function with_required_custom_constraint()
{
    //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);
}