Collaboration diagram for ilMailErrorFormatter:

Public Member Functions
	__construct (ilLanguage $lng)

	format (array $errors)
	Formats an error string based on the passed list of errors. More...

Protected Attributes
ilLanguage	$lng

Detailed Description

Class ilMailErrorFormatter.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

ilMailErrorFormatter::__construct ( ilLanguage $lng )

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

    {
        $this->lng = $lng;
    }

References $lng, and ILIAS\Repository\lng().

Here is the call graph for this function:

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

ilMailError[] $errors

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

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