home | career | drupal | java | mac | mysql | perl | php | scala | uml | unix

Drupal example source code file (views_export.module)

This example Drupal source code file (views_export.module) is included in the DevDaily.com "Drupal Source Code Warehouse" project. The intent of this project is to help you "Learn Drupal by Example".

PHP - Drupal tags/keywords

api, array, exportables, foreach, function, module, name, output, php, tags, title, type, views

The views_export.module Drupal example source code

<?php
// $Id: views_export.module,v 1.9 2009/09/15 17:27:03 merlinofchaos Exp $

/**
 * @file views_export.module
 *
 * Provides functionality to export multiple items at once to make it easy to
 * dump a set of views into code.
 */

/**
 * Implementation of hook_menu().
 */
function views_export_menu() {
  $items = array();
  $items['admin/build/views/tools/export'] = array(
    'title' => 'Bulk export',
    'access arguments' => array('use views exporter'),
    'page callback' => 'views_export_export',
    'type' => MENU_LOCAL_TASK,
  );

  $items['admin/build/views/tools/export/results'] = array(
    'access arguments' => array('use views exporter'),
    'page callback' => 'views_export_export',
    'type' => MENU_CALLBACK,
  );

  return $items;
}

function views_export_theme() {
  return array(
    'views_export_export_form' => array(
      'args' => array('form' => NULL),
    ),
  );
}

/**
 * Implementation of hook_perm().
 */
function views_export_perm() {
  return array('use views exporter');
}

/**
 * Page callback to export views in bulk.
 */
function views_export_export() {
  $tags = array();
  if (!empty($_GET['tags'])) {
    $tags = explode(',', $_GET['tags']);
  }

  $exportables = array();
  foreach (module_implements('views_exportables') as $module) {
    $function = $module . '_views_exportables';
    $exportables[$module] = $function('list', $tags);
    asort($exportables[$module]);
  }

  if ($exportables) {
    $form_state = array(
      'no_redirect' => TRUE,
      'exportables' => $exportables,
      'tags' => $tags,
    );

    $output = drupal_build_form('views_export_export_form', $form_state);
    if (!$output) {
      $output = $form_state['output'];
    }
    return $output;
  }
  else {
    return t('There are no views to be exported at this time.');
  }
}

/**
 * Form to choose a group of views to export.
 */
function views_export_export_form(&$form_state) {
  foreach ($form_state['exportables'] as $module => $views) {
    foreach ($views as $name => $data) {
      $options[$name] = $data['name'];
    }

    $form['modules']['#tree'] = TRUE;
    $form['modules'][$module] = array(
      '#type' => 'checkboxes',
      '#options' => $options,
      '#default_value' => array(),
    );
  }

  $tags = array();
  foreach (views_get_all_views() as $name => $view) {
    if (!empty($view->tag)) {
      $tags[$view->tag] = $view->tag;
    }
  }

  asort($tags);

  $form['tags'] = array(
    '#type' => 'select',
    '#title' => t('Show only these tags'),
    '#options' => $tags,
    '#default_value' => $form_state['tags'],
    '#multiple' => TRUE,
  );

  $form['apply'] = array(
    '#type' => 'submit',
    '#value' => t('Apply'),
    '#submit' => array('views_export_export_form_apply'),
  );

  $form['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Module name'),
    '#description' => t('Enter the module name to export code to.'),
  );

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Export'),
  );

  $form['#action'] = url('admin/build/views/tools/export/results');
  $form['#redirect'] = FALSE;
  $form['#exportables'] = $form_state['exportables'];
  return $form;
}

function theme_views_export_export_form($form) {
  $output = '';
  $files = module_rebuild_cache();
  $exportables = $form['#exportables'];
  $output .= drupal_render($form['tags']);
  $output .= drupal_render($form['apply']);
  $output .= '<div class="clear-block">';

  foreach ($exportables as $module => $views) {
    $header = array(theme('table_select_header_cell'), $files[$module]->info['name'], t('Tag'), t('Description'));
    $rows = array();
    foreach ($views as $name => $view) {
      $title = $form['modules'][$module][$name]['#title'];
      unset($form['modules'][$module][$name]['#title']);
      $rows[] = array(drupal_render($form['modules'][$module][$name]), $title, $view['tag'], '<div class="description">' . $view['desc'] . '</div>');
    }
    $output .= '<div class="export-container">';
    $output .= theme('table', $header, $rows);
    $output .= "</div>\n";
  }
  $output .= '</div>';
  drupal_add_css(drupal_get_path('module', 'views_export') . '/views_export.css');
  $output .= drupal_render($form);
  return $output;
}

function views_export_export_form_apply(&$form, &$form_state) {
  $tags = $form_state['values']['tags'];
  if ($tags) {
    drupal_goto('admin/build/views/tools/export', array('tags' => implode(',', $tags)));
  }
  else {
    drupal_goto('admin/build/views/tools/export');
  }
}

function views_export_export_form_submit(&$form, &$form_state) {
  $code = '';
  if (empty($form_state['values']['name'])) {
    $form_state['values']['name'] = 'foo';
  }

  foreach ($form_state['values']['modules'] as $module => $views) {
    $views = array_filter($views);
    asort($views);
    if ($views) {
      $code .= module_invoke($module, 'views_exportables', 'export', $views, $form_state['values']['name']) . "\n\n";
    }
  }

  $lines = substr_count($code, "\n");

  $types = system_elements();

  $info  = "; \$Id" . ": $\n"; // The break in the string prevents CVS.
  $info .= "\n";
  $info .= strtr("name = @module Export Module\n", array('@module' => $form_state['values']['name']));
  $info .= strtr("description = Exports some views of @module\n", array('@module' => $form_state['values']['name']));
  $info .= "dependencies[] = views\n";
  $info .= "core = 6.x\n";


  $element_info = array(
    '#title' => t('Put this in @module.info in your modules/@module directory',  array('@module' => $form_state['values']['name'])),
    '#type' => 'textarea',
    '#id' => 'export-info-textarea',
    '#name' => 'export-info-textarea',
    '#attributes' => array(),
    '#rows' => 9,
    '#cols' => 60,
    '#value' => $info,
    '#parents' => array('dummy'),
    '#required' => FALSE,
  ) + $types['textarea'];

  $api  = "/**\n";
  $api .= " * Implementation of hook_views_api().\n";
  $api .= " */\n";
  $api .= "function @module_views_api() {\n";
  $api .= "  return array(\n";
  $api .= "    'api' => 2,\n";
  $api .= "    'path' => drupal_get_path('module', '@module'),\n";
  $api .= "    //'path' => drupal_get_path('module', '@module') . '/includes',\n";
  $api .= "  );\n";
  $api .= "}";

  $api = strtr($api, array('@module' => check_plain($form_state['values']['name'])));

  $element_api = array(
    '#title' => t('Put this in @module.module in your modules/@module directory', array('@module' => $form_state['values']['name'])),
    '#type' => 'textarea',
    '#id' => 'export-api-textarea',
    '#name' => 'export-api-textarea',
    '#attributes' => array( 'dir' => 'ltr' ),
    '#rows' => 9,
    '#cols' => 60,
    '#value' => $api,
    '#parents' => array('dummy'),
    '#required' => FALSE,
  ) + $types['textarea'];

  $element_hook = array(
    '#title' => t('Put this in @module.views_default.inc in your modules/@module directory or modules/@module/includes directory', array('@module' => $form_state['values']['name'])),
    '#type' => 'textarea',
    '#id' => 'export-textarea',
    '#name' => 'export-textarea',
    '#attributes' => array( 'dir' => 'ltr' ),
    '#rows' => min($lines, 150),
    '#value' => $code,
    '#parents' => array('dummy'),
    '#required' => FALSE,
  ) + $types['textarea'];


  $form_state['output'] = theme('textarea', $element_info);
  $form_state['output'] .= theme('textarea', $element_api);
  $form_state['output'] .= theme('textarea', $element_hook);
}

Other Drupal examples (source code examples)

Here is a short list of links related to this Drupal views_export.module source code file:

new blog posts

"Drupal" is a registered trademark of Dries Buytaert.

my drupal tutorials and examples  

Copyright 1998-2016 Alvin Alexander, alvinalexander.com
All Rights Reserved.

Beginning in 2016, a portion of the proceeds from pages under the '/drupal-code-examples/' URI will be donated to charity.