Make text areas configurable

Names of text areas which should have snippets available can now be
configured via `plugin_Snippets_textarea_names` configuration option
(default: "bugnote_text"), i.e. "bugnote_text, steps_to_reproduce".

It makes including other fields easier than hard-coding each new field
into code like proposed in issue #3.

Author: tporadowski

README.md

@@ -59,11 +59,11 @@ Once selection is made, the Snippet's text will be inserted in the field at the
 current position. If text is currently selected, the Snippet will replace the
 selection.
 
-Note that currently only the *Bug Note* field is configured to use Snippets.
+By default only the *Bug Note* field is configured to use Snippets.
 Other text fields (*Description*, *Steps To Reproduce* as well as *Additional
-Information*) can be setup to use Snippets with minimal configuration effort
-(see [this example](https://github.com/mantisbt-plugins/snippets/issues/3)).
-
+Information*) can be setup to use Snippets via configuration option `plugin_Snippets_textarea_names`
+where you can list names of fields you are interested in, i.e. `bugnote_text, steps_to_reproduce, body` (`body`
+refers to text area on *Send reminder* page).
 
 ## Support
 

Snippets/Snippets.API.php

@@ -35,13 +35,22 @@ function xmlhttprequest_plugin_snippets() {
 	$snippets = Snippet::load_by_type_user(0, $user_id, $use_global);
 	$snippets = Snippet::clean($snippets, "form", $bug_id);
 
+	# split names of textareas found in "plugin_Snippets_textarea_names" option and
+	#  make an array of "textarea[name='FIELD_NAME']" strings
+	$textareaSelectors = array_map(function($name) {
+			return "textarea[name='$name']";
+		}, preg_split("/[,;\s]+/", plugin_config_get("textarea_names", "bugnote_text"))
+	);
+
 	$data = array(
 		"snippets" => SnippetsPlugin::$_version,
+		# return configured jQuery selectors for textareas in "selector" field
+		"selector" => implode(",", $textareaSelectors)
 	);
 
-	# arrange the available snippets into the data array
+	# arrange the available snippets into the data array and return it in "texts" field
 	foreach($snippets as $snippet) {
-		$data["bugnote_text"][$snippet->id] = $snippet;
+		$data["texts"][$snippet->id] = $snippet;
 	}
 
 	$json = json_encode($data);

Snippets/Snippets.php

@@ -5,7 +5,7 @@
 # Licensed under the MIT license
 
 class SnippetsPlugin extends MantisPlugin {
-	public static $_version = "0.5";
+	public static $_version = "0.6";
 
 	public function register() {
 		$this->name = plugin_lang_get("name");
@@ -29,6 +29,7 @@ public function config() {
 			"edit_global_threshold" => ADMINISTRATOR,
 			"use_global_threshold" => REPORTER,
 			"edit_own_threshold" => REPORTER,
+			"textarea_names" => "bugnote_text",
 		);
 	}
 
@@ -89,5 +90,4 @@ public function schema() {
 				")),
 		);
 	}
-}
-
+}

Snippets/files/snippets.js

@@ -42,18 +42,16 @@ jQuery(document).ready(function($) {
 		 * then insert select boxes into the DOM for each supported textarea.
 		 */
 		function SnippetsInit() {
-			var textareas = $("textarea[name='bugnote_text']");
-
 			function SnippetsUI(data) {
 				var textarrays = data;
 
-				textareas.each(function(index) {
+				$(data.selector).each(function(index) {
 						var textarea_name = $(this).attr("name");
 						var textarea = $(this);
 
 						try {
 
-						snippets = textarrays[textarea_name];
+						snippets = textarrays["texts"];
 						if (snippets != null) {
 							label = $("<label>" + SnippetsLang("label") + " </label>");
 
@@ -88,7 +86,8 @@ jQuery(document).ready(function($) {
 					});
 			}
 
-			if (textareas.length > 0) {
+			//if we have any textareas then fetch snippets
+			if ($("textarea").length > 0) {
 				var bug_id = 0;
 
 				$("form[name='bugnoteadd'] input[name='bug_id']").each(function() {