123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731 |
- <?php
- /**
- * @file
- * Views hooks implemented for the Webform module.
- */
- /**
- * Implements hook_views_data().
- */
- function webform_views_data() {
- // Webform table definitions.
- $data['webform']['table']['group'] = t('Webform');
- $data['webform']['table']['base'] = array(
- 'field' => 'nid',
- 'title' => t('Webform nodes'),
- 'help' => t('Nodes which have webforms.'),
- );
- $data['webform']['table']['join'] = array(
- 'node' => array(
- 'left_field' => 'nid',
- 'field' => 'nid',
- 'type' => 'INNER',
- ),
- );
- // NID.
- $data['webform']['nid'] = array(
- 'title' => t('Node'),
- 'help' => t('The node this webform is part of.'),
- 'relationship' => array(
- 'base' => 'node',
- 'field' => 'nid',
- 'handler' => 'views_handler_relationship',
- 'label' => t('Node for webform'),
- ),
- 'filter' => array(
- 'handler' => 'views_handler_filter_numeric',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- 'argument' => array(
- 'handler' => 'views_handler_argument_node_nid',
- // The field to display in the summary.
- 'name field' => 'title',
- 'numeric' => TRUE,
- 'validate type' => 'nid',
- ),
- );
- // Status.
- $data['webform']['status'] = array(
- 'title' => t('Status'),
- 'help' => t('The open or closed status of a webform.'),
- 'field' => array(
- 'handler' => 'webform_handler_field_webform_status',
- 'click sortable' => TRUE,
- ),
- 'filter' => array(
- 'label' => t('Status'),
- 'handler' => 'webform_handler_filter_webform_status',
- 'type' => 'open-closed',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- );
- // Submissions table definitions.
- $data['webform_submissions']['table']['group'] = t('Webform submissions');
- $data['webform_submissions']['table']['base'] = array(
- 'field' => 'sid',
- 'title' => t('Webform submissions'),
- 'help' => t('Submissions generated from Webform forms.'),
- );
- // Serial number.
- $data['webform_submissions']['serial'] = array(
- 'title' => t('Serial number'),
- 'help' => t('The serial number of the submission.'),
- 'field' => array(
- 'handler' => 'views_handler_field_numeric',
- 'click sortable' => TRUE,
- ),
- 'filter' => array(
- 'title' => t('Serial number'),
- 'handler' => 'views_handler_filter_numeric',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- 'argument' => array(
- 'handler' => 'views_handler_argument_numeric',
- ),
- );
- // SID.
- $data['webform_submissions']['sid'] = array(
- 'title' => t('Sid'),
- 'help' => t('The submission ID of the submission.'),
- 'field' => array(
- 'handler' => 'views_handler_field_numeric',
- 'click sortable' => TRUE,
- ),
- 'filter' => array(
- 'title' => t('Sid'),
- 'handler' => 'views_handler_filter_numeric',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- 'argument' => array(
- 'handler' => 'views_handler_argument_numeric',
- ),
- );
- // Submission data as a field loads the entire submission.
- $data['webform_submissions']['value'] = array(
- 'title' => t('Value'),
- 'help' => t('The value of a component as submitted by a user.'),
- 'real field' => 'sid',
- 'group' => t('Webform submission data'),
- 'field' => array(
- 'handler' => 'webform_handler_field_submission_data',
- 'webform_expand' => FALSE,
- 'click sortable' => TRUE,
- ),
- );
- // Expanded to generate a field for every viewable component.
- $data['webform_submissions']['webform_all_fields'] = array(
- 'title' => t('All values'),
- 'help' => t('Displays all values as submitted by a user.'),
- 'real field' => 'sid',
- 'group' => t('Webform submission data'),
- 'field' => array(
- 'handler' => 'webform_handler_field_submission_data',
- 'webform_expand' => TRUE,
- 'click sortable' => TRUE,
- ),
- );
- // NID.
- $data['webform_submissions']['nid'] = array(
- 'title' => t('Node'),
- 'help' => t('The webform node this submission was generated from.'),
- 'relationship' => array(
- 'base' => 'node',
- 'field' => 'nid',
- 'handler' => 'views_handler_relationship',
- 'label' => t('Webform Node'),
- ),
- 'filter' => array(
- 'handler' => 'views_handler_filter_numeric',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- 'argument' => array(
- 'handler' => 'views_handler_argument_node_nid',
- // The field to display in the summary.
- 'name field' => 'title',
- 'numeric' => TRUE,
- 'validate type' => 'nid',
- ),
- );
- // UID.
- $data['webform_submissions']['uid'] = array(
- 'title' => t('User'),
- 'help' => t('The user who sent the webform submission.'),
- 'relationship' => array(
- 'base' => 'users',
- 'field' => 'uid',
- 'handler' => 'views_handler_relationship',
- 'label' => t('Webform Submission User'),
- ),
- 'filter' => array(
- 'handler' => 'views_handler_filter_user_name',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- 'argument' => array(
- 'handler' => 'views_handler_argument_numeric',
- ),
- 'field' => array(
- 'handler' => 'views_handler_field_user',
- ),
- );
- // Is draft.
- $data['webform_submissions']['is_draft'] = array(
- 'title' => t('Draft'),
- 'help' => t('Whether or not the submission is a draft.'),
- 'field' => array(
- 'handler' => 'webform_handler_field_is_draft',
- 'click sortable' => TRUE,
- ),
- 'filter' => array(
- 'handler' => 'webform_handler_filter_is_draft',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- );
- // Submitted timestamp.
- $data['webform_submissions']['submitted'] = array(
- 'title' => t('Submitted'),
- 'help' => t('Timestamp when the form was first saved as draft or submitted.'),
- 'field' => array(
- 'handler' => 'views_handler_field_date',
- 'click sortable' => TRUE,
- ),
- 'filter' => array(
- 'title' => t('Submitted'),
- 'handler' => 'views_handler_filter_date',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort_date',
- ),
- 'argument' => array(
- 'handler' => 'views_handler_argument_date',
- ),
- );
- // Completed timestamp.
- $data['webform_submissions']['completed'] = array(
- 'title' => t('Completed'),
- 'help' => t('Timestamp when the form was submitted as complete (not draft).'),
- 'field' => array(
- 'handler' => 'views_handler_field_date',
- 'click sortable' => TRUE,
- ),
- 'filter' => array(
- 'title' => t('Completed'),
- 'handler' => 'views_handler_filter_date',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort_date',
- ),
- 'argument' => array(
- 'handler' => 'views_handler_argument_date',
- ),
- );
- // Modified timestamp.
- $data['webform_submissions']['modified'] = array(
- 'title' => t('Modified'),
- 'help' => t('Timestamp when the form was last saved (complete or draft).'),
- 'field' => array(
- 'handler' => 'views_handler_field_date',
- 'click sortable' => TRUE,
- ),
- 'filter' => array(
- 'title' => t('Modified'),
- 'handler' => 'views_handler_filter_date',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort_date',
- ),
- 'argument' => array(
- 'handler' => 'views_handler_argument_date',
- ),
- );
- // IP Address (remote_addr).
- $data['webform_submissions']['remote_addr'] = array(
- 'title' => t('Remote address'),
- 'help' => t('The remote IP address of the user that submitted this submission.'),
- 'field' => array(
- 'handler' => 'views_handler_field',
- 'click sortable' => TRUE,
- ),
- 'filter' => array(
- 'title' => t('Remote address'),
- 'handler' => 'views_handler_filter_string',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- );
- // View submission link.
- $data['webform_submissions']['view_submission'] = array(
- 'title' => t('View link'),
- 'help' => t('Provide a simple link to view the submission.'),
- 'real field' => 'serial',
- 'field' => array(
- 'handler' => 'webform_handler_field_submission_link',
- 'click sortable' => TRUE,
- 'real field' => 'serial',
- 'link_type' => 'view',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- );
- // Edit submission link.
- $data['webform_submissions']['edit_submission'] = array(
- 'title' => t('Edit link'),
- 'help' => t('Provide a simple link to edit the submission.'),
- 'real field' => 'serial',
- 'field' => array(
- 'handler' => 'webform_handler_field_submission_link',
- 'click sortable' => TRUE,
- 'link_type' => 'edit',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- );
- // Delete submission link.
- $data['webform_submissions']['delete_submission'] = array(
- 'title' => t('Delete link'),
- 'help' => t('Provide a simple link to delete the submission.'),
- 'real field' => 'serial',
- 'field' => array(
- 'handler' => 'webform_handler_field_submission_link',
- 'click sortable' => TRUE,
- 'link_type' => 'delete',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- );
- // Relation to webform_submitted_data table.
- $data['webform_submissions']['data'] = array(
- 'title' => t('Data'),
- 'help' => t('Relates to a webform submission data'),
- 'real field' => 'sid',
- 'relationship' => array(
- 'handler' => 'webform_handler_relationship_submission_data',
- 'base' => 'webform_submitted_data',
- 'base field' => 'sid',
- 'label' => t('Submission Data'),
- ),
- );
- // Submission data table definitions.
- $data['webform_submitted_data']['table']['group'] = t('Webform submission data');
- // Raw access to the submitted values. This usually will only be used for
- // sorts and filters, since the 'value' field for the submission will often
- // be faster and easier to configure than the raw values.
- $data['webform_submitted_data']['data'] = array(
- 'table' => 'webform_submitted_data',
- 'title' => t('Data field'),
- 'help' => t('The value of a component as submitted by a user.'),
- 'real field' => 'data',
- 'field' => array(
- // Distinguish from the normal value handler.
- 'title' => t('Value (raw)'),
- 'help' => t('The raw value from the database as submitted by a user. Use only when needing to sort on a field value.'),
- 'handler' => 'views_handler_field',
- 'click sortable' => TRUE,
- ),
- 'argument' => array(
- 'handler' => 'views_handler_argument_string',
- ),
- 'filter' => array(
- 'handler' => 'webform_handler_filter_submission_data',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- );
- // Same as 'data', but handled as numeric data.
- $data['webform_submitted_data']['data_numeric'] = array(
- 'table' => 'webform_submitted_data',
- 'title' => t('Data field (numeric)'),
- 'help' => t('The numeric value of a component as submitted by a user.'),
- 'real field' => 'data',
- 'field' => array(
- // Distinguish from the normal value handler.
- 'title' => t('Numeric value (raw)'),
- 'help' => t('The raw value from the database, cast to a number, as submitted by a user. Use only when needing to sort on a field value.'),
- 'handler' => 'webform_handler_field_numeric_data',
- 'click sortable' => TRUE,
- 'float' => TRUE,
- ),
- 'argument' => array(
- 'handler' => 'views_handler_argument_numeric',
- ),
- 'filter' => array(
- 'handler' => 'webform_handler_filter_numeric_data',
- ),
- 'sort' => array(
- 'handler' => 'webform_handler_sort_numeric_data',
- ),
- );
- // Number field for multi-value fields.
- $data['webform_submitted_data']['no'] = array(
- 'title' => t('Value delta'),
- 'help' => t('The delta value of the submitted data in a multi value component (such as checkboxes).'),
- 'real field' => 'no',
- 'argument' => array(
- 'handler' => 'views_handler_argument_numeric',
- ),
- 'field' => array(
- 'handler' => 'views_handler_field_numeric',
- ),
- 'filter' => array(
- 'handler' => 'views_handler_filter_numeric',
- ),
- 'sort' => array(
- 'handler' => 'views_handler_sort',
- ),
- );
- return $data;
- }
- /**
- * Implements hook_views_data_alter().
- */
- function webform_views_data_alter(&$data) {
- // Webform submission from node.
- $data['node']['webform_submission'] = array(
- 'title' => t('Webform submission'),
- 'help' => t('Webform submissions of the given Webform node.'),
- 'real field' => 'nid',
- 'relationship' => array(
- 'base' => 'webform_submissions',
- 'base field' => 'nid',
- 'handler' => 'views_handler_relationship',
- 'label' => t('Webform Submission'),
- ),
- );
- $data['node']['table']['join']['webform_submissions'] = array(
- 'field' => 'nid',
- 'left_field' => 'nid',
- 'left_table' => 'webform_submissions',
- );
- // Submission count (node).
- $data['node']['webform_submission_count_node'] = array(
- 'group' => t('Webform'),
- 'field' => array(
- 'title' => t('Webform submission count'),
- 'help' => t('The number of webform submissions on this node.'),
- 'handler' => 'webform_handler_field_submission_count',
- 'count_type' => 'node',
- ),
- );
- // Webform submission of user.
- $data['users']['webform_submission'] = array(
- 'title' => t('Webform submission'),
- 'help' => t('Webform submissions of the given user.'),
- 'real field' => 'uid',
- 'relationship' => array(
- 'base' => 'webform_submissions',
- 'base field' => 'uid',
- 'handler' => 'views_handler_relationship',
- 'label' => t('Webform Submission'),
- ),
- );
- // Submission count (user).
- $data['users']['webform_submission_count_user'] = array(
- 'field' => array(
- 'title' => t('Webform submission count'),
- 'help' => t('The number of webform submissions for this user.'),
- 'handler' => 'webform_handler_field_submission_count',
- 'count_type' => 'users',
- ),
- );
- // Link for editing the webform.
- $data['node']['webform_edit'] = array(
- 'group' => t('Webform'),
- 'field' => array(
- 'title' => t('Webform edit link'),
- 'help' => t('Provide a simple link to edit the webform components and configuration.'),
- 'handler' => 'webform_handler_field_node_link_edit',
- ),
- );
- // Link for viewing webform results.
- $data['node']['webform_results'] = array(
- 'group' => t('Webform'),
- 'field' => array(
- 'title' => t('Webform results link'),
- 'help' => t('Provide a simple link to view the results of a webform.'),
- 'handler' => 'webform_handler_field_node_link_results',
- ),
- );
- // Webform form content.
- $data['node']['webform_form_body'] = array(
- 'group' => t('Webform'),
- 'field' => array(
- 'title' => t('Webform form body'),
- 'help' => t('The Webform form body display for this node.'),
- 'handler' => 'webform_handler_field_form_body',
- ),
- );
- $data['views']['webform_result'] = array(
- 'title' => t('Result summary with an additional token to change the items/page'),
- 'help' => t('Shows result summary, for example the items per page, plus links to change the items per page.'),
- 'area' => array(
- 'handler' => 'webform_handler_area_result_pager',
- ),
- );
- }
- /**
- * Implements hook_views_plugins().
- */
- function webform_views_plugins() {
- return array(
- 'row' => array(
- 'webform_submission' => array(
- 'title' => t('Rendered submissions'),
- 'help' => t('Display the rendered submission'),
- 'handler' => 'webform_views_plugin_row_submission_view',
- 'uses options' => TRUE,
- 'type' => 'normal',
- ),
- ),
- );
- }
- /**
- * Implements hook_view_pre_view().
- */
- function webform_views_pre_view($view, $display_id, $args) {
- $display = $view->display[$display_id];
- $all_fields_id = _webform_view_find_id($view, $display_id, 'field', array('field' => 'webform_all_fields'));
- if ($all_fields_id !== NULL &&
- !empty($args[0]) && is_numeric($args[0]) && $args[0] > 0 &&
- _webform_view_find_id($view, $display_id, 'argument', array('field' => 'nid', 'table' => 'webform_submissions')) !== NULL &&
- ($node = node_load($args[0])) && isset($node->webform['components'])) {
- // This is a view/display that needs its fields expanded. It contains the
- // webform_all_fields field, has a nid argument to the webform_submission
- // table that is a valid node. Retrieve the display's fields and remove any
- // fields after the 'webform_all_fields' field.
- $fields = $view->get_items('field', $display_id);
- $prototype = $fields[$all_fields_id];
- $field_index = array_flip(array_keys($fields));
- $trailing_fields = array_slice($fields, $field_index[$all_fields_id] + 1, NULL, TRUE);
- $fields = array_slice($fields, 0, $field_index[$all_fields_id], TRUE);
- // Remove any fields after the webform_add_fields field.
- $new_columns = array();
- foreach ($node->webform['components'] as $component) {
- if (webform_component_invoke($component['type'], 'table', $component, array('')) !== NULL) {
- $new_id = 'webform_component_' . $component['cid'];
- $new_fields = array(
- array(
- 'id' => $new_id,
- 'field' => 'value',
- 'table' => 'webform_submissions',
- 'label' => $component['name'],
- 'webform_nid' => $node->nid,
- 'webform_cid' => $component['cid'],
- 'exclude' => 0,
- ) + $prototype,
- );
- if (webform_component_implements($component['type'], 'view_field')) {
- $new_fields = webform_component_invoke($component['type'], 'view_field', $component, $new_fields);
- }
- foreach ($new_fields as $sub_id => $new_field) {
- $field_id = $new_id . ($sub_id ? '_' . $sub_id : '');
- $fields[$field_id] = $new_field;
- $new_columns[$field_id] = $field_id;
- }
- }
- }
- // Add any trailing fields back in.
- $fields += $trailing_fields;
- // Store. Alas, there is no view::set_items() method.
- $display->handler->set_option('fields', $fields);
- // If this display's style is a table, add columns for click-sorting.
- // Note: Test for count($new_columns) is necessary because prior to PHP 5.6,
- // array_fill requires a positive number of elements to insert.
- if ($display->handler->get_option('style_plugin') == 'table' && count($new_columns)) {
- $style_options = $display->handler->get_option('style_options');
- $style_options['columns'] += $new_columns;
- $style_prototype = isset($style_options['info'][$all_fields_id])
- ? $style_options['info'][$all_fields_id]
- : array();
- $style_prototype += array(
- 'sortable' => 1,
- 'default_sort_order' => 'asc',
- 'align' => '',
- 'separator' => '',
- 'empty_column' => 0,
- );
- $style_options['info'] += array_combine($new_columns, array_fill(1, count($new_columns), $style_prototype));
- $display->handler->set_option('style_options', $style_options);
- }
- // Reset field handlers cache and rebuild field handlers.
- unset($display->handler->handlers['field']);
- $display->handler->get_handlers('field');
- // Allow other modules to alter these modifications to the view.
- drupal_alter('webform_view', $view, $display_id, $args);
- }
- }
- /**
- * Helper; Finds an item by option.
- */
- function _webform_view_find_id($view, $display_id, $type, $options) {
- foreach ($view->get_items($type, $display_id) as $id => $item) {
- foreach ($options as $option_key => $option_value) {
- if ($item[$option_key] != $option_value) {
- continue 2;
- }
- }
- return $id;
- }
- return NULL;
- }
- /**
- * Menu callback; Provide a list of Webform nodes for use in autocomplete.
- */
- function webform_views_autocomplete($string = '') {
- if ($string) {
- $or = db_or();
- // Strings with nid: in them can be used as direct matches.
- $matches = array();
- if (preg_match('/nid:([0-9]+)/', $string, $matches)) {
- $or->condition('n.nid', (int) $matches[1]);
- }
- // Otherwise match on title and optionally indirect NIDs.
- else {
- $or->condition('n.title', '%' . db_like($string) . '%', 'LIKE');
- if (is_numeric($string)) {
- $or->condition('n.nid', (int) $string);
- }
- }
- $options = array();
- $query = db_select('node', 'n')
- ->fields('n', array('nid', 'title'))
- ->condition($or);
- $query->innerJoin('webform', 'w', 'w.nid = n.nid');
- $result = $query
- ->range(0, 10)
- ->execute();
- foreach ($result as $node) {
- $options[$node->title . ' [nid:' . $node->nid . ']'] = check_plain($node->title) . ' [nid:' . $node->nid . ']';
- }
- }
- drupal_json_output($options);
- }
- /**
- * Shared form for the Webform submission data field and relationship handler.
- */
- function _webform_views_options_form(&$form, &$form_state, $nid, $cid) {
- form_load_include($form_state, 'inc', 'webform', 'includes/webform.components');
- $node = $nid ? node_load($nid) : NULL;
- $form['webform_nid'] = array(
- '#type' => 'textfield',
- '#title' => t('Webform node'),
- '#default_value' => isset($node) ? $node->title . ' [nid:' . $node->nid . ']' : '',
- '#ajax' => array(
- 'path' => views_ui_build_form_url($form_state),
- 'event' => 'blur',
- ),
- '#autocomplete_path' => 'webform/autocomplete',
- '#description' => t('Enter the title or NID of the Webform whose values should be made available.'),
- '#submit' => array('views_ui_config_item_form_submit_temporary'),
- '#executes_submit_callback' => TRUE,
- );
- $components = array();
- if (isset($node->webform['components'])) {
- $components = $node->webform['components'];
- }
- $type_options = array();
- foreach (webform_components() as $key => $component) {
- $type_options[$key] = check_plain($component['label']);
- }
- $options = webform_component_list($node, NULL, 'path', TRUE);
- $form['webform_cid'] = array(
- '#title' => t('Component data'),
- '#type' => 'select',
- '#options' => $options,
- '#default_value' => $cid,
- '#access' => count($components),
- '#description' => t('Select the component whose values should be made available.'),
- );
- }
- /**
- * Validate handler for webform_views_options_form().
- */
- function _webform_views_options_validate(&$form, &$form_state) {
- // Just store the checked components of the selected type.
- if (empty($form_state['values']['options']['webform_nid'])) {
- form_error($form['webform_nid'], t('Webform NID is required.'));
- }
- else {
- $nid = preg_replace('/^.*?nid:([0-9]+).*?$/', '$1', $form_state['values']['options']['webform_nid']);
- if (!($nid && ($node = node_load($nid)) && !empty($node->webform['components']))) {
- form_error($form['webform_nid'], t('The specified node is not valid.'));
- }
- }
- }
- /**
- * Submit handler for webform_views_options_form().
- */
- function _webform_views_options_submit(&$form, &$form_state) {
- // Save the NID as just the number instead of the title.
- $nid = preg_replace('/^.*?nid:([0-9]+).*?$/', '$1', $form_state['values']['options']['webform_nid']);
- $form_state['values']['options']['webform_nid'] = $nid;
- }
|