Yiisoft\Log\Target\Email\EmailTarget

Complexity

Total Complexity

5

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	1	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	export()	0	13	2
A	__construct()	0	12	3

<?php

declare(strict_types=1);

namespace Yiisoft\Log\Target\Email;

use InvalidArgumentException;
use RuntimeException;
use Throwable;
use Yiisoft\Log\Target;
use Yiisoft\Mailer\MailerInterface;

use function wordwrap;

/**
 * EmailTarget sends selected log messages to the specified email addresses.
 *
 * {@see EmailTarget::$mailer} is instance of {@see MailerInterface} that sends email and should be already configured.
 */
final class EmailTarget extends Target
{
    /**
     * @var string|string[] The receiver email address.
     * You may pass an array of addresses if multiple recipients should receive this message.
     * You may also specify receiver name in addition to email address using format: `[email => name]`.
     */
    private array|string $emailTo;

    /**
     * @var string The email message subject.
     */
    private string $subjectEmail;

    /**
     * @param MailerInterface $mailer The mailer instance.
     * @param string|string[] $emailTo The receiver email address.
     * You may pass an array of addresses if multiple recipients should receive this message.
     * You may also specify receiver name in addition to email address using format: `[email => name]`.
     * @param string $subjectEmail The email message subject.
     * @param string[] $levels The {@see \Psr\Log\LogLevel log message levels} that this target is interested in.
     *
     * @throws InvalidArgumentException If the "to" email message argument is invalid.
     */
    public function __construct(
        private MailerInterface $mailer,
        array|string $emailTo,
        string $subjectEmail = '',
        array $levels = []
    ) {
        if (empty($emailTo)) {
            throw new InvalidArgumentException('The "to" argument must be an array or string and must not be empty.');
        }
        $this->emailTo = $emailTo;
        $this->subjectEmail = $subjectEmail ?: 'Application Log';
        parent::__construct($levels);
    }

    /**
     * Sends log messages to specified email addresses.
     *
     * @throws RuntimeException If the log cannot be exported.
     */
    protected function export(): void
    {
        $message = $this->mailer
            ->compose()
            ->withTo($this->emailTo)
            ->withSubject($this->subjectEmail)
            ->withTextBody(wordwrap($this->formatMessages("\n"), 70))
        ;

        try {
            $this->mailer->send($message);
        } catch (Throwable $e) {
            throw new RuntimeException('Unable to export log through email.', 0, $e);
        }
    }
}