simple_sitemap_views.install in Simple XML sitemap 4.x

Install and uninstall hooks for the simple_sitemap_views module.

File

modules/simple_sitemap_views/simple_sitemap_views.install

<?php

/**
 * @file
 * Install and uninstall hooks for the simple_sitemap_views module.
 */

/**
 * Implements hook_install().
 */
function simple_sitemap_views_install() {

  // Enable views display extender plugin.
  \Drupal::service('simple_sitemap.views')
    ->enable();
}

/**
 * Implements hook_uninstall().
 */
function simple_sitemap_views_uninstall() {

  // Disable views display extender plugin.
  \Drupal::service('simple_sitemap.views')
    ->disable();
}

/**
 * Implements hook_schema().
 */
function simple_sitemap_views_schema() {
  $schema['simple_sitemap_views'] = [
    'description' => 'Index of argument values for view pages.',
    'fields' => [
      'id' => [
        'type' => 'serial',
        'not null' => TRUE,
        'description' => 'Primary Key: Unique ID for argument values.',
      ],
      'view_id' => [
        'type' => 'varchar_ascii',
        'not null' => TRUE,
        'default' => '',
        'length' => 128,
        'description' => 'The ID of the view.',
      ],
      'display_id' => [
        'type' => 'varchar_ascii',
        'not null' => TRUE,
        'default' => '',
        'length' => 128,
        'description' => 'The ID of the view display.',
      ],
      'arguments_ids' => [
        'type' => 'varchar',
        'not null' => TRUE,
        'default' => '',
        'length' => 1024,
        'description' => 'A string representation of the set of argument identifiers.',
      ],
      'arguments_values' => [
        'type' => 'varchar',
        'not null' => TRUE,
        'default' => '',
        'length' => 1024,
        'description' => 'A string representation of the set of argument values.',
      ],
    ],
    'primary key' => [
      'id',
    ],
    'indexes' => [
      'arguments_ids' => [
        'view_id',
        'display_id',
        'arguments_ids',
      ],
    ],
  ];
  return $schema;
}

/**
 * Update views display extender config.
 */
function simple_sitemap_views_update_8301() {
  $config_factory = \Drupal::configFactory();
  $display_extender_name = 'simple_sitemap_display_extender';

  // Find all views configs.
  foreach ($config_factory
    ->listAll('views.view.') as $view_config_name) {
    $view = $config_factory
      ->getEditable($view_config_name);
    $changed = FALSE;

    // Go through each display on each view.
    $displays = $view
      ->get('display');
    foreach ($displays as $display_name => $display) {
      if (isset($display['display_options']['display_extenders'][$display_extender_name])) {
        $options = $display['display_options']['display_extenders'][$display_extender_name];
        if (!isset($options['variants']) && isset($options['variant'])) {
          $variant = $options['variant'];
          unset($options['variant']);

          // Update display extender config.
          $key = "display.{$display_name}.display_options.display_extenders.{$display_extender_name}";
          $options = [
            'variants' => [
              $variant => $options,
            ],
          ];
          $view
            ->set($key, $options);
          $changed = TRUE;
        }
      }
    }
    if ($changed) {
      $view
        ->save(TRUE);
    }
  }
}

/**
 * Remove unnecessary indexes.
 */
function simple_sitemap_views_update_8302() {
  $schema = \Drupal::database()
    ->schema();
  $schema
    ->dropIndex('simple_sitemap_views', 'view');
  $schema
    ->dropIndex('simple_sitemap_views', 'display');
}

Functions

Name	Description
simple_sitemap_views_install	Implements hook_install().
simple_sitemap_views_schema	Implements hook_schema().
simple_sitemap_views_uninstall	Implements hook_uninstall().
simple_sitemap_views_update_8301	Update views display extender config.
simple_sitemap_views_update_8302	Remove unnecessary indexes.