views_test_data.module in Zircon Profile 8

Helper module for Views tests.

File

core/modules/views/tests/modules/views_test_data/views_test_data.module

<?php

/**
 * @file
 * Helper module for Views tests.
 */

/**
 * Access callback for the generic handler test.
 *
 * @return bool
 *   Returns views_test_data.tests->handler_access_callback config. so the user
 *   has access to the handler.
 *
 * @see \Drupal\views\Tests\Handler\HandlerTest
 */
function views_test_data_handler_test_access_callback() {
  return \Drupal::config('views_test_data.tests')
    ->get('handler_access_callback');
}

/**
 * Access callback with an argument for the generic handler test.
 *
 * @param bool $argument
 *   A parameter to test that an argument got passed.
 *
 * @return bool
 *   Returns views_test_data.tests->handler_access_callback_argument, so the
 *   use has access to the handler.
 *
 * @see \Drupal\views\Tests\Handler\HandlerTest
 */
function views_test_data_handler_test_access_callback_argument($argument = FALSE) {

  // Check the argument to be sure that access arguments are passed into the
  // callback.
  if ($argument) {
    return \Drupal::config('views_test_data.tests')
      ->get('handler_access_callback_argument');
  }
  else {
    return FALSE;
  }
}

/**
 * Implements hook_preprocess_HOOK() for views table templates.
 */
function views_test_data_preprocess_views_view_table(&$variables) {
  if ($variables['view']->storage
    ->id() == 'test_view_render') {
    $views_render_test = \Drupal::state()
      ->get('views_render.test');
    $views_render_test++;
    \Drupal::state()
      ->set('views_render.test', $views_render_test);
  }
}

/**
 * Prepares variables for the mapping row style test templates.
 *
 * Default template: views-view-mapping-test.html.twig.
 *
 * @param array $variables
 *   An associative array containing:
 *   - rows: A list of view rows.
 *   - options: Various view options, including the row style mapping.
 *   - view: The view object.
 */
function template_preprocess_views_view_mapping_test(&$variables) {
  $variables['element'] = array();
  foreach ($variables['rows'] as $delta => $row) {
    $fields = array();
    foreach ($variables['options']['mapping'] as $type => $field_names) {
      if (!is_array($field_names)) {
        $field_names = array(
          $field_names,
        );
      }
      foreach ($field_names as $field_name) {
        if ($value = $variables['view']->style_plugin
          ->getField($delta, $field_name)) {
          $fields[$type . '-' . $field_name] = $type . ':' . $value;
        }
      }
    }

    // If there are no fields in this row, skip to the next one.
    if (empty($fields)) {
      continue;
    }

    // Build a container for the row.
    $variables['element'][$delta] = array(
      '#type' => 'container',
      '#attributes' => array(
        'class' => array(
          'views-row-mapping-test',
        ),
      ),
    );

    // Add each field to the row.
    foreach ($fields as $key => $render) {
      $variables['element'][$delta][$key] = array(
        '#children' => $render,
        '#type' => 'container',
        '#attributes' => array(
          'class' => array(
            $key,
          ),
        ),
      );
    }
  }
}

/**
 * Test pre_render function.
 *
 * @param array $element
 *   A render array
 *
 * @return array
 *   The changed render array.
 */
function views_test_data_test_pre_render_function($element) {
  $element['#markup'] = 'views_test_data_test_pre_render_function executed';
  return $element;
}

Functions

Name	Description
template_preprocess_views_view_mapping_test	Prepares variables for the mapping row style test templates.
views_test_data_handler_test_access_callback	Access callback for the generic handler test.
views_test_data_handler_test_access_callback_argument	Access callback with an argument for the generic handler test.
views_test_data_preprocess_views_view_table	Implements hook_preprocess_HOOK() for views table templates.
views_test_data_test_pre_render_function	Test pre_render function.