ilMailErrorFormatter Class Reference

Class ilMailErrorFormatter. More...

Collaboration diagram for ilMailErrorFormatter:

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

Protected Attributes
	$lng

Detailed Description

Class ilMailErrorFormatter.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilMailErrorFormatter::__construct

(

\ilLanguage

$lng

)

ilMailErrorFormatter constructor.

Parameters

ilLanguage

$lng

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

    {
        $this->lng = $lng;
    }

References $lng.

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

$errors

\ilMailError[]

Returns

string

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

                                          : string
    {
        if (0 === count($errors)) {
            return '';
        }
 
        $errorsToDisplay = [];
        foreach ($errors as $error) {
            $translation = $this->lng->txt($error->getLanguageVariable());
            if ($translation === '-' . $this->lng->txt($error->getLanguageVariable()) . '-') {
                $translation = $error->getLanguageVariable();
            }
 
            if (
                0 === count($error->getPlaceholderValues()) ||
                $translation === $error->getLanguageVariable()
            ) {
                $errorsToDisplay[] = $translation;
            } else {
                $escapedPlaceholderValues = array_map(function (string $address) {
                    return \ilUtil::prepareFormOutput($address);
                }, $error->getPlaceholderValues());
 
                array_unshift($escapedPlaceholderValues, $translation);
                $errorsToDisplay[] = call_user_func_array('sprintf', $escapedPlaceholderValues);
            }
        }
 
        if (0 === count($errorsToDisplay)) {
            return '';
        }
 
        $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));
            $tpl->parseCurrentBlock();
        } 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();
    }

References $errors, and $tpl.

Field Documentation

$lng

ilMailErrorFormatter::$lng

protected

Definition at line 11 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