ACMS-4414: Move method from common to site studio and replace accordingly.

Author: rajeshreeputra

modules/acquia_cms_site_studio/acquia_cms_site_studio.install

@@ -47,8 +47,8 @@ function acquia_cms_site_studio_install($is_syncing) {
     $module_handler = \Drupal::service('module_handler');
     $entity_type_manager = \Drupal::entityTypeManager();
     if ($module_handler->moduleExists('acquia_cms_search')) {
-      _acquia_cms_common_update_view_display_options_style('search');
-      _acquia_cms_common_update_view_display_options_style('search_fallback');
+      _acquia_cms_site_studio_update_view_display_options_style('search');
+      _acquia_cms_site_studio_update_view_display_options_style('search_fallback');
 
       // Disable acquia_search view provided by Acquia Search Solrmodule,
       // so that search view provided by acquia_cms_search module can be used
@@ -74,20 +74,20 @@ function acquia_cms_site_studio_install($is_syncing) {
       // Update content views on module install.
       if ($module_handler->moduleExists('acquia_cms_search')) {
         if ($module_handler->moduleExists('acquia_cms_article')) {
-          _acquia_cms_common_update_view_display_options_style('articles');
-          _acquia_cms_common_update_view_display_options_style('articles_fallback');
+          _acquia_cms_site_studio_update_view_display_options_style('articles');
+          _acquia_cms_site_studio_update_view_display_options_style('articles_fallback');
         }
         if ($module_handler->moduleExists('acquia_cms_event')) {
-          _acquia_cms_common_update_view_display_options_style('events');
-          _acquia_cms_common_update_view_display_options_style('events_fallback');
+          _acquia_cms_site_studio_update_view_display_options_style('events');
+          _acquia_cms_site_studio_update_view_display_options_style('events_fallback');
         }
         if ($module_handler->moduleExists('acquia_cms_place')) {
-          _acquia_cms_common_update_view_display_options_style('places');
-          _acquia_cms_common_update_view_display_options_style('places_fallback');
+          _acquia_cms_site_studio_update_view_display_options_style('places');
+          _acquia_cms_site_studio_update_view_display_options_style('places_fallback');
         }
         if ($module_handler->moduleExists('acquia_cms_person')) {
-          _acquia_cms_common_update_view_display_options_style('people', 'default', 'view_tpl_people_grid');
-          _acquia_cms_common_update_view_display_options_style('people_fallback');
+          _acquia_cms_site_studio_update_view_display_options_style('people', 'default', 'view_tpl_people_grid');
+          _acquia_cms_site_studio_update_view_display_options_style('people_fallback');
         }
       }
     }
@@ -469,5 +469,5 @@ function acquia_cms_site_studio_update_9001() {
     ],
   ];
 
-  _acquia_cms_common_update_page_configurations('editor.editor.cohesion', $config_data);
+  _acquia_cms_site_studio_update_page_configurations('editor.editor.cohesion', $config_data);
 }

modules/acquia_cms_site_studio/acquia_cms_site_studio.module

@@ -301,6 +301,70 @@ function acquia_cms_site_studio_editor_insert(EditorInterface $editor) {
   if (!$editor->isSyncing()) {
     // Add text format permission to a developer role.
     $role = \Drupal::entityTypeManager()->getStorage('user_role')->load('developer');
-    $role->grantPermission('use text format ' . $editor->id())->save(TRUE);
+    if ($role instanceof Role) {
+      $role->grantPermission('use text format ' . $editor->id())->save(TRUE);
+    }
+  }
+}
+
+/**
+ * Helper function to update configuration for specified key.
+ *
+ * This is being used for updating page CT configurations.
+ *
+ * @param string $config_name
+ *   The configuration name which needs to be updated.
+ * @param array $configurations
+ *   An array of drupal configurations.
+ */
+function _acquia_cms_site_studio_update_page_configurations(string $config_name, array $configurations) {
+  $configFactory = \Drupal::service('config.factory');
+  $config = $configFactory->getEditable($config_name);
+  $need_save = FALSE;
+  if ($config) {
+    foreach ($configurations as $key => $value) {
+      if ($config->get($key) != $value) {
+        $config->set($key, $value);
+        $need_save = TRUE;
+      }
+    }
+    // Only save if there's changes in value.
+    if ($need_save) {
+      $config->save();
+    }
+  }
+}
+
+/**
+ * Helper function to update views display_options's style.
+ *
+ * @param string $view_name
+ *   The view names.
+ * @param string $display_id
+ *   The view display_id.
+ * @param string|null $views_template
+ *   The view template name.
+ *
+ * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
+ * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
+ * @throws \Drupal\Core\Entity\EntityStorageException
+ */
+function _acquia_cms_site_studio_update_view_display_options_style(string $view_name, string $display_id = 'default', string $views_template = NULL) {
+  /** @var \Drupal\Core\Entity\EntityStorageInterface $view_storage */
+  $view_storage = \Drupal::entityTypeManager()->getStorage('view');
+  /** @var \Drupal\views\ViewEntityInterface $view */
+  $view = $view_storage->load($view_name);
+  if (!$view) {
+    return;
+  }
+  $display = &$view->getDisplay($display_id);
+  $style_type = $display['display_options']['style']['type'] ?? NULL;
+  if ($style_type && $style_type !== 'cohesion_layout') {
+    $display['display_options']['style']['type'] = 'cohesion_layout';
+    $display['display_options']['style']['options'] = [
+      'views_template' => $views_template ?? 'view_tpl_' . $view_name,
+      'master_template' => 'master_template_boxed',
+    ];
+    $view_storage->save($view);
   }
 }

modules/acquia_cms_site_studio/composer.json

@@ -6,7 +6,6 @@
     "require": {
         "acquia/cohesion": "~7.4.0 || ~7.5.0 || ~8.0.0 || ~8.1.0",
         "acquia/cohesion-theme": "~7.4.0 || ~7.5.0 || ~8.0.0 || ~8.1.0",
-        "drupal/acquia_cms_common": "^2.1.12 || ~3.2.12 || ^3.3.10",
         "drupal/collapsiblock": "^4.0",
         "drupal/node_revision_delete": "^2.0",
         "drupal/responsive_preview": "^2.1",