From 29956c5957702a0b8d345d5ebb4b70fc4ccb003f Mon Sep 17 00:00:00 2001
From: Coleman Watts <coleman@civicrm.org>
Date: Tue, 17 Mar 2015 09:28:50 -0400
Subject: [PATCH] Api Explorer - Show marker for required fields

---
 templates/CRM/Admin/Page/APIExplorer.js  | 10 ++++++++--
 templates/CRM/Admin/Page/APIExplorer.tpl |  8 ++++++--
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/templates/CRM/Admin/Page/APIExplorer.js b/templates/CRM/Admin/Page/APIExplorer.js
index b83eab833b..b28273168b 100644
--- a/templates/CRM/Admin/Page/APIExplorer.js
+++ b/templates/CRM/Admin/Page/APIExplorer.js
@@ -56,8 +56,14 @@
     var $row = $('tr:last-child', '#api-params');
     $('input.api-param-name', $row).crmSelect2({
       data: fields.concat({id: '-', text: ts('Other') + '...', description: ts('Choose a field not in this list')}),
+      formatSelection: function(field) {
+        return field.text +
+          (field.required ? ' <span class="crm-marker">*</span>' : '');
+      },
       formatResult: function(field) {
-        return field.text + '<div class="api-field-desc">' + field.description + '</div>';
+        return field.text +
+          (field.required ? ' <span class="crm-marker">*</span>' : '') +
+          '<div class="api-field-desc">' + field.description + '</div>';
       }
     }).change();
   }
@@ -184,7 +190,7 @@
       params.placeholder = ts('Select field');
       params.multiple = false;
     }
-    $('#api-params').prepend($(returnTpl({title: title})));
+    $('#api-params').prepend($(returnTpl({title: title, required: action == 'getvalue'})));
     $('#api-return-value').crmSelect2(params);
   }
 
diff --git a/templates/CRM/Admin/Page/APIExplorer.tpl b/templates/CRM/Admin/Page/APIExplorer.tpl
index e6d5865e15..98cea80bc7 100644
--- a/templates/CRM/Admin/Page/APIExplorer.tpl
+++ b/templates/CRM/Admin/Page/APIExplorer.tpl
@@ -92,7 +92,8 @@
     color: #828282;
     line-height: 1.3em;
   }
-  .select2-highlighted .api-field-desc {
+  .select2-highlighted .api-field-desc,
+  .select2-highlighted .crm-marker {
     color: #fcfcfc;
   }
   .api-param-op[readonly] {
@@ -281,7 +282,10 @@
 <script type="text/template" id="api-return-tpl">
   <tr class="api-return-row">
     <td colspan="3">
-      <label for="api-return-value"><%- title %>:</label> &nbsp;
+      <label for="api-return-value">
+        <%- title %>:
+        <% if(required) {ldelim} %> <span class="crm-marker">*</span> <% {rdelim} %>
+      </label> &nbsp;
       <input type="hidden" class="api-param-name" value="return" />
       <input style="width: 50%;" id="api-return-value" class="crm-form-text api-param-value api-input"/>
     </td>
-- 
2.25.1