Merge pull request #13345 from GinkgoFJG/generic-settings-form

Added support to generic settings form for sorting settings by weight.
civicrm · Jan 3, 2019 · a7e974f · a7e974f
2 parents 75d01ce + 51f3527
commit a7e974f
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 3 deletions.
diff --git a/CRM/Admin/Form/Generic.php b/CRM/Admin/Form/Generic.php
@@ -61,18 +61,19 @@ public function setDefaultValues() {
     $this->setDefaultsForMetadataDefinedFields();
     return $this->_defaults;
   }
+
   /**
    * Build the form object.
    */
   public function buildQuickForm() {
-    $filter = array_pop($this->urlPath);
+    $filter = $this->getSettingPageFilter();
     $settings = civicrm_api3('Setting', 'getfields', [])['values'];
     foreach ($settings as $key => $setting) {
       if (isset($setting['settings_pages'][$filter])) {
         $this->_settings[$key] = $setting;
       }
     }
-    // @todo sort settings by weight.
+
     $this->addFieldsDefinedInSettingsMetadata();
 
     // @todo look at sharing the code below in the settings trait.

diff --git a/CRM/Admin/Form/SettingTrait.php b/CRM/Admin/Form/SettingTrait.php
@@ -38,6 +38,13 @@
  */
 trait CRM_Admin_Form_SettingTrait {
 
+  /**
+   * The setting page filter.
+   *
+   * @var string
+   */
+  private $_filter;
+
   /**
    * @var array
    */
@@ -118,6 +125,44 @@ protected function getSettingMetadataItem($setting, $item) {
     return CRM_Utils_Array::value($item, $this->getSettingsMetaData()[$setting]);
   }
 
+  /**
+   * @return string
+   */
+  protected function getSettingPageFilter() {
+    if (!isset($this->_filter)) {
+      // Get the last URL component without modifying the urlPath property.
+      $urlPath = array_values($this->urlPath);
+      $this->_filter = end($urlPath);
+    }
+    return $this->_filter;
+  }
+
+  /**
+   * Returns a re-keyed copy of the settings, ordered by weight.
+   *
+   * @return array
+   */
+  protected function getSettingsOrderedByWeight() {
+    $settingMetaData = $this->getSettingsMetaData();
+    $filter = $this->getSettingPageFilter();
+
+    usort($settingMetaData, function ($a, $b) use ($filter) {
+      // Handle cases in which a comparison is impossible. Such will be considered ties.
+      if (
+        // A comparison can't be made unless both setting weights are declared.
+        !isset($a['settings_pages'][$filter]['weight'], $b['settings_pages'][$filter]['weight'])
+        // A pair of settings might actually have the same weight.
+        || $a['settings_pages'][$filter]['weight'] === $b['settings_pages'][$filter]['weight']
+      ) {
+        return 0;
+      }
+
+      return $a['settings_pages'][$filter]['weight'] > $b['settings_pages'][$filter]['weight'] ? 1 : -1;
+    });
+
+    return $settingMetaData;
+  }
+
   /**
    * Add fields in the metadata to the template.
    */
@@ -207,7 +252,7 @@ protected function addFieldsDefinedInSettingsMetadata() {
     // setting_description should be deprecated - see Mail.tpl for metadata based tpl.
     $this->assign('setting_descriptions', $descriptions);
     $this->assign('settings_fields', $settingMetaData);
-    $this->assign('fields', $settingMetaData);
+    $this->assign('fields', $this->getSettingsOrderedByWeight());
   }
 
   /**