simple_timeline.module in A Simple Timeline 8

Contains simple_timeline.module.

File

simple_timeline.module

<?php

/**
 * @file
 * Contains simple_timeline.module.
 */
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Template\Attribute;

/**
 * Implements hook_help().
 */
function simple_timeline_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {

    // Main module help for the simple_timeline module.
    case 'help.page.simple_timeline':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('Provide a views style for displaying content in a vertical timeline') . '</p>';
      return $output;
    default:
  }
}

/**
 * Implements hook_theme_suggestions_HOOK_alter().
 */
function simple_timeline_theme_suggestions_views_view_simple_timeline_alter(array &$suggestions, array $variables) {
  $view = $variables['view'];
  $id = $view->storage
    ->id();
  $display = $view->current_display;
  $suggestions[] = 'views_view_simple_timeline__' . $id;
  $suggestions[] = 'views_view_simple_timeline__' . $display;
  $suggestions[] = 'views_view_simple_timeline__' . $id . '__' . $display;
}

/**
 * Prepares variables for Simple Timeline template.
 *
 * Default template: views-view-simple-timeline.html.twig.
 *
 * @param array $variables
 *   An associative array containing:
 *   - view: A View object.
 */
function template_preprocess_views_view_simple_timeline(&$variables) {
  $view = $variables['view'];
  $rows = $variables['rows'];
  $style = $view->style_plugin;
  $options = $style->options;

  // Add our specific class.
  $variables['list']['attributes'] = new Attribute([
    'class' => 'timeline-list',
  ]);

  // Fetch classes from options.
  if ($options['class']) {
    $class = explode(' ', $options['class']);
    $class = array_map('\\Drupal\\Component\\Utility\\Html::cleanCssIdentifier', $class);
    $variables['list']['attributes']
      ->addClass($class);
  }
  if ($options['position_items']) {
    $variables['list']['attributes']
      ->addClass($options['position_items']);
  }
  if ($options['position_marker']) {
    $variables['list']['attributes']
      ->addClass($options['position_marker']);
  }

  // Fetch wrapper classes from handler options.
  if ($options['wrapper_class']) {
    $wrapper_class = explode(' ', $options['wrapper_class']);
    $variables['attributes']['class'] = array_map('\\Drupal\\Component\\Utility\\Html::cleanCssIdentifier', $wrapper_class);
  }
  $count = 0;
  $variables['default_row_class'] = !empty($options['default_row_class']);
  foreach ($rows as $id => $row) {
    $count++;
    $variables['rows'][$id] = [];
    $variables['rows'][$id]['content'] = $row;
    $variables['rows'][$id]['attributes'] = new Attribute([
      'class' => 'timeline-item clearfix',
    ]);

    // Add odd/even class.
    $odd = $count % 2 ? 'odd' : 'even';
    $variables['rows'][$id]['attributes']
      ->addClass($odd);
    if ($row_class = $view->style_plugin
      ->getRowClass($id)) {
      $variables['rows'][$id]['attributes']
        ->addClass($row_class);
    }
  }
}

Functions

Name	Description
simple_timeline_help	Implements hook_help().
simple_timeline_theme_suggestions_views_view_simple_timeline_alter	Implements hook_theme_suggestions_HOOK_alter().
template_preprocess_views_view_simple_timeline	Prepares variables for Simple Timeline template.