Inspection of "Merge pull request #20380 from nextcloud/design/no..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( da9ad9...c724eb )

by Roeland
created 2020-05-01 06:53 UTC
Status

Indentation +343 added lines, -343 removed lines patch added patch discarded remove patch

@@ -50,33 +50,33 @@  discard block
 block discarded – undo
  * @package OC\Mail
  */
 class EMailTemplate implements IEMailTemplate {
-	/** @var Defaults */
-	protected $themingDefaults;
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-	/** @var IFactory */
-	protected $l10nFactory;
-	/** @var string */
-	protected $emailId;
-	/** @var array */
-	protected $data;
-
-	/** @var string */
-	protected $subject = '';
-	/** @var string */
-	protected $htmlBody = '';
-	/** @var string */
-	protected $plainBody = '';
-	/** @var bool indicated if the footer is added */
-	protected $headerAdded = false;
-	/** @var bool indicated if the body is already opened */
-	protected $bodyOpened = false;
-	/** @var bool indicated if there is a list open in the body */
-	protected $bodyListOpened = false;
-	/** @var bool indicated if the footer is added */
-	protected $footerAdded = false;
-
-	protected $head = <<<EOF
+    /** @var Defaults */
+    protected $themingDefaults;
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+    /** @var IFactory */
+    protected $l10nFactory;
+    /** @var string */
+    protected $emailId;
+    /** @var array */
+    protected $data;
+
+    /** @var string */
+    protected $subject = '';
+    /** @var string */
+    protected $htmlBody = '';
+    /** @var string */
+    protected $plainBody = '';
+    /** @var bool indicated if the footer is added */
+    protected $headerAdded = false;
+    /** @var bool indicated if the body is already opened */
+    protected $bodyOpened = false;
+    /** @var bool indicated if there is a list open in the body */
+    protected $bodyListOpened = false;
+    /** @var bool indicated if the footer is added */
+    protected $footerAdded = false;
+
+    protected $head = <<<EOF
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en" style="-webkit-font-smoothing:antialiased;background:#fff!important">
 <head>
@@ -94,7 +94,7 @@  discard block
 block discarded – undo
 				<center data-parsed="" style="min-width:580px;width:100%">
 EOF;
 
-	protected $tail = <<<EOF
+    protected $tail = <<<EOF
 					</center>
 				</td>
 			</tr>
@@ -106,7 +106,7 @@  discard block
 block discarded – undo
 
 EOF;
 
-	protected $header = <<<EOF
+    protected $header = <<<EOF
 <table align="center" class="wrapper header float-center" style="Margin:0 auto;background:#fff;border-collapse:collapse;border-spacing:0;float:none;margin:0 auto;padding:0;text-align:center;vertical-align:top;width:100%%">
 	<tr style="padding:0;text-align:left;vertical-align:top">
 		<td class="wrapper-inner" style="-moz-hyphens:auto;-webkit-hyphens:auto;Margin:0;border-collapse:collapse!important;color:#0a0a0a;font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,Oxygen-Sans,Ubuntu,Cantarell,'Helvetica Neue',Arial,sans-serif;font-size:16px;font-weight:400;hyphens:auto;line-height:1.3;margin:0;padding:20px;text-align:left;vertical-align:top;word-wrap:break-word">
@@ -139,7 +139,7 @@  discard block
 block discarded – undo
 </table>
 EOF;
 
-	protected $heading = <<<EOF
+    protected $heading = <<<EOF
 <table align="center" class="container main-heading float-center" style="Margin:0 auto;background:0 0!important;border-collapse:collapse;border-spacing:0;float:none;margin:0 auto;padding:0;text-align:center;vertical-align:top;width:580px">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -158,7 +158,7 @@  discard block
 block discarded – undo
 </table>
 EOF;
 
-	protected $bodyBegin = <<<EOF
+    protected $bodyBegin = <<<EOF
 <table align="center" class="wrapper content float-center" style="Margin:0 auto;border-collapse:collapse;border-spacing:0;float:none;margin:0 auto;padding:0;text-align:center;vertical-align:top;width:100%">
 	<tr style="padding:0;text-align:left;vertical-align:top">
 		<td class="wrapper-inner" style="-moz-hyphens:auto;-webkit-hyphens:auto;Margin:0;border-collapse:collapse!important;color:#0a0a0a;font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,Oxygen-Sans,Ubuntu,Cantarell,'Helvetica Neue',Arial,sans-serif;font-size:16px;font-weight:400;hyphens:auto;line-height:1.3;margin:0;padding:0;text-align:left;vertical-align:top;word-wrap:break-word">
@@ -168,7 +168,7 @@  discard block
 block discarded – undo
 					<td style="-moz-hyphens:auto;-webkit-hyphens:auto;Margin:0;border-collapse:collapse!important;color:#0a0a0a;font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,Oxygen-Sans,Ubuntu,Cantarell,'Helvetica Neue',Arial,sans-serif;font-size:16px;font-weight:400;hyphens:auto;line-height:1.3;margin:0;padding:0;text-align:left;vertical-align:top;word-wrap:break-word">
 EOF;
 
-	protected $bodyText = <<<EOF
+    protected $bodyText = <<<EOF
 <table class="row description" style="border-collapse:collapse;border-spacing:0;display:table;padding:0;position:relative;text-align:left;vertical-align:top;width:100%%">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -187,8 +187,8 @@  discard block
 block discarded – undo
 </table>
 EOF;
 
-	// note: listBegin (like bodyBegin) is not processed through sprintf, so "%" is not escaped as "%%". (bug #12151)
-	protected $listBegin = <<<EOF
+    // note: listBegin (like bodyBegin) is not processed through sprintf, so "%" is not escaped as "%%". (bug #12151)
+    protected $listBegin = <<<EOF
 <table class="row description" style="border-collapse:collapse;border-spacing:0;display:table;padding:0;position:relative;text-align:left;vertical-align:top;width:100%">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -196,7 +196,7 @@  discard block
 block discarded – undo
 			<table style="border-collapse:collapse;border-spacing:0;padding:0;text-align:left;vertical-align:top;width:100%">
 EOF;
 
-	protected $listItem = <<<EOF
+    protected $listItem = <<<EOF
 				<tr style="padding:0;text-align:left;vertical-align:top">
 					<td style="Margin:0;color:#0a0a0a;font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,Oxygen-Sans,Ubuntu,Cantarell,'Helvetica Neue',Arial,sans-serif;font-size:16px;font-weight:400;line-height:1.3;margin:0;padding:0;text-align:left;width:15px;">
 						<p class="text-left" style="Margin:0;Margin-bottom:10px;color:#777;font-family:-apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,Oxygen-Sans,Ubuntu,Cantarell,'Helvetica Neue',Arial,sans-serif;font-size:16px;font-weight:400;line-height:1.3;margin:0;margin-bottom:10px;padding:0;padding-left:10px;text-align:left">%s</p>
@@ -208,7 +208,7 @@  discard block
 block discarded – undo
 				</tr>
 EOF;
 
-	protected $listEnd = <<<EOF
+    protected $listEnd = <<<EOF
 			</table>
 		</th>
 	</tr>
@@ -216,7 +216,7 @@  discard block
 block discarded – undo
 </table>
 EOF;
 
-	protected $buttonGroup = <<<EOF
+    protected $buttonGroup = <<<EOF
 <table class="spacer" style="border-collapse:collapse;border-spacing:0;padding:0;text-align:left;vertical-align:top;width:100%%">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -269,7 +269,7 @@  discard block
 block discarded – undo
 </table>
 EOF;
 
-	protected $button = <<<EOF
+    protected $button = <<<EOF
 <table class="spacer" style="border-collapse:collapse;border-spacing:0;padding:0;text-align:left;vertical-align:top;width:100%%">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -309,7 +309,7 @@  discard block
 block discarded – undo
 </table>
 EOF;
 
-	protected $bodyEnd = <<<EOF
+    protected $bodyEnd = <<<EOF
 
 					</td>
 				</tr>
@@ -320,7 +320,7 @@  discard block
 block discarded – undo
 </table>
 EOF;
 
-	protected $footer = <<<EOF
+    protected $footer = <<<EOF
 <table class="spacer float-center" style="Margin:0 auto;border-collapse:collapse;border-spacing:0;float:none;margin:0 auto;padding:0;text-align:center;vertical-align:top;width:100%%">
 	<tbody>
 	<tr style="padding:0;text-align:left;vertical-align:top">
@@ -346,307 +346,307 @@  discard block
 block discarded – undo
 </table>
 EOF;
 
-	public function __construct(Defaults $themingDefaults,
-								IURLGenerator $urlGenerator,
-								IFactory $l10nFactory,
-								$emailId,
-								array $data) {
-		$this->themingDefaults = $themingDefaults;
-		$this->urlGenerator = $urlGenerator;
-		$this->l10nFactory = $l10nFactory;
-		$this->htmlBody .= $this->head;
-		$this->emailId = $emailId;
-		$this->data = $data;
-	}
-
-	/**
-	 * Sets the subject of the email
-	 *
-	 * @param string $subject
-	 */
-	public function setSubject(string $subject) {
-		$this->subject = $subject;
-	}
-
-	/**
-	 * Adds a header to the email
-	 */
-	public function addHeader() {
-		if ($this->headerAdded) {
-			return;
-		}
-		$this->headerAdded = true;
-
-		$logoUrl = $this->urlGenerator->getAbsoluteURL($this->themingDefaults->getLogo(false));
-		$this->htmlBody .= vsprintf($this->header, [$this->themingDefaults->getColorPrimary(), $logoUrl, $this->themingDefaults->getName()]);
-	}
-
-	/**
-	 * Adds a heading to the email
-	 *
-	 * @param string $title
-	 * @param string|bool $plainTitle Title that is used in the plain text email
-	 *   if empty the $title is used, if false none will be used
-	 */
-	public function addHeading(string $title, $plainTitle = '') {
-		if ($this->footerAdded) {
-			return;
-		}
-		if ($plainTitle === '') {
-			$plainTitle = $title;
-		}
-
-		$this->htmlBody .= vsprintf($this->heading, [htmlspecialchars($title)]);
-		if ($plainTitle !== false) {
-			$this->plainBody .= $plainTitle . PHP_EOL . PHP_EOL;
-		}
-	}
-
-	/**
-	 * Open the HTML body when it is not already
-	 */
-	protected function ensureBodyIsOpened() {
-		if ($this->bodyOpened) {
-			return;
-		}
-
-		$this->htmlBody .= $this->bodyBegin;
-		$this->bodyOpened = true;
-	}
-
-	/**
-	 * Adds a paragraph to the body of the email
-	 *
-	 * @param string $text Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
-	 * @param string|bool $plainText Text that is used in the plain text email
-	 *   if empty the $text is used, if false none will be used
-	 */
-	public function addBodyText(string $text, $plainText = '') {
-		if ($this->footerAdded) {
-			return;
-		}
-		if ($plainText === '') {
-			$plainText = $text;
-			$text = htmlspecialchars($text);
-		}
-
-		$this->ensureBodyListClosed();
-		$this->ensureBodyIsOpened();
-
-		$this->htmlBody .= vsprintf($this->bodyText, [$text]);
-		if ($plainText !== false) {
-			$this->plainBody .= $plainText . PHP_EOL . PHP_EOL;
-		}
-	}
-
-	/**
-	 * Adds a list item to the body of the email
-	 *
-	 * @param string $text Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
-	 * @param string $metaInfo Note: When $plainMetaInfo falls back to this, HTML is automatically escaped in the HTML email
-	 * @param string $icon Absolute path, must be 16*16 pixels
-	 * @param string|bool $plainText Text that is used in the plain text email
-	 *   if empty the $text is used, if false none will be used
-	 * @param string|bool $plainMetaInfo Meta info that is used in the plain text email
-	 *   if empty the $metaInfo is used, if false none will be used
-	 * @since 12.0.0
-	 */
-	public function addBodyListItem(string $text, string $metaInfo = '', string $icon = '', $plainText = '', $plainMetaInfo = '') {
-		$this->ensureBodyListOpened();
-
-		if ($plainText === '') {
-			$plainText = $text;
-			$text = htmlspecialchars($text);
-		}
-		if ($plainMetaInfo === '') {
-			$plainMetaInfo = $metaInfo;
-			$metaInfo = htmlspecialchars($metaInfo);
-		}
-
-		$htmlText = $text;
-		if ($metaInfo) {
-			$htmlText = '<em style="color:#777;">' . $metaInfo . '</em><br>' . $htmlText;
-		}
-		if ($icon !== '') {
-			$icon = '<img src="' . htmlspecialchars($icon) . '" alt="&bull;">';
-		} else {
-			$icon = '&bull;';
-		}
-		$this->htmlBody .= vsprintf($this->listItem, [$icon, $htmlText]);
-		if ($plainText !== false) {
-			$this->plainBody .= '  * ' . $plainText;
-			if ($plainMetaInfo !== false) {
-				$this->plainBody .= ' (' . $plainMetaInfo . ')';
-			}
-			$this->plainBody .= PHP_EOL;
-		}
-	}
-
-	protected function ensureBodyListOpened() {
-		if ($this->bodyListOpened) {
-			return;
-		}
-
-		$this->ensureBodyIsOpened();
-		$this->bodyListOpened = true;
-		$this->htmlBody .= $this->listBegin;
-	}
-
-	protected function ensureBodyListClosed() {
-		if (!$this->bodyListOpened) {
-			return;
-		}
-
-		$this->bodyListOpened = false;
-		$this->htmlBody .= $this->listEnd;
-	}
-
-	/**
-	 * Adds a button group of two buttons to the body of the email
-	 *
-	 * @param string $textLeft Text of left button; Note: When $plainTextLeft falls back to this, HTML is automatically escaped in the HTML email
-	 * @param string $urlLeft URL of left button
-	 * @param string $textRight Text of right button; Note: When $plainTextRight falls back to this, HTML is automatically escaped in the HTML email
-	 * @param string $urlRight URL of right button
-	 * @param string $plainTextLeft Text of left button that is used in the plain text version - if unset the $textLeft is used
-	 * @param string $plainTextRight Text of right button that is used in the plain text version - if unset the $textRight is used
-	 */
-	public function addBodyButtonGroup(string $textLeft,
-									   string $urlLeft,
-									   string $textRight,
-									   string $urlRight,
-									   string $plainTextLeft = '',
-									   string $plainTextRight = '') {
-		if ($this->footerAdded) {
-			return;
-		}
-		if ($plainTextLeft === '') {
-			$plainTextLeft = $textLeft;
-			$textLeft = htmlspecialchars($textLeft);
-		}
-
-		if ($plainTextRight === '') {
-			$plainTextRight = $textRight;
-			$textRight = htmlspecialchars($textRight);
-		}
-
-		$this->ensureBodyIsOpened();
-		$this->ensureBodyListClosed();
-
-		$color = $this->themingDefaults->getColorPrimary();
-		$textColor = $this->themingDefaults->getTextColorPrimary();
-
-		$this->htmlBody .= vsprintf($this->buttonGroup, [$color, $color, $urlLeft, $color, $textColor, $textColor, $textLeft, $urlRight, $textRight]);
-		$this->plainBody .= $plainTextLeft . ': ' . $urlLeft . PHP_EOL;
-		$this->plainBody .= $plainTextRight . ': ' . $urlRight . PHP_EOL . PHP_EOL;
-	}
-
-	/**
-	 * Adds a button to the body of the email
-	 *
-	 * @param string $text Text of button; Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
-	 * @param string $url URL of button
-	 * @param string $plainText Text of button in plain text version
-	 * 		if empty the $text is used, if false none will be used
-	 *
-	 * @since 12.0.0
-	 */
-	public function addBodyButton(string $text, string $url, $plainText = '') {
-		if ($this->footerAdded) {
-			return;
-		}
-
-		$this->ensureBodyIsOpened();
-		$this->ensureBodyListClosed();
-
-		if ($plainText === '') {
-			$plainText = $text;
-			$text = htmlspecialchars($text);
-		}
-
-		$color = $this->themingDefaults->getColorPrimary();
-		$textColor = $this->themingDefaults->getTextColorPrimary();
-		$this->htmlBody .= vsprintf($this->button, [$color, $color, $url, $color, $textColor, $textColor, $text]);
-
-		if ($plainText !== false) {
-			$this->plainBody .= $plainText . ': ';
-		}
-
-		$this->plainBody .=  $url . PHP_EOL;
-	}
-
-	/**
-	 * Close the HTML body when it is open
-	 */
-	protected function ensureBodyIsClosed() {
-		if (!$this->bodyOpened) {
-			return;
-		}
-
-		$this->ensureBodyListClosed();
-
-		$this->htmlBody .= $this->bodyEnd;
-		$this->bodyOpened = false;
-	}
-
-	/**
-	 * Adds a logo and a text to the footer. <br> in the text will be replaced by new lines in the plain text email
-	 *
-	 * @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically sent email" will be used
-	 */
-	public function addFooter(string $text = '', ?string $lang = null) {
-		if ($text === '') {
-			$l10n = $this->l10nFactory->get('lib', $lang);
-			$text = $this->themingDefaults->getName() . ' - ' . $this->themingDefaults->getSlogan($lang) . '<br>' . $l10n->t('This is an automatically sent email, please do not reply.');
-		}
-
-		if ($this->footerAdded) {
-			return;
-		}
-		$this->footerAdded = true;
-
-		$this->ensureBodyIsClosed();
-
-		$this->htmlBody .= vsprintf($this->footer, [$text]);
-		$this->htmlBody .= $this->tail;
-		$this->plainBody .= PHP_EOL . '-- ' . PHP_EOL;
-		$this->plainBody .= str_replace('<br>', PHP_EOL, $text);
-	}
-
-	/**
-	 * Returns the rendered email subject as string
-	 *
-	 * @return string
-	 */
-	public function renderSubject(): string {
-		return $this->subject;
-	}
-
-	/**
-	 * Returns the rendered HTML email as string
-	 *
-	 * @return string
-	 */
-	public function renderHtml(): string {
-		if (!$this->footerAdded) {
-			$this->footerAdded = true;
-			$this->ensureBodyIsClosed();
-			$this->htmlBody .= $this->tail;
-		}
-		return $this->htmlBody;
-	}
-
-	/**
-	 * Returns the rendered plain text email as string
-	 *
-	 * @return string
-	 */
-	public function renderText(): string {
-		if (!$this->footerAdded) {
-			$this->footerAdded = true;
-			$this->ensureBodyIsClosed();
-			$this->htmlBody .= $this->tail;
-		}
-		return $this->plainBody;
-	}
+    public function __construct(Defaults $themingDefaults,
+                                IURLGenerator $urlGenerator,
+                                IFactory $l10nFactory,
+                                $emailId,
+                                array $data) {
+        $this->themingDefaults = $themingDefaults;
+        $this->urlGenerator = $urlGenerator;
+        $this->l10nFactory = $l10nFactory;
+        $this->htmlBody .= $this->head;
+        $this->emailId = $emailId;
+        $this->data = $data;
+    }
+
+    /**
+     * Sets the subject of the email
+     *
+     * @param string $subject
+     */
+    public function setSubject(string $subject) {
+        $this->subject = $subject;
+    }
+
+    /**
+     * Adds a header to the email
+     */
+    public function addHeader() {
+        if ($this->headerAdded) {
+            return;
+        }
+        $this->headerAdded = true;
+
+        $logoUrl = $this->urlGenerator->getAbsoluteURL($this->themingDefaults->getLogo(false));
+        $this->htmlBody .= vsprintf($this->header, [$this->themingDefaults->getColorPrimary(), $logoUrl, $this->themingDefaults->getName()]);
+    }
+
+    /**
+     * Adds a heading to the email
+     *
+     * @param string $title
+     * @param string|bool $plainTitle Title that is used in the plain text email
+     *   if empty the $title is used, if false none will be used
+     */
+    public function addHeading(string $title, $plainTitle = '') {
+        if ($this->footerAdded) {
+            return;
+        }
+        if ($plainTitle === '') {
+            $plainTitle = $title;
+        }
+
+        $this->htmlBody .= vsprintf($this->heading, [htmlspecialchars($title)]);
+        if ($plainTitle !== false) {
+            $this->plainBody .= $plainTitle . PHP_EOL . PHP_EOL;
+        }
+    }
+
+    /**
+     * Open the HTML body when it is not already
+     */
+    protected function ensureBodyIsOpened() {
+        if ($this->bodyOpened) {
+            return;
+        }
+
+        $this->htmlBody .= $this->bodyBegin;
+        $this->bodyOpened = true;
+    }
+
+    /**
+     * Adds a paragraph to the body of the email
+     *
+     * @param string $text Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
+     * @param string|bool $plainText Text that is used in the plain text email
+     *   if empty the $text is used, if false none will be used
+     */
+    public function addBodyText(string $text, $plainText = '') {
+        if ($this->footerAdded) {
+            return;
+        }
+        if ($plainText === '') {
+            $plainText = $text;
+            $text = htmlspecialchars($text);
+        }
+
+        $this->ensureBodyListClosed();
+        $this->ensureBodyIsOpened();
+
+        $this->htmlBody .= vsprintf($this->bodyText, [$text]);
+        if ($plainText !== false) {
+            $this->plainBody .= $plainText . PHP_EOL . PHP_EOL;
+        }
+    }
+
+    /**
+     * Adds a list item to the body of the email
+     *
+     * @param string $text Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
+     * @param string $metaInfo Note: When $plainMetaInfo falls back to this, HTML is automatically escaped in the HTML email
+     * @param string $icon Absolute path, must be 16*16 pixels
+     * @param string|bool $plainText Text that is used in the plain text email
+     *   if empty the $text is used, if false none will be used
+     * @param string|bool $plainMetaInfo Meta info that is used in the plain text email
+     *   if empty the $metaInfo is used, if false none will be used
+     * @since 12.0.0
+     */
+    public function addBodyListItem(string $text, string $metaInfo = '', string $icon = '', $plainText = '', $plainMetaInfo = '') {
+        $this->ensureBodyListOpened();
+
+        if ($plainText === '') {
+            $plainText = $text;
+            $text = htmlspecialchars($text);
+        }
+        if ($plainMetaInfo === '') {
+            $plainMetaInfo = $metaInfo;
+            $metaInfo = htmlspecialchars($metaInfo);
+        }
+
+        $htmlText = $text;
+        if ($metaInfo) {
+            $htmlText = '<em style="color:#777;">' . $metaInfo . '</em><br>' . $htmlText;
+        }
+        if ($icon !== '') {
+            $icon = '<img src="' . htmlspecialchars($icon) . '" alt="&bull;">';
+        } else {
+            $icon = '&bull;';
+        }
+        $this->htmlBody .= vsprintf($this->listItem, [$icon, $htmlText]);
+        if ($plainText !== false) {
+            $this->plainBody .= '  * ' . $plainText;
+            if ($plainMetaInfo !== false) {
+                $this->plainBody .= ' (' . $plainMetaInfo . ')';
+            }
+            $this->plainBody .= PHP_EOL;
+        }
+    }
+
+    protected function ensureBodyListOpened() {
+        if ($this->bodyListOpened) {
+            return;
+        }
+
+        $this->ensureBodyIsOpened();
+        $this->bodyListOpened = true;
+        $this->htmlBody .= $this->listBegin;
+    }
+
+    protected function ensureBodyListClosed() {
+        if (!$this->bodyListOpened) {
+            return;
+        }
+
+        $this->bodyListOpened = false;
+        $this->htmlBody .= $this->listEnd;
+    }
+
+    /**
+     * Adds a button group of two buttons to the body of the email
+     *
+     * @param string $textLeft Text of left button; Note: When $plainTextLeft falls back to this, HTML is automatically escaped in the HTML email
+     * @param string $urlLeft URL of left button
+     * @param string $textRight Text of right button; Note: When $plainTextRight falls back to this, HTML is automatically escaped in the HTML email
+     * @param string $urlRight URL of right button
+     * @param string $plainTextLeft Text of left button that is used in the plain text version - if unset the $textLeft is used
+     * @param string $plainTextRight Text of right button that is used in the plain text version - if unset the $textRight is used
+     */
+    public function addBodyButtonGroup(string $textLeft,
+                                        string $urlLeft,
+                                        string $textRight,
+                                        string $urlRight,
+                                        string $plainTextLeft = '',
+                                        string $plainTextRight = '') {
+        if ($this->footerAdded) {
+            return;
+        }
+        if ($plainTextLeft === '') {
+            $plainTextLeft = $textLeft;
+            $textLeft = htmlspecialchars($textLeft);
+        }
+
+        if ($plainTextRight === '') {
+            $plainTextRight = $textRight;
+            $textRight = htmlspecialchars($textRight);
+        }
+
+        $this->ensureBodyIsOpened();
+        $this->ensureBodyListClosed();
+
+        $color = $this->themingDefaults->getColorPrimary();
+        $textColor = $this->themingDefaults->getTextColorPrimary();
+
+        $this->htmlBody .= vsprintf($this->buttonGroup, [$color, $color, $urlLeft, $color, $textColor, $textColor, $textLeft, $urlRight, $textRight]);
+        $this->plainBody .= $plainTextLeft . ': ' . $urlLeft . PHP_EOL;
+        $this->plainBody .= $plainTextRight . ': ' . $urlRight . PHP_EOL . PHP_EOL;
+    }
+
+    /**
+     * Adds a button to the body of the email
+     *
+     * @param string $text Text of button; Note: When $plainText falls back to this, HTML is automatically escaped in the HTML email
+     * @param string $url URL of button
+     * @param string $plainText Text of button in plain text version
+     * 		if empty the $text is used, if false none will be used
+     *
+     * @since 12.0.0
+     */
+    public function addBodyButton(string $text, string $url, $plainText = '') {
+        if ($this->footerAdded) {
+            return;
+        }
+
+        $this->ensureBodyIsOpened();
+        $this->ensureBodyListClosed();
+
+        if ($plainText === '') {
+            $plainText = $text;
+            $text = htmlspecialchars($text);
+        }
+
+        $color = $this->themingDefaults->getColorPrimary();
+        $textColor = $this->themingDefaults->getTextColorPrimary();
+        $this->htmlBody .= vsprintf($this->button, [$color, $color, $url, $color, $textColor, $textColor, $text]);
+
+        if ($plainText !== false) {
+            $this->plainBody .= $plainText . ': ';
+        }
+
+        $this->plainBody .=  $url . PHP_EOL;
+    }
+
+    /**
+     * Close the HTML body when it is open
+     */
+    protected function ensureBodyIsClosed() {
+        if (!$this->bodyOpened) {
+            return;
+        }
+
+        $this->ensureBodyListClosed();
+
+        $this->htmlBody .= $this->bodyEnd;
+        $this->bodyOpened = false;
+    }
+
+    /**
+     * Adds a logo and a text to the footer. <br> in the text will be replaced by new lines in the plain text email
+     *
+     * @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically sent email" will be used
+     */
+    public function addFooter(string $text = '', ?string $lang = null) {
+        if ($text === '') {
+            $l10n = $this->l10nFactory->get('lib', $lang);
+            $text = $this->themingDefaults->getName() . ' - ' . $this->themingDefaults->getSlogan($lang) . '<br>' . $l10n->t('This is an automatically sent email, please do not reply.');
+        }
+
+        if ($this->footerAdded) {
+            return;
+        }
+        $this->footerAdded = true;
+
+        $this->ensureBodyIsClosed();
+
+        $this->htmlBody .= vsprintf($this->footer, [$text]);
+        $this->htmlBody .= $this->tail;
+        $this->plainBody .= PHP_EOL . '-- ' . PHP_EOL;
+        $this->plainBody .= str_replace('<br>', PHP_EOL, $text);
+    }
+
+    /**
+     * Returns the rendered email subject as string
+     *
+     * @return string
+     */
+    public function renderSubject(): string {
+        return $this->subject;
+    }
+
+    /**
+     * Returns the rendered HTML email as string
+     *
+     * @return string
+     */
+    public function renderHtml(): string {
+        if (!$this->footerAdded) {
+            $this->footerAdded = true;
+            $this->ensureBodyIsClosed();
+            $this->htmlBody .= $this->tail;
+        }
+        return $this->htmlBody;
+    }
+
+    /**
+     * Returns the rendered plain text email as string
+     *
+     * @return string
+     */
+    public function renderText(): string {
+        if (!$this->footerAdded) {
+            $this->footerAdded = true;
+            $this->ensureBodyIsClosed();
+            $this->htmlBody .= $this->tail;
+        }
+        return $this->plainBody;
+    }
 }
Please login to merge, or discard this patch.
nextcloud / server

Push — master ( da9ad9...c724eb )

Status

Category

Indentation +343 added lines, -343 removed lines patch added patch discarded remove patch
