Configure fields on Global Snippets/Configuration

Textareas where Snippets are available can now be easily selected on
Manage/Global Snippets/Configuration page.

Signed-off-by: Damien Regad <[email protected]>

Changes to original commit: whitespace

Author: tporadowski

README.md

@@ -60,10 +60,8 @@ current position. If text is currently selected, the Snippet will replace the
 selection.
 
 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 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).
+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

@@ -37,9 +37,11 @@ function xmlhttprequest_plugin_snippets() {
 
 	# 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) {
+	$textareaSelectors = array_map(
+		function($name) {
 			return "textarea[name='$name']";
-		}, preg_split("/[,;\s]+/", plugin_config_get("textarea_names", "bugnote_text"))
+		},
+		Snippet::get_configured_field_names()
 	);
 
 	$data = array(
@@ -59,6 +61,7 @@ function xmlhttprequest_plugin_snippets() {
 	plugin_pop_current();
 }
 
+
 /**
  * Object representing a saved block of text.
  */
@@ -343,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/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

@@ -34,6 +34,22 @@
 <td><select name="edit_own_threshold"><?php print_enum_string_option_list( 'access_levels', plugin_config_get( 'edit_own_threshold' ) ) ?></select></td>
 </tr>
 
+<tr <?php echo helper_alternate_class() ?>>
+<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>
+
 <tr>
 <td class="center" colspan="2"><input type="submit" value="<?php echo plugin_lang_get("action_update") ?>"/></td>
 </tr>
@@ -43,4 +59,3 @@
 
 <?php
 html_page_bottom();
-