Merge pull request #20 from bugfolder/15_add_v4_shim_1

Issue #15: Add v4 shims option with v5 FontAwesome.

Author: yorkshire-pudding

config/font_awesome.settings.json

@@ -1,5 +1,6 @@
 {
   "_config_name": "font_awesome.settings",
-  "fontawesome": "v5"
+  "fontawesome": "v5",
+  "v4_shims": 0
 }
 

font_awesome.admin.inc

@@ -8,6 +8,9 @@
  * Form constructor for the Font Awesome settings form.
  */
 function font_awesome_admin_form($form, &$form_state) {
+  $form['#config'] = 'font_awesome.settings';
+  $config = config('font_awesome.settings');
+
   $form['fontawesome'] = array(
     '#type' => 'radios',
     '#title' => t('Enable Font Awesome icons'),
@@ -18,10 +21,21 @@ function font_awesome_admin_form($form, &$form_state) {
       'v5' => t('<a href="https://fontawesome.com/how-to-use/on-the-web/referencing-icons/basic-use" target="_blank">v5.2</a>'),
       'v5.15' => t('<a href="https://fontawesome.com/how-to-use/on-the-web/referencing-icons/basic-use" target="_blank">v5.15</a>'),
     ),
-    '#default_value' => config_get('font_awesome.settings', 'fontawesome'),
+    '#default_value' => $config->get('fontawesome'),
+  );
+
+  $form['v4_shims'] = array(
+    '#type' => 'checkbox',
+    '#title' => t('Include v4 shims'),
+    '#description' => t('Checking this box will allow you to use FontAwesome v4 icon names with FontAwesome v5. <a href="https://fontawesome.com/v5.15/how-to-use/graphql-api/objects/shim" target="_blank">Details here.</a>'),
+    '#default_value' => $config->get('v4_shims'),
+    '#states' => array(
+      'visible' => array(
+        array(':input[name="fontawesome"]' => array('value' => 'v5')),
+        array(':input[name="fontawesome"]' => array('value' => 'v5.15')),
+      ),
+    ),
   );
 
-  $form['#config'] = 'font_awesome.settings';
   return system_settings_form($form);
 }
-

font_awesome.install

@@ -4,6 +4,15 @@
  * Install, update, and uninstall functions for the Font Awesome module.
  */
 
+/**
+ * Add v4_shim option to settings and initialize.
+ */
+function font_awesome_update_1102(&$sandbox) {
+  $config = config('font_awesome.settings');
+  $config->set('v4_shim', 0);
+  $config->save();
+}
+
 /**
  * Remove 'pseudo' config value.
  */
@@ -42,4 +51,3 @@ function font_awesome_update_1001(&$sandbox) {
 function font_awesome_update_last_removed() {
   return 1000;
 }
-

font_awesome.module

@@ -29,11 +29,19 @@ function font_awesome_init() {
     case 'v4':
       backdrop_add_css('https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css', $options);
       break;
+
     case 'v5':
       backdrop_add_css('https://use.fontawesome.com/releases/v5.2.0/css/all.css', $options);
+      if (config_get('font_awesome.settings', 'v4_shims')) {
+        backdrop_add_css('https://use.fontawesome.com/releases/v5.2.0/css/v4-shims.css', $options);
+      }
       break;
+
     case 'v5.15':
       backdrop_add_css('https://use.fontawesome.com/releases/v5.15.4/css/all.css', $options);
+      if (config_get('font_awesome.settings', 'v4_shims')) {
+        backdrop_add_css('https://use.fontawesome.com/releases/v5.15.4/css/v4-shims.css', $options);
+      }
       break;
   }
 }