You are here

Home » API reference » Module Filter 8.3

module_filter.module in Module Filter 8.3

Same filename and directory in other branches
  1. 8 module_filter.module
  2. 6 module_filter.module
  3. 7.2 module_filter.module
  4. 7 module_filter.module

Provides a filtering mechanism to various admin pages.

File

module_filter.module
View source 
<?php

/**
 * @file
 * Provides a filtering mechanism to various admin pages.
 */
use Drupal\Core\Render\Element;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;

/**
 * Implements hook_help().
 */
function module_filter_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.module_filter':
      $output = '';
      $output .= '<p>';
      $output .= t('The modules list page can become quite big when dealing with a fairly large site or even just a dev site meant for testing new and various modules being considered.');
      $output .= '</p>';
      $output .= '<p>';
      $output .= t('What this module aims to accomplish is the ability to quickly find the module you are looking for without having to rely on the browsers search feature which more times than not shows you the module name in the -Required by- or -Depends on- sections of the various modules or even some other location on the page like a menu item.');
      $output .= '</p>';
      $output .= '<p>';
      $output .= t('See the <a href=":project_page">project page on Drupal.org</a> for more details.', [
        ':project_page' => 'https://www.drupal.org/project/module_filter',
      ]);
      return $output;
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function module_filter_form_system_modules_alter(&$form, FormStateInterface $form_state, $form_id) {
  $config = \Drupal::config('module_filter.settings');
  $key = array_search('system/drupal.system.modules', $form['#attached']['library']);
  if ($key !== FALSE) {
    unset($form['#attached']['library'][$key]);
  }
  $form['#attached']['library'][] = $config
    ->get('tabs') ? 'module_filter/modules.tabs' : 'module_filter/modules.bare';
  unset($form['filters']['text']['#description']);
  $form['filters']['text']['#placeholder'] = t('Filter by name');
  if (!empty($_GET['filter'])) {
    $form['filters']['text']['#default_value'] = $_GET['filter'];
  }
  $status_defaults = [
    isset($_GET['enabled']) ? $_GET['enabled'] : 1 ? 'enabled' : '',
    isset($_GET['disabled']) ? $_GET['disabled'] : 1 ? 'disabled' : '',
    isset($_GET['unavailable']) ? $_GET['unavailable'] : 1 ? 'unavailable' : '',
  ];
  $form['filters']['status'] = [
    '#type' => 'container',
    '#attributes' => [
      'class' => [
        'module-filter-status',
      ],
    ],
    'checkboxes' => [
      '#type' => 'checkboxes',
      '#default_value' => array_filter($status_defaults),
      '#options' => [
        'enabled' => t('Enabled'),
        'disabled' => t('Disabled'),
        'unavailable' => t('Unavailable'),
      ],
    ],
  ];
  $state = \Drupal::state();
  $recent = $state
    ->get('module_filter.recent') ?: [];

  // Remove recent items older than a week.
  $recent = array_filter($recent, function ($val) {
    return !($val < \Drupal::time()
      ->getRequestTime() - 60 * 60 * 24 * 7);
  });
  $state
    ->set('module_filter.recent', $recent);
  if (!empty($recent)) {
    foreach ($recent as $module => $time) {
      foreach (Element::children($form['modules']) as $package) {
        if (isset($form['modules'][$package][$module])) {
          $form['modules'][$package][$module]['#attributes']['class'][] = 'recent';
          break;
        }
      }
    }
  }
  $modules = \Drupal::service('extension.list.module')
    ->reset()
    ->getList();
  foreach ($modules as $name => $module) {
    if ($name == 'module_filter') {
      $ctime = filectime($module
        ->getPathname());
      if ($ctime - strtotime('-1 week') > 0) {
        foreach (Element::children($form['modules']) as $package) {
          if (isset($form['modules'][$package][$name])) {
            $form['modules'][$package][$name]['#attributes']['class'][] = 'new';
            break;
          }
        }
      }
    }
  }
  $form['#submit'][] = 'module_filter_system_modules_recent_enabled_submit';
  $form['#submit'][] = 'module_filter_system_modules_redirect_submit';
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function module_filter_form_system_modules_confirm_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  $form['filters']['text'] = [
    '#type' => 'value',
    '#value' => isset($_GET['filter']) ? $_GET['filter'] : '',
  ];
  $form['#submit'][] = 'module_filter_system_modules_redirect_submit';
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function module_filter_form_system_modules_uninstall_alter(&$form, FormStateInterface $form_state, $form_id) {
  $key = array_search('system/drupal.system.modules', $form['#attached']['library']);
  if ($key !== FALSE) {
    unset($form['#attached']['library'][$key]);
  }
  $form['#attached']['library'][] = 'module_filter/modules.uninstall';
  unset($form['filters']['text']['#description']);
  $form['filters']['text']['#placeholder'] = t('Filter by name');
  if (!empty($_GET['filter'])) {
    $form['filters']['text']['#default_value'] = $_GET['filter'];
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function module_filter_form_user_admin_permissions_alter(&$form, FormStateInterface $form_state, $form_id) {
  $form['filters'] = [
    '#type' => 'container',
    '#attributes' => [
      'class' => [
        'table-filter',
        'js-show',
      ],
    ],
  ];
  $form['filters']['text'] = [
    '#type' => 'search',
    '#title' => t('Filter modules'),
    '#title_display' => 'invisible',
    '#size' => 30,
    '#placeholder' => t('Filter by name'),
    '#attributes' => [
      'class' => [
        'table-filter-text',
      ],
      'data-table' => '#permissions',
      'autocomplete' => 'off',
    ],
    '#weight' => -1000,
  ];
  if (!empty($_GET['filter'])) {
    $form['filters']['text']['#default_value'] = $_GET['filter'];
  }
  $form['#attached']['library'][] = 'module_filter/permissions';
}

/**
 * Implements hook_theme_registry_alter().
 */
function module_filter_theme_registry_alter(&$theme_registry) {

  // We need to alter the system-modules-details template so we can add
  // applicable requires and required-by classes.
  $theme_registry['system_modules_details']['path'] = drupal_get_path('module', 'module_filter') . '/templates';
}

/**
 * Implements hook_preprocess_HOOK().
 */
function module_filter_preprocess_system_modules_details(&$variables) {
  $display_path = \Drupal::config('module_filter.settings')
    ->get('path');
  if ($display_path) {
    foreach ($variables['modules'] as &$module) {

      // Get the module id from parents.
      // Because core does not provide it in template_preprocess_system_modules_details.
      $id = $module['name']['#parents'][1];
      $path = drupal_get_path('module', $id);
      if (!empty($path)) {
        $module['path'] = $path;
      }
    }
  }
}

/**
 * Form submit callback to track recently enabled modules.
 */
function module_filter_system_modules_recent_enabled_submit($form, FormStateInterface $form_state) {
  $state = \Drupal::state();
  $recent = $state
    ->get('module_filter.recent') ?: [];

  // Drupal 8.3.0 simplified the module form structure which requires checking
  // the version of Drupal and building the $modules array accordingly.
  // @see https://www.drupal.org/node/2851653
  $modules = [];
  if (version_compare(\Drupal::VERSION, '8.3.0', '<')) {
    foreach ($form_state
      ->getValue('modules') as $package) {
      $modules += $package;
    }
  }
  else {
    $modules = $form_state
      ->getValue('modules');
  }
  foreach (Element::children($form['modules']) as $package) {
    foreach ($modules as $module => $details) {
      if (isset($form['modules'][$package][$module]) && $form['modules'][$package][$module]['enable']['#default_value'] != $details['enable']) {
        $recent[$module] = \Drupal::time()
          ->getRequestTime();
      }
    }
  }
  $state
    ->set('module_filter.recent', $recent);
}

/**
 * Form submit callback for remembering the filter value.
 */
function module_filter_system_modules_redirect_submit($form, FormStateInterface $form_state) {
  if ($text = $form_state
    ->getValue('text')) {

    /** @var \Drupal\Core\Url $redirect */
    $route_name = ($redirect = $form_state
      ->getRedirect()) ? $redirect
      ->getRouteName() : 'system.modules_list';
    $form_state
      ->setRedirect($route_name, [
      'filter' => $text,
    ]);
  }
}

Functions

Namesort descending Description
module_filter_form_system_modules_alter Implements hook_form_FORM_ID_alter().
module_filter_form_system_modules_confirm_form_alter Implements hook_form_FORM_ID_alter().
module_filter_form_system_modules_uninstall_alter Implements hook_form_FORM_ID_alter().
module_filter_form_user_admin_permissions_alter Implements hook_form_FORM_ID_alter().
module_filter_help Implements hook_help().
module_filter_preprocess_system_modules_details Implements hook_preprocess_HOOK().
module_filter_system_modules_recent_enabled_submit Form submit callback to track recently enabled modules.
module_filter_system_modules_redirect_submit Form submit callback for remembering the filter value.
module_filter_theme_registry_alter Implements hook_theme_registry_alter().