simplenews_views.inc in Simplenews 5

simplenews_views.inc Views support for simplenews

File

simplenews_views.inc

<?php

/**
 * @file simplenews_views.inc
 * Views support for simplenews
 */

/**
 * Implementation of hook_views_tables
 */
function simplenews_views_tables() {
  $tables['simplenews_newsletters'] = array(
    'name' => 'simplenews_newsletters',
    'fields' => array(
      's_status' => array(
        'name' => t('Simplenews: Sent status'),
        'handler' => 'simplenews_handler_send_status',
        'help' => t('Newsletter send status: Not sent, Pending (being sent or waiting for cron to run), Sent. '),
        'sortable' => TRUE,
      ),
    ),
    'join' => array(
      'left' => array(
        'table' => 'node',
        'field' => 'nid',
      ),
      'right' => array(
        'field' => 'nid',
      ),
    ),
    'sorts' => array(
      's_status' => array(
        'name' => t('Simplenews: Sent status'),
        'help' => t('Sort by sent status; Ascending = Not sent > Pending > Sent'),
      ),
    ),
    'filters' => array(
      's_status' => array(
        'name' => t('Simplenews: Sent status'),
        'list' => 'simplenews_handler_filter_send_status',
        'list-type' => 'list',
        'operator' => 'views_handler_operator_or',
        'value-type' => 'array',
        'help' => t('Include or exclude status of the selected state.'),
      ),
    ),
  );
  return $tables;
}

/**
 * Views field handler for newsletter send status
 */
function simplenews_handler_send_status($fieldinfo, $fielddata, $value, $data) {
  $status = _simplenews_handler_send_status_data();
  return $status[$value];
}

/**
 * Views filter handler for newsletter send status
 */
function simplenews_handler_filter_send_status($op) {
  return _simplenews_handler_send_status_data();
}

/**
 * Helper function for send status handlers
 */
function _simplenews_handler_send_status_data() {
  return array(
    0 => t('Not sent'),
    1 => t('Pending'),
    2 => t('Sent'),
  );
}

Functions

Name	Description
simplenews_handler_filter_send_status	Views filter handler for newsletter send status
simplenews_handler_send_status	Views field handler for newsletter send status
simplenews_views_tables	Implementation of hook_views_tables
_simplenews_handler_send_status_data	Helper function for send status handlers