ilMailErrorFormatter Class Reference

Class ilMailErrorFormatter. More...

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.

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

    {
        $this->lng = $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.

References $tpl, ILIAS\Repository\lng(), and ilLegacyFormElementsUtil\prepareFormOutput().

                                         : 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();
    }

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilMailErrorFormatter::$lng

protected

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

Referenced by __construct().

---

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

• Services/Mail/classes/Error/class.ilMailErrorFormatter.php