Merge pull request #3616 from s9e/ticket/13847

[ticket/13847] Move quote generation to text_formatter.utils

phpBB/phpbb/textformatter/s9e/utils.php

@@ -34,6 +34,44 @@ class utils implements \phpbb\textformatter\utils_interface
 		return \s9e\TextFormatter\Utils::removeFormatting($xml);
 	}
 
+	/**
+	* Return given string between quotes
+	*
+	* Will use either single- or double- quotes depending on whichever requires less escaping.
+	* Quotes and backslashes are escaped with backslashes where necessary
+	*
+	* @param  string $str Original string
+	* @return string      Escaped string within quotes
+	*/
+	protected function enquote($str)
+	{
+		$singleQuoted = "'" . addcslashes($str, "\\'") . "'";
+		$doubleQuoted = '"' . addcslashes($str, '\\"') . '"';
+
+		return (strlen($singleQuoted) < strlen($doubleQuoted)) ? $singleQuoted : $doubleQuoted;
+	}
+
+	/**
+	* {@inheritdoc}
+	*/
+	public function generate_quote($text, array $attributes = array())
+	{
+		$quote = '[quote';
+		if (isset($attributes['author']))
+		{
+			// Add the author as the BBCode's default attribute
+			$quote .= '=' . $this->enquote($attributes['author']);
+			unset($attributes['author']);
+		}
+		foreach ($attributes as $name => $value)
+		{
+			$quote .= ' ' . $name . '=' . $this->enquote($value);
+		}
+		$quote .= ']' . $text . '[/quote]';
+
+		return $quote;
+	}
+
 	/**
 	* Get a list of quote authors, limited to the outermost quotes
 	*

phpBB/phpbb/textformatter/utils_interface.php

@@ -28,6 +28,18 @@ interface utils_interface
 	*/
 	public function clean_formatting($text);
 
+	/**
+	* Create a quote block for given text
+	*
+	* Possible attributes:
+	*   - author
+	*
+	* @param  string $text       Quote's text
+	* @param  array  $attributes Quote's attributes
+	* @return string             Quote block to be used in a new post/text
+	*/
+	public function generate_quote($text, array $attributes = array());
+
 	/**
 	* Get a list of quote authors, limited to the outermost quotes
 	*