Updates settings forms with config vars

cybtachyon · cybtachyon · commit 37d566ec26e6 · 2019-08-29T12:30:31.000-04:00
fix(PatternkitSettingsForm)
diff --git a/config/install/patternkit.settings.yml b/config/install/patternkit.settings.yml
@@ -4,4 +4,5 @@ patternkit_json_editor_css: ""
 patternkit_json_editor_icons: fontawesome5
 patternkit_json_editor_js: ""
 patternkit_json_editor_theme: bootstrap4
+patternkit_libraries: []
 patternkit_render_cache: true
diff --git a/patternkit.links.task.yml b/patternkit.links.task.yml
@@ -14,6 +14,10 @@ patternkit.list_sub:
   title: Blocks
   route_name: entity.patternkit_block.collection
   parent_id: entity.patternkit_block.collection
+patternkit.settings:
+  title: 'Patternkit Settings'
+  route_name: patternkit.settings
+  base_route: patternkit.settings
 patternkit.settings.json_settings:
   title: 'JSON Pattern Library Settings'
   route_name: patternkit.settings.json_settings
diff --git a/src/Form/PatternLibraryJSONForm.php b/src/Form/PatternLibraryJSONForm.php
@@ -86,17 +86,19 @@ class PatternLibraryJSONForm extends ConfigFormBase {
   public function buildForm(array $form, FormStateInterface $form_state) :array {
     $config = $this->config(static::SETTINGS);
 
+    $themes = array_keys(static::THEMES);
     $form['patternkit_json_editor_theme'] = array(
       '#type' => 'select',
       '#title' => t('Select the JSON Editor Theme'),
-      '#options' => array_keys(static::THEMES),
+      '#options' => array_combine($themes, $themes),
       '#default_value' => $config->get('patternkit_json_editor_theme'),
     );
 
+    $icons = array_keys(static::ICONS);
     $form['patternkit_json_editor_icons'] = array(
       '#type' => 'select',
       '#title' => t('Select the icons to be used with the editor'),
-      '#options' => array_keys(static::ICONS),
+      '#options' => array_combine($icons, $icons),
       '#default_value' => $config->get('patternkit_json_editor_icons'),
     );
 
diff --git a/src/Form/PatternkitSettingsForm.php b/src/Form/PatternkitSettingsForm.php
@@ -6,7 +6,6 @@
 use Drupal\Core\Form\ConfigFormBase;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\patternkit\PatternkitLibraryDiscoveryInterface;
-use Exception;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 class PatternkitSettingsForm extends ConfigFormBase {
@@ -38,51 +37,77 @@ public function buildForm(array $form, FormStateInterface $form_state) :array {
     try {
       $libraries = $this->libraryDiscovery->getLibraries();
     }
-    catch (Exception $exception) {
+    catch (\Exception $exception) {
       $this->getLogger('patternkit')->error('Unable to load Patternkit libraries list: @message', ['@message' => $exception->getMessage()]);
       \Drupal::messenger()->addMessage(t('Unable to load Patternkit libraries list. Check the logs for more information.'), 'error');
       return [
         '#markup' => $this->t('Settings are unavailable when Pattern libraries fail to load to prevent config errors.'),
       ];
     }
-    $library_options = array();
-    $library_values = array();
+
+    $form['patternkit_libraries'] = [
+      '#type' => 'table',
+      '#header' => [$this->t('Patternkit Library'),
+        ['data' => $this->t('Enabled'), 'class' => ['checkbox']],
+        ['data' => $this->t('Visible in Lists'), 'class' => ['checkbox']],
+      ],
+      '#attributes' => ['class' => ['libraries', 'js-libraries']],
+      '#sticky' => TRUE,
+    ];
+    $library_options = $config->get('patternkit_libraries') ?? [];
     foreach ($libraries as $lib_title => $library) {
       $lib_desc = $library['description'] ?? $lib_title;
       if (!empty($library['patterns'])) {
-        $library_values[] = $lib_title;
-        $lib_desc = t('@title (@count patterns)', array(
+        $lib_desc = t('@title (@count patterns)', [
           '@title' => $lib_title,
           '@count' => count($library['patterns']),
-        ));
+        ]);
+      }
+      $form['patternkit_libraries'][$lib_title]['description'] = [
+        '#type' => 'inline_template',
+        '#template' => '<div class="library"><span class="title">{{ title }}</span>{% if description or warning %}<div class="description">{{ description }}</div>{% endif %}</div>',
+        '#context' => [
+          'title' => $lib_desc,
+        ],
+      ];
+      if (!empty($library['description'])) {
+        $form['patternkit_libraries'][$lib_title]['description']['#context']['description'] = $library['description'];
       }
-      $library_options[$lib_title] = $lib_desc;
+      $form['patternkit_libraries'][$lib_title]['enabled'] = [
+        '#title' => $this->t('Library Enabled'),
+        '#title_display' => 'invisible',
+        '#wrapper_attributes' => ['class' => ['checkbox']],
+        '#type' => 'checkbox',
+        '#default_value' => $library_options[$lib_title]['enabled'] ?? 1,
+        '#attributes' => ['class' => ['lib-' . $lib_title, 'js-lib-' . $lib_title]],
+      ];
+      $form['patternkit_libraries'][$lib_title]['visible'] = [
+        '#title' => $this->t('Library Visible in Lists'),
+        '#title_display' => 'invisible',
+        '#wrapper_attributes' => ['class' => ['checkbox']],
+        '#type' => 'checkbox',
+        '#default_value' => $library_options[$lib_title]['visible'] ?? 1,
+        '#attributes' => ['class' => ['lib-' . $lib_title, 'js-lib-' . $lib_title]],
+      ];
     }
-    $form['patternkit_libraries'] = array(
-      '#type' => 'checkboxes',
-      '#title' => t('Enabled Patternkit Libraries'),
-      '#options' => $library_options,
-      '#default_value' => $library_values,
-      '#disabled' => TRUE,
-    );
-
-    $form['patternkit_cache_enabled'] = array(
+
+    $form['patternkit_cache_enabled'] = [
       '#type' => 'checkbox',
       '#title' => t('Use the Patternkit Library Cache'),
       '#default_value' => $config->get('patternkit_cache_enabled'),
-    );
+    ];
 
-    $form['patternkit_render_cache'] = array(
+    $form['patternkit_render_cache'] = [
       '#type' => 'checkbox',
       '#title' => t('Use the Patternkit Disk Render Cache'),
       '#default_value' => $config->get('patternkit_render_cache'),
-    );
+    ];
 
-    $form['patternkit_default_module_ttl'] = array(
+    $form['patternkit_default_module_ttl'] = [
       '#type' => 'textfield',
       '#title' => t('Patternkit Default Pattern TTL (in ms)'),
       '#default_value' => $config->get('patternkit_default_module_ttl'),
-    );
+    ];
 
     return parent::buildForm($form, $form_state);
   }
@@ -106,7 +131,13 @@ public function getFormId() :string {
    */
   public function submitForm(array &$form, FormStateInterface $form_state): void {
     $config = $this->config(static::SETTINGS);
-    if ($form_state['values']['patternkit_cache_enabled']
+    $config
+      ->set('patternkit_libraries', $form_state->getValue('patternkit_libraries'))
+      ->set('patternkit_cache_enabled', $form_state->getValue('patternkit_cache_enabled'))
+      ->set('patternkit_render_cache', $form_state->getValue('patternkit_render_cache'))
+      ->set('patternkit_default_module_ttl', $form_state->getValue('patternkit_default_module_ttl'))
+      ->save();
+    if ($form_state->getValue('patternkit_cache_enabled')
       && !$config->get('patternkit_cache_enabled')) {
       $this->libraryDiscovery->clearCachedDefinitions();
     }
diff --git a/src/PatternLibraryCollector.php b/src/PatternLibraryCollector.php
@@ -16,7 +16,6 @@
 use Drupal\Core\Serialization\Yaml;
 use Drupal\Core\Theme\ThemeManagerInterface;
 use Drupal\patternkit\Form\PatternkitSettingsForm;
-use function str_replace;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Drupal\Core\Cache\CacheCollector;
 use Drupal\Core\Lock\LockBackendInterface;
diff --git a/src/Plugin/Derivative/PatternkitBlock.php b/src/Plugin/Derivative/PatternkitBlock.php
@@ -3,16 +3,19 @@
 namespace Drupal\patternkit\Plugin\Derivative;
 
 use Drupal\Component\Plugin\Derivative\DeriverBase;
+use Drupal\Core\Config\ImmutableConfig;
 use Drupal\Core\Entity\EntityStorageInterface;
 use Drupal\Core\Logger\LoggerChannelInterface;
 use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
+use Drupal\patternkit\Form\PatternkitSettingsForm;
 use Drupal\patternkit\PatternkitLibraryDiscoveryInterface;
-use Exception;
 use Symfony\Component\DependencyInjection\ContainerInterface;
-use function strstr;
 
 class PatternkitBlock extends DeriverBase implements ContainerDeriverInterface {
 
+  /** @var \Drupal\Core\Config\ImmutableConfig */
+  protected $config;
+
   /**
    * Logs to the patternkit channel.
    *
@@ -29,14 +32,21 @@ class PatternkitBlock extends DeriverBase implements ContainerDeriverInterface {
   /**
    * PatternkitBlock constructor.
    *
+   * @param \Drupal\Core\Config\ImmutableConfig $config
+   *   Provides patternkit configurable settings.
    * @param \Drupal\Core\Logger\LoggerChannelInterface $logger
    *   Generates and provides log channels.
    * @param \Drupal\patternkit\PatternkitLibraryDiscoveryInterface $pattern_discovery
    *   Provides a list of pattern libraries with metadata.
    * @param \Drupal\Core\Entity\EntityStorageInterface $storage
    *   Loads and saves entities to storage.
    */
-  public function __construct(LoggerChannelInterface $logger, PatternkitLibraryDiscoveryInterface $pattern_discovery, EntityStorageInterface $storage) {
+  public function __construct(
+    ImmutableConfig $config,
+    LoggerChannelInterface $logger,
+    PatternkitLibraryDiscoveryInterface $pattern_discovery,
+    EntityStorageInterface $storage) {
+    $this->config = $config;
     $this->logger = $logger;
     $this->libraryDiscovery = $pattern_discovery;
     $this->patternkitStorage = $storage;
@@ -51,13 +61,17 @@ public function __construct(LoggerChannelInterface $logger, PatternkitLibraryDis
    *   Thrown if the storage handler couldn't be loaded.
    */
   public static function create(ContainerInterface $container, $base_plugin_id): PatternkitBlock {
+    /** @var \Drupal\Core\Config\ConfigFactoryInterface $config_factory */
+    $config_factory = $container->get('config.factory');
+    $config = $config_factory->get(PatternkitSettingsForm::SETTINGS);
     /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager */
     $entity_manager = $container->get('entity.manager');
     /** @var \Drupal\Core\Logger\LoggerChannelInterface $logger */
     $logger = $container->get('logger.channel.patternkit');
     /** @var \Drupal\patternkit\PatternkitLibraryDiscoveryInterface $pattern_discovery */
     $pattern_discovery = $container->get('patternkit.library.discovery');
     return new static(
+      $config,
       $logger,
       $pattern_discovery,
       $entity_manager->getStorage('patternkit_block'));
@@ -77,15 +91,22 @@ public function getDerivativeDefinitions($base_definition): array {
       /** @var \Drupal\patternkit\Pattern[] $patterns */
       $patterns = $this->libraryDiscovery->getAssets();
     }
-    catch (Exception $exception) {
+    catch (\Exception $exception) {
       $this->logger->error('Error loading patterns for derivative blocks: @message', ['@message' => $exception->getMessage()]);
     }
+
+    $libraries_config = $this->config->get('patternkit_libraries');
     foreach ($patterns as $pattern_id => $pattern) {
+      $lib = strstr($pattern_id, '.', TRUE);
+      if (isset($libraries_config[$lib])
+        && ($libraries_config[$lib]['enabled'] === 0 || $libraries_config[$lib]['visible'] === 0)) {
+        continue;
+      }
       $this->derivatives[$pattern_id] = [
         'category'    => t(
           'Patternkit:@lib/@category',
           [
-            '@lib'     => strstr($pattern_id, '.', TRUE) ?? 'patternkit',
+            '@lib'     => $lib ?? 'patternkit',
             '@category' => $pattern->category ?? 'default',
           ]
         ),
diff --git a/src/StreamWrapper/LibraryStream.php b/src/StreamWrapper/LibraryStream.php
@@ -2,7 +2,6 @@
 
 namespace Drupal\patternkit\StreamWrapper;
 
-use function array_merge;
 use Drupal\Core\Asset\AttachedAssets;
 use Drupal\Core\StreamWrapper\PublicStream;
 
