Yiisoft\Mailer\FileMailer

Complexity

Total Complexity

10

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Test Coverage

Coverage

95.83%

Importance

Changes	2
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getPath()	0	3	1
A	setPath()	0	3	1
A	setFilenameCallback()	0	3	1
A	__construct()	0	10	1
A	generateMessageFilename()	0	5	1
A	sendMessage()	0	13	5

<?php
namespace Yiisoft\Mailer;

use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Log\LoggerInterface;

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

    /**
     * Returns path.
     * @return string
     */
    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * Sets path.
     * @param string $path
     */
    public function setPath(string $path): void
    {
        $this->path = $path;
    }


    /**
     * @param MessageFactoryInterface $messageFactory
     * @param Composer $composer
     * @param EventDispatcherInterface $eventDispatcher
     * @param LoggerInterface $logger
     * @param string $path
     */
    public function __construct(
        MessageFactoryInterface $messageFactory,
        Composer $composer,
        EventDispatcherInterface $eventDispatcher,
        LoggerInterface $logger,
        string $path
    )
    {
        parent::__construct($messageFactory, $composer, $eventDispatcher, $logger);
        $this->path = $path;
    }

    /**
     * @var callable 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.
     *
     * The signature of the callback is:
     *
     * ```php
     * function ($mailer, $message)
     * ```
     */
    private $filenameCallback;

    /**
     * Sets filename callback.
     * @param callable $callback
     */
    public function setFilenameCallback(Callable $callback): void
    {
        $this->filenameCallback = $callback;
    }

    /**
     * @return string the filename for saving the message.
     * @throws \Exception
     */
    protected function generateMessageFilename(): string
    {
        $time = microtime(true);

        return date('Ymd-His-', $time) . sprintf('%04d', (int) (($time - (int) $time) * 10000)) . '-' . sprintf('%04d', random_int(0, 10000)) . '.eml';
    }

    protected function sendMessage(MessageInterface $message): void
    {
        if ($this->filenameCallback !== null) {
            $filename = call_user_func($this->filenameCallback, $this, $message);
        } else {
            $filename = $this->generateMessageFilename();
        }
        $filename = $this->path . DIRECTORY_SEPARATOR . $filename;
        $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());
    }
}