webform_share.api.php in Webform share 7

Sample hooks demonstrating usage in Webform Share.

File

webform_share.api.php

<?php

/**
 * @file
 * Sample hooks demonstrating usage in Webform Share.
 */

/**
 * @defgroup webform_share_hooks Webform Share Module Hooks
 * @{
 * Webform Share's hooks enable other modules to intercept events within
 * the module.
 */

/**
 * Alter the webform data prior to importing.
 *
 * @param array $webform
 *   The webform data structure.
 * @param array $context
 *   An array giving the context.
 *   Keys:
 *     - 'operation' - The operation being performed:
 *       - 'insert' - inserting a new node.
 *       - 'update' - adding a webform to an existing node.
 *     - 'node' - A reference to the node.
 *     - 'options' - Options selected by the user during the import.
 *       - 'components_only' - boolean indicating whether to erase (FALSE)
 *                             or keep (TRUE) existing webform settings.
 *       - 'keep_existing_components' - boolean indicating if existing
 *                                      components should be preserved.
 */
function hook_webform_share_import_alter(&$webform, $context) {
  $webform['my_setting'] = array(
    'setting1' => 'value1',
    'nid' => $context['node']->nid,
  );
  $context['node']->my_node_settings = array();
}

/**
 * Alter the node data prior to exporting webform data.
 *
 * @param array $node
 *   The node to be exported. Any changes to the webform element will be
 *   reflected in the generated export file.
 */
function hook_webform_share_export_alter($node) {
  $node->webform['my_setting'] = array();
}

/**
 * @} webform_share_hooks
 */

Functions

Name	Description
hook_webform_share_export_alter	Alter the node data prior to exporting webform data.
hook_webform_share_import_alter	Alter the webform data prior to importing.