Merge pull request phpbb#6796 from marc1706/ticket/17490

[ticket/17490] Add unit tests for symfony mailer classes

Author: marc1706

phpBB/phpbb/messenger/method/base.php

@@ -216,9 +216,9 @@ abstract public function process_queue(array &$queue_data): void;
 	 * @param string	$template_path			Email template path
 	 * @param string	$template_dir_prefix	Email template directory prefix
 	 *
-	 * @return bool
+	 * @return void
 	 */
-	public function template(string $template_file, string $template_lang = '', string $template_path = '', string $template_dir_prefix = ''): bool
+	public function template(string $template_file, string $template_lang = '', string $template_path = '', string $template_dir_prefix = ''): void
 	{
 		$template_dir_prefix = (!$template_dir_prefix || $template_dir_prefix[0] === '/') ? $template_dir_prefix : '/' . $template_dir_prefix;
 
@@ -290,8 +290,6 @@ public function template(string $template_file, string $template_lang = '', stri
 		$this->template->set_filenames([
 			'body'		=> $template_file . '.txt',
 		]);
-
-		return true;
 	}
 
 	/**
@@ -425,7 +423,7 @@ public function error(string $msg): void
 	 */
 	public function save_queue(): void
 	{
-		if ($this->use_queue && !empty($this->queue))
+		if ($this->use_queue)
 		{
 			$this->queue->save();
 		}
@@ -487,6 +485,5 @@ protected function set_template_paths(string|array $path_name, string|array $pat
 	 */
 	public function header(string $header_name, mixed $header_value): void
 	{
-		return;
 	}
 }

phpBB/phpbb/messenger/method/email.php

@@ -13,8 +13,12 @@
 
 namespace phpbb\messenger\method;
 
+use Symfony\Component\Mailer\Exception\TransportExceptionInterface;
+use Symfony\Component\Mailer\MailerInterface;
 use Symfony\Component\Mailer\Transport;
 use Symfony\Component\Mailer\Mailer;
+use Symfony\Component\Mailer\Transport\AbstractTransport;
+use Symfony\Component\Mailer\Transport\TransportInterface;
 use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Email as symfony_email;
 use Symfony\Component\Mime\Header\Headers;
@@ -38,16 +42,16 @@ class email extends base
 	 *
 	 * Symfony Mailer transport DSN
 	 */
-	protected $dsn = '';
+	protected string $dsn = '';
 
 	/** @var symfony_email */
-	protected $email;
+	protected symfony_email $email;
 
-	/** @var Address */
-	protected $from;
+	/** @var Address From address */
+	protected Address $from;
 
-	/** @var Headers */
-	protected $headers;
+	/** @var Headers Email headers */
+	protected Headers $headers;
 
 	/**
 	 * @var int
@@ -59,16 +63,16 @@ class email extends base
 	 * symfony_email::PRIORITY_LOW
 	 * symfony_email::PRIORITY_LOWEST
 	 */
-	protected $mail_priority = symfony_email::PRIORITY_NORMAL;
+	protected int $mail_priority = symfony_email::PRIORITY_NORMAL;
 
 	/** @var \phpbb\messenger\queue */
 	protected $queue;
 
 	/** @var Address */
-	protected $reply_to;
+	protected Address $reply_to;
 
-	/** @var \Symfony\Component\Mailer\Transport\AbstractTransport */
-	protected $transport;
+	/** @var AbstractTransport */
+	protected AbstractTransport $transport;
 
 	/**
 	 * {@inheritDoc}
@@ -124,7 +128,7 @@ public function set_addresses(array $user_row): void
 	{
 		if (!empty($user_row['user_email']))
 		{
-			$this->to($user_row['user_email'], $user_row['username'] ?: '');
+			$this->to($user_row['user_email'], $user_row['username'] ?? '');
 		}
 	}
 
@@ -142,10 +146,7 @@ public function to(string $address, string $realname = ''): void
 			return;
 		}
 
-		// If empty sendmail_path on windows, PHP changes the to line
-		$windows_empty_sendmail_path = !$this->config['smtp_delivery'] && DIRECTORY_SEPARATOR == '\\';
-
-		$to = new Address($address, $windows_empty_sendmail_path ? '' : trim($realname));
+		$to = new Address($address, trim($realname));
 		$this->email->getTo() ? $this->email->addTo($to) : $this->email->to($to);
 	}
 
@@ -273,7 +274,6 @@ public function set_mail_priority(int $priority = symfony_email::PRIORITY_NORMAL
 	 */
 	protected function build_headers(): void
 	{
-
 		$board_contact = trim($this->config['board_contact']);
 		$contact_name = html_entity_decode($this->config['board_contact_name'], ENT_COMPAT);
 
@@ -315,7 +315,6 @@ protected function build_headers(): void
 		{
 			$this->header($header, $value);
 		}
-
 	}
 
 	/**
@@ -406,7 +405,7 @@ public function process_queue(array &$queue_data): void
 
 		$package_size = $queue_data[$queue_object_name]['package_size'] ?? 0;
 		$num_items = (!$package_size || $messages_count < $package_size) ? $messages_count : $package_size;
-		$mailer = new Mailer($this->transport);
+		$mailer = $this->get_mailer();
 
 		for ($i = 0; $i < $num_items; $i++)
 		{
@@ -435,7 +434,7 @@ public function process_queue(array &$queue_data): void
 				{
 					$mailer->send($email);
 				}
-				catch (\Symfony\Component\Mailer\Exception\TransportExceptionInterface $e)
+				catch (TransportExceptionInterface $e)
 				{
 					$this->error($e->getDebug());
 					continue;
@@ -450,12 +449,22 @@ public function process_queue(array &$queue_data): void
 		}
 	}
 
+	/**
+	 * Get mailer object
+	 *
+	 * @return MailerInterface Symfony Mailer object
+	 */
+	protected function get_mailer(): MailerInterface
+	{
+		return new Mailer($this->transport);
+	}
+
 	/**
 	 * Get mailer transport object
 	 *
-	 * @return \Symfony\Component\Mailer\Transport\TransportInterface Symfony Mailer transport object
+	 * @return TransportInterface Symfony Mailer transport object
 	 */
-	public function get_transport(): \Symfony\Component\Mailer\Transport\TransportInterface
+	public function get_transport(): TransportInterface
 	{
 		return $this->transport;
 	}
@@ -504,7 +513,7 @@ public function send(): bool
 		// Send message ...
 		if (!$this->use_queue)
 		{
-			$mailer = new Mailer($this->transport);
+			$mailer = $this->get_mailer();
 
 			$subject = $this->subject;
 			$msg = $this->msg;
@@ -538,7 +547,7 @@ public function send(): bool
 			{
 				$mailer->send($this->email);
 			}
-			catch (\Symfony\Component\Mailer\Exception\TransportExceptionInterface $e)
+			catch (TransportExceptionInterface $e)
 			{
 				$this->error($e->getDebug());
 				return false;