Yiisoft\Mailer\FileMailer

Complexity

Total Complexity

8

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Test Coverage

Coverage

95%

Importance

Changes	2
Bugs	1	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	generateMessageFilename()	0	14	3
A	sendMessage()	0	10	4
A	__construct()	0	10	1

<?php

declare(strict_types=1);

namespace Yiisoft\Mailer;

use Exception;
use Psr\EventDispatcher\EventDispatcherInterface;
use RuntimeException;

use function date;
use function file_put_contents;
use function gettype;
use function is_dir;
use function is_string;
use function microtime;
use function mkdir;
use function random_int;
use function sprintf;

/**
 * FileMailer is a mock mailer that save email messages in files instead of sending them.
 */
final class FileMailer extends Mailer
{
    /**
     * The path where message files located.
     *
     * @var string
     */
    private string $path;

    /**
     * @var callable|null A PHP callback that return a file name which will be used to save the email message.
     *
     * If not set, the file name will be generated based on the current
     * timestamp {@see FileMailer::generateMessageFilename()}.
     *
     * The signature of the callback is:
     *
     * ```php
     * function (MessageInterface $message): string;
     * ```
     */
    private $filenameCallback;

    /**
     * @param MessageFactoryInterface $messageFactory The message factory instance.
     * @param MessageBodyRenderer $messageBodyRenderer The message body renderer instance.
     * @param EventDispatcherInterface $eventDispatcher The event dispatcher instance.
     * @param string $path The path where message files located.
     * @param callable|null $filenameCallback A PHP callback that return
     * a file name which will be used to save the email message.
     */
    public function __construct(
        MessageFactoryInterface $messageFactory,
        MessageBodyRenderer $messageBodyRenderer,
        EventDispatcherInterface $eventDispatcher,
        string $path,
        callable $filenameCallback = null
    ) {
        parent::__construct($messageFactory, $messageBodyRenderer, $eventDispatcher);
        $this->path = $path;
        $this->filenameCallback = $filenameCallback;
    }

    protected function sendMessage(MessageInterface $message): void
    {
        $filename = $this->path . DIRECTORY_SEPARATOR . $this->generateMessageFilename($message);
        $filepath = dirname($filename);

        if (!is_dir($filepath) && !mkdir($filepath, 0777, true) && !is_dir($filepath)) {
            throw new RuntimeException(sprintf('Directory "%s" was not created.', $filepath));
        }

        file_put_contents($filename, $message->__toString());
    }

    /**
     * Generates a filename based on the current timestamp.
     *
     * @param MessageInterface $message The message instance.
     *
     * @throws Exception {@see https://www.php.net/manual/en/function.random-int.php}
     * @throws RuntimeException If {@see FileMailer::$filenameCallback} does not return a string.
     *
     * @return string The filename for saving the message.
     */
    private function generateMessageFilename(MessageInterface $message): string
    {
        if ($this->filenameCallback === null) {
            $time = (int) microtime(true);
            return date('Ymd-His-', $time) . sprintf('%04d', $time) . '-' . sprintf('%04d', random_int(0, 10000)) . '.eml';
        }

        $filename = ($this->filenameCallback)($message);

        if (!is_string($filename)) {
            throw new RuntimeException(sprintf('Filename must be a string. "%s" received.', gettype($filename)));
        }

        return $filename;
    }
}