2.1.0; closes #7, closes #8

Author: benkeen

.gitignore

@@ -1 +1,2 @@
-.svn*
+.DS_Store
+.idea

add.php

@@ -25,10 +25,19 @@
 );
 
 $page_vars["head_js"] =<<< EOF
+var check_field_identifier = function () {
+	var field = $("#field_identifier");
+	if (/[^a-zA-Z0-9_]/g.test(field.val())) {
+		return [[field, "{$L["validation_invalid_field_identifier"]}"]]; 
+	}
+	return true;
+}
+
 var rules = [];
 rules.push("required,template_hook,{$L["validation_no_template_hook"]}");
 rules.push("required,field_label,{$L["validation_no_field_label"]}");
 rules.push("required,field_type,{$L["validation_no_field_type"]}");
+rules.push("function,check_field_identifier");
 $(function() {
     ecf_ns.add_field_option(null, null);
     ecf_ns.add_field_option(null, null);

code/Fields.class.php

@@ -29,15 +29,17 @@ public static function addField($info, $L)
 
         $db->query("
             INSERT INTO {PREFIX}module_extended_client_fields (template_hook, admin_only, field_label, field_type,
-                option_source, option_list_id, field_orientation, default_value, is_required, error_string, field_order)
-            VALUES (:template_hook, :admin_only, :field_label, :field_type, :option_source, :option_list_id, :field_orientation,
-                :default_value, :is_required, :error_string, :list_order)
+                field_identifier, option_source, option_list_id, field_orientation, default_value, is_required,
+                error_string, field_order)
+            VALUES (:template_hook, :admin_only, :field_label, :field_type, :field_identifier, :option_source,
+            	:option_list_id, :field_orientation, :default_value, :is_required, :error_string, :list_order)
         ");
         $db->bindAll(array(
             "template_hook" => $info["template_hook"],
             "admin_only" => $info["admin_only"],
             "field_label" => $info["field_label"],
             "field_type" => $info["field_type"],
+            "field_identifier" => $info["field_identifier"],
             "option_source" => $info["option_source"],
             "option_list_id" => $option_list_id,
             "field_orientation" => $info["field_orientation"],
@@ -95,6 +97,7 @@ public static function updateField($client_field_id, $info, $L)
                         admin_only = :admin_only,
                         field_label = :field_label,
                         field_type = :field_type,
+                        field_identifier = :field_identifier,
                         option_source = :option_source,
                         option_list_id = :option_list_id,
                         field_orientation = :field_orientation,
@@ -109,6 +112,7 @@ public static function updateField($client_field_id, $info, $L)
                 "admin_only" => $info["admin_only"],
                 "field_label" => $info["field_label"],
                 "field_type" => $info["field_type"],
+				"field_identifier" => $info["field_identifier"],
                 "option_source" => $option_source,
                 "option_list_id" => $option_list_id,
                 "field_orientation" => $info["field_orientation"],
@@ -156,13 +160,13 @@ public static function updateField($client_field_id, $info, $L)
     }
 
 
-    /**
-     * Returns a page (or all) client fields.
-     *
-     * @param integer $page_num
-     * @param array $search a hash whose keys correspond to database column names
-     * @return array
-     */
+	/**
+	 * Returns a page (or all) client fields.
+	 * @param int $page_num
+	 * @param int $num_per_page
+	 * @param array $search
+	 * @return array
+	 */
     public static function getClientFields($page_num = 1, $num_per_page = 10, $search = array())
     {
         $db = Core::$db;
@@ -590,10 +594,8 @@ public static function updateFieldOrder($info, $L)
      * This function is attached to the admin_edit_view_client_map_filter_dropdown hook. It populates the
      * Edit View -> Client Map Filters -> client fields dropdown with any additional fields defined in this module.
      */
-    public static function displayExtendedFieldOptions($location, $template_vars)
+    public static function displayExtendedFieldOptions($template_vars, $L)
     {
-        $LANG = Core::$L;
-
         Modules::getModuleInstance("extended_client_fields");
 
         $client_fields = self::getClientFields(1, "all");
@@ -605,7 +607,7 @@ public static function displayExtendedFieldOptions($location, $template_vars)
         $client_map_filters = $template_vars["client_map_filters"];
         $selected_value     = $client_map_filters[$current_row-1]["filter_values"];
 
-        echo "<optgroup label=\"{$LANG["extended_client_fields"]["module_name"]}\">\n";
+        echo "<optgroup label=\"{$L["module_name"]}\">\n";
         foreach ($client_fields["results"] as $field_info) {
             $field_label = htmlspecialchars($field_info["field_label"]);
             $selected    = ($selected_value == "ecf_" . $field_info["client_field_id"]) ? "selected" : "";
@@ -649,27 +651,43 @@ public static function reorderFields()
 
 
     /**
-     * This is called by the "start" hook in the ft_get_view_filter_sql function. It
-     * adds the extended client field placeholder variable with the e
+     * This is called by the "start" hook in the ft_get_view_filter_sql function. It adds the extended client field
+	 * placeholder variable with the extended client field settings.
+	 *
+	 * Note: $info["placeholders"] already exists
      */
     public static function updateViewFilterSqlPlaceholders($info)
     {
-        $is_client_account = Core::$user->getAccountType() == "client";
-
-        if ($is_client_account) {
-            $settings = Sessions::get("account.settings");
-            if (is_array($settings)) {
-                foreach ($settings as $key => $value) {
-                    if (preg_match("/^ecf_(\d)+$/", $key, $matches)) {
-                        $info["placeholders"][$key] = $value;
-                    }
-                }
-            }
-        }
+    	$client_placeholders = self::getClientPlaceholders();
+
+		if (!empty($client_placeholders)) {
+			$info["placeholders"] = array_merge($info["placeholders"], $client_placeholders);
+		}
 
         return $info;
     }
 
+    // TODO be nice to refactor this now we added field_identifier in 2.1.0. Using "ecf_X" as an identifier is a bit kludgy
+	// but it means making the field_identifier column required for all extended client fields. For for now, internally
+	// we use ecf_X to target the field, whereas end users can use the field_identifier value within their placeholders
+	// e.g. {$CLIENT.identifier_here}
+    public static function getClientPlaceholders()
+	{
+		$is_client_account = Core::$user->getAccountType() == "client";
+		$placeholders = array();
+		if ($is_client_account) {
+			$settings = Sessions::get("account.settings");
+			if (is_array($settings)) {
+				foreach ($settings as $key => $value) {
+					if (preg_match("/^ecf_(\d)+$/", $key, $matches)) {
+						$placeholders[$key] = $value;
+					}
+				}
+			}
+		}
+
+		return $placeholders;
+	}
 
     private static function getNextFieldOrder ()
     {

code/Module.class.php

@@ -19,17 +19,21 @@ class Module extends FormToolsModule
     protected $author = "Ben Keen";
     protected $authorEmail = "ben.keen@gmail.com";
     protected $authorLink = "https://formtools.org";
-    protected $version = "2.0.4";
-    protected $date = "2018-05-07";
+    protected $version = "2.1.0";
+    protected $date = "2019-01-10";
     protected $originLanguage = "en_us";
     protected $jsFiles = array(
         "{MODULEROOT}/scripts/field_options.js"
     );
+	protected $cssFiles = array(
+		"{MODULEROOT}/css/styles.css"
+	);
 
     protected $nav = array(
         "module_name"           => array("index.php", false),
         "phrase_add_field"      => array("add.php", true),
         "phrase_section_titles" => array("titles.php", false),
+		"word_placeholders"     => array("placeholders.php", false),
         "word_help"             => array("help.php", false)
     );
 
@@ -44,6 +48,7 @@ public function install($module_id)
             admin_only enum('yes','no') default NULL,
             field_label varchar(255) NOT NULL,
             field_type enum('textbox','textarea','password','radios','checkboxes','select','multi-select') NOT NULL,
+            field_identifier varchar(255) NOT NULL,
             option_source enum('option_list', 'custom_list') NOT NULL DEFAULT 'option_list',
             option_list_id MEDIUMINT NULL,
             field_orientation enum('horizontal','vertical','na') NOT NULL default 'na',
@@ -119,7 +124,9 @@ public function uninstall($module_id)
     public function upgrade($module_id, $old_module_version)
     {
         $this->resetHooks();
-    }
+
+		self::addFieldIdentifierFieldIfNotExists();
+	}
 
 
     public function resetHooks()
@@ -146,6 +153,7 @@ public function resetHooks()
 
         // general code hooks
         Hooks::registerHook("code", "extended_client_fields", "start", "FormTools\\ViewFilters::getViewFilterSql", "updateViewFilterSqlPlaceholders");
+		Hooks::registerHook("code", "extended_client_fields", "main", "FormTools\\User->getAccountPlaceholders", "getExtendedClientFieldPlaceholders");
     }
 
 
@@ -205,14 +213,31 @@ public function insertHeadJs($location, $info)
     }
 
 
+    // 2.1.0 added a new field_identifier column to allow the extended client fields to be used elsewhere in Form Tools,
+	// namely as placeholders in the "Default Values for New Submissions" view setting:
+	// https://github.com/formtools/core/issues/472
+	// This adds the column to the database. Note: existing users will need to add in the identifiers manually to be
+	// able to the user the feature
+    public static function addFieldIdentifierFieldIfNotExists() {
+		$db = Core::$db;
+
+		if (!General::checkDbTableFieldExists("module_extended_client_fields", "field_identifier")) {
+			$db->query("
+				ALTER TABLE {PREFIX}module_extended_client_fields
+				ADD field_identifier VARCHAR(255) NULL AFTER field_type
+			");
+			$db->execute();
+		}
+	}
+
     // ---------------- wrappers for hook calls ------------------
 
     public function displayFields($location, $template_vars) {
         Fields::displayFields($location, $template_vars);
     }
 
     public function displayExtendedFieldOptions($location, $template_vars) {
-        Fields::displayExtendedFieldOptions($location, $template_vars);
+        Fields::displayExtendedFieldOptions($template_vars, $this->getLangStrings());
     }
 
     public function adminSaveExtendedClientFields($postdata) {
@@ -226,4 +251,56 @@ public function clientSaveExtendedClientFields($postdata) {
     public function updateViewFilterSqlPlaceholders($info) {
         return Fields::updateViewFilterSqlPlaceholders($info);
     }
+
+    // appends all ECF placeholders for use in the Default values for Submission fields (per View).
+    public function getExtendedClientFieldPlaceholders($info) {
+
+    	// we expect the account_id to be passed containing the client/admin account ID
+    	if (!isset($info["account_id"]) || empty($info["account_id"])) {
+    		return;
+		}
+
+    	// in { ecf_1 => "value", "ecf_2" => "value" } format
+    	$placeholders = Fields::getClientPlaceholders();
+    	if (empty($placeholders)) {
+    		return;
+		}
+
+    	$keys = array_keys($placeholders);
+
+    	$fields = Fields::getClientFields(1, "all");
+    	$found = array();
+    	foreach ($fields["results"] as $field_info) {
+    		$current_key = "ecf_{$field_info["client_field_id"]}";
+    		if (in_array($current_key, $keys) && !empty($field_info["field_identifier"])) {
+				$found[$field_info["field_identifier"]] = $placeholders[$current_key];
+			}
+		}
+		$info["placeholders"]["CLIENT"] = $found;
+
+		return $info;
+	}
 }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

css/styles.css

@@ -0,0 +1,3 @@
+.grey {
+    color: #999999;
+}

index.php

@@ -32,7 +32,6 @@
 $results     = $info["results"];
 $num_results = $info["num_results"];
 
-
 $page_vars = array(
     "results" => $results,
     "head_title" => $module->getModuleName(),

lang/en_us.php

@@ -21,13 +21,16 @@
 $L["word_bottom"] = "Bottom";
 $L["word_orientation"] = "Orientation";
 $L["word_settings"] = "Settings";
+$L["word_placeholder"] = "Placeholder";
+$L["word_placeholders"] = "Placeholders";
 $L["word_help"] = "Help";
 
 $L["phrase_add_field"] = "Add Field";
 $L["phrase_add_new_field"] = "Add New Field";
 $L["phrase_edit_field"] = "Edit Field";
 $L["phrase_field_label"] = "Field Label";
 $L["phrase_field_type"] = "Field Type";
+$L["phrase_field_identifier"] = "Field Identifier";
 $L["phrase_default_value"] = "Default Value";
 $L["phrase_page_and_location"] = "Page and Location";
 $L["phrase_main_account_page"] = "Main Account Page";
@@ -46,7 +49,7 @@
 
 $L["confirm_delete_field"] = "Are you sure you want to delete this field? This cannot be undone.";
 
-$L["notify_no_fields"] = "There are no additional fields added to the module yet. Click the button below to add a new field.";
+$L["notify_no_fields"] = "There are no fields created yet. Click the button below to add a new field.";
 $L["notify_problem_installing"] = "There following error occurred when trying to create the database tables for this module: <b>{\$error}</b>";
 $L["notify_field_added"] = "The field has been added. You may add another field below, <a href=\"edit.php?id={\$client_field_id}\">edit the last field</a>, or <a href=\"index.php\">return to the main field list page</a>.";
 $L["notify_admin_only_field_explanation"] = "This setting determines lets you hide the field from the client; it only appears for the the administrator.";
@@ -59,6 +62,7 @@
 $L["validation_no_template_hook"] = "Please choose the page and location where this field should appear.";
 $L["validation_no_field_label"] = "Please enter the field label.";
 $L["validation_no_field_type"] = "Please choose the field type.";
+$L["validation_invalid_field_identifier"] = "Please only enter alphanumeric (a-Z and 0-9) and the underscore character.";
 
-$L["text_help"] = "Please see our <a href=\"https://docs.formtools.org/modules/extended_client_fields/\" target=\"_blank\">online help documentation</a> for information on how to use this module.";
+$L["text_help"] = "Please see the <a href=\"https://docs.formtools.org/modules/extended_client_fields/\" target=\"_blank\">help documentation</a> for information about this module.";
 $L["text_client_field_titles_intro"] = "Your client fields can be inserted in different locations on the Edit Client pages, visible by the administrator and client. This page gives you the option of providing a title for each of the fields. These titles are omitted by default.";

placeholders.php

@@ -0,0 +1,24 @@
+<?php
+
+require("../../global/library.php");
+
+use FormTools\Modules;
+use FormTools\Modules\ExtendedClientFields\Fields;
+
+$module = Modules::initModulePage("admin");
+
+$info = Fields::getClientFields(1, "all");
+
+$results = array();
+foreach ($info["results"] as $row) {
+	if (empty($row["field_identifier"])) {
+		continue;
+	}
+	$results[] = $row;
+}
+
+$page_info = array(
+	"results" => $results
+);
+
+$module->displayPage("templates/placeholders.tpl", $page_info);