GrindingInputAccess.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Language\Activities;
 
use ILIAS\Data\Result;
use ILIAS\UI\Component\Input\Container\Form\FormInput;
use ILIAS\UI\Component\Input\Input;
use ILIAS\UI\Implementation\Component\Input\ArrayInputData;
use ILIAS\UI\Implementation\Component\Input\FormInputNameSource;
use ILIAS\UI\Implementation\Component\Input\InputInternal;
 
final class GrindingInputAccess
{
    private function __construct()
    {
    }
 
    public static function named(FormInput $description, string $activity_class): FormInput
    {
        if (!$description instanceof InputInternal) {
            throw new \LogicException(
                $activity_class . '::getInputDescription() must return a FormInput built from the ' .
                'UI framework (i.e. one that also implements ' . InputInternal::class . ') to be ' .
                'grindable by maybePerformAs() - see the GrindsFormInput trait for why.'
            );
        }
 
        return $description->withNameFrom(new FormInputNameSource());
    }
 
    public static function withRawValues(FormInput $named, array $flat_raw_values): FormInput
    {
        self::assertInternal($named, 'withInput()');
 
        return $named->withInput(new ArrayInputData($flat_raw_values));
    }
 
    public static function content(FormInput $with_input): Result
    {
        self::assertInternal($with_input, 'getContent()');
 
        return $with_input->getContent();
    }
 
    public static function nameOf(Input $input): ?string
    {
        return $input instanceof InputInternal ? $input->getName() : null;
    }
 
    public static function errorOf(Input $input): ?string
    {
        return $input instanceof InputInternal ? $input->getError() : null;
    }
 
    public static function isNameable(Input $input): bool
    {
        return $input instanceof InputInternal;
    }
 
    public static function requireNameable(Input $input, string $exception_message): void
    {
        if (!$input instanceof InputInternal) {
            throw new \LogicException($exception_message);
        }
    }
 
    public static function dedicatedNameOf(Input $input): ?string
    {
        return $input instanceof \ILIAS\UI\Implementation\Component\Input\Input
            ? $input->getDedicatedName()
            : null;
    }
 
    private static function assertInternal(FormInput $input, string $needed_for): void
    {
        if (!$input instanceof InputInternal) {
            throw new \LogicException(
                'Expected a FormInput also implementing ' . InputInternal::class . ' (needed for ' .
                $needed_for . '), got: ' . get_debug_type($input)
            );
        }
    }
}