Merge branch 'master-1.2.x'

Conflicts:
	Snippets/Snippets.php
	Snippets/pages/config_page.php

Author: dregad

README.md

@@ -58,11 +58,9 @@ 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.
-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)).
-
+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 via configuration page `Manage > Global Snippets > Configuration`.
 
 ## Support
 

Snippets/Snippets.API.php

@@ -35,13 +35,24 @@ 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']";
+		},
+		Snippet::get_configured_field_names()
+	);
+
 	$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);
@@ -50,6 +61,7 @@ function xmlhttprequest_plugin_snippets() {
 	plugin_pop_current();
 }
 
+
 /**
  * Object representing a saved block of text.
  */
@@ -334,5 +346,26 @@ public static function global_url($p_is_global = true) {
 		}
 		return '';
 	}
-}
 
+	/**
+	 * Returns an array with names of form fields (text areas) where snippets should be
+	 * available for selection.
+	 */
+	public static function get_configured_field_names() {
+		return preg_split("/[,;\s]+/", plugin_config_get("textarea_names", "bugnote_text"));
+	}
+
+	/**
+	 * Returns an array of ('text area field name' => 'language resource identifier') pairs
+	 * that describe available (supported) text areas. Values will be passed to lang_get().
+	 */
+	public static function get_available_field_names() {
+		return array(
+			'bugnote_text' => 'bugnote',
+			'description' => 'description',
+			'steps_to_reproduce' => 'steps_to_reproduce',
+			'additional_information' => 'additional_information',
+			'body' => 'reminder'
+		);
+	}
+}

Snippets/Snippets.php

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

Snippets/files/snippets.js

@@ -41,18 +41,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>");
 
@@ -87,7 +85,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() {

Snippets/lang/strings_english.txt

@@ -54,3 +54,4 @@ $s_plugin_Snippets_pattern_help = '
 	</table>
 	';
 
+$s_plugin_Snippets_textarea_names = 'Use Snippets For';

Snippets/lang/strings_french.txt

@@ -54,3 +54,4 @@ $s_plugin_Snippets_pattern_help = '
 	</table>
 	';
 
+$s_plugin_Snippets_textarea_names = 'Utiliser Bribes Pour';

Snippets/lang/strings_german.txt

@@ -53,3 +53,5 @@ $s_plugin_Snippets_pattern_help = '
 	<tr><td><strong>%p</strong></td><td>Projektname</td></tr>
 	</table>
 	';
+
+$s_plugin_Snippets_textarea_names = 'Verwende Textbausteinen in';

Snippets/pages/config.php

@@ -16,7 +16,7 @@ function maybe_set_option( $name, $value ) {
 maybe_set_option("edit_global_threshold", gpc_get_int("edit_global_threshold"));
 maybe_set_option("use_global_threshold", gpc_get_int("use_global_threshold"));
 maybe_set_option("edit_own_threshold", gpc_get_int("edit_own_threshold"));
+maybe_set_option("textarea_names", implode(",", gpc_get_string_array("textarea_names", '')));
 
 form_security_purge("plugin_Snippets_config");
 print_successful_redirect(plugin_page("config_page", true));
-

Snippets/pages/config_page.php

@@ -43,6 +43,24 @@
 			print_enum_string_option_list( 'access_levels', plugin_config_get( 'edit_own_threshold' ) );
 		?></select></td>
 	</tr>
+
+
+	<tr>
+		<td class="category"><?php echo plugin_lang_get( 'textarea_names' ) ?></td>
+		<td>
+<?php
+	$configuredNames = Snippet::get_configured_field_names();
+	$availableNames = Snippet::get_available_field_names();
+
+	foreach( $availableNames as $name => $lang_get_param ) {
+		echo '<div><label><input type="checkbox" name="textarea_names[]" value="', $name, '" ';
+		check_checked( in_array( $name, $configuredNames ) );
+		echo '/>', lang_get( $lang_get_param ), "</label></div>\n";
+	}
+?>
+		</td>
+	</tr>
+
 </tbody>
 
 <tfoot>
@@ -59,4 +77,3 @@
 
 <?php
 html_page_bottom();
-