ilMailErrorFormatter Class Reference

Collaboration diagram for ilMailErrorFormatter:

Public Member Functions
	__construct (protected ilLanguage $lng)
	format (array $errors)
	Formats an error string based on the passed list of errors. More...

Detailed Description

Definition at line 21 of file class.ilMailErrorFormatter.php.

Constructor & Destructor Documentation

__construct()

ilMailErrorFormatter::__construct

(

protected ilLanguage

$lng

)

Definition at line 23 of file class.ilMailErrorFormatter.php.

    {
    }

Member Function Documentation

format()

ilMailErrorFormatter::format

(

array

$errors

)

Formats an error string based on the passed list of errors.

If the list contains > 1 elements, the 1st error will be used as a headline for the list of errors.

Parameters

list<ilMailError>

$errors

Definition at line 32 of file class.ilMailErrorFormatter.php.

                                         : string
    {
        if ([] === $errors) {
            return '';
        }
 
        $errors_to_display = [];
        foreach ($errors as $error) {
            $translation = $this->lng->txt($error->getLanguageVariable());
            if ($translation === '-' . $error->getLanguageVariable() . '-') {
                $translation = $error->getLanguageVariable();
            }
 
            if ($translation === $error->getLanguageVariable() || [] === $error->getPlaceHolderValues()) {
                $errors_to_display[] = $translation;
            } else {
                $escaped_placeholder_values = array_map(static function (string $value): string {
                    return ilLegacyFormElementsUtil::prepareFormOutput($value);
                }, $error->getPlaceHolderValues());
 
                array_unshift($escaped_placeholder_values, $translation);
                $errors_to_display[] = sprintf(...$escaped_placeholder_values);
            }
        }
 
        $tpl = new ilTemplate(
            'tpl.mail_new_submission_errors.html',
            true,
            true,
            'components/ILIAS/Mail'
        );
        if (count($errors_to_display) === 1) {
            $tpl->setCurrentBlock('single_error');
            $tpl->setVariable('SINGLE_ERROR', current($errors_to_display));
        } else {
            $first_error = array_shift($errors_to_display);
            foreach ($errors_to_display as $error) {
                $tpl->setCurrentBlock('error_loop');
                $tpl->setVariable('ERROR', $error);
                $tpl->parseCurrentBlock();
            }
 
            $tpl->setCurrentBlock('multiple_errors');
            $tpl->setVariable('FIRST_ERROR', $first_error);
        }
        $tpl->parseCurrentBlock();
 
        return $tpl->get();
    }

References ILIAS\News\Common\Table\$tpl, ILIAS\UICore\GlobalTemplate\get(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), and ILIAS\UICore\GlobalTemplate\setVariable().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• components/ILIAS/Mail/classes/Error/class.ilMailErrorFormatter.php