node_export.api.php in Node export 7.3

Documents Node export's hooks for api reference.

File

node_export.api.php

<?php

/**
 * @file
 * Documents Node export's hooks for api reference.
 */

/**
 * Override export access on a node.
 *
 * Let other modules alter this - for example to only allow some users to
 * export specific nodes or types.
 *
 * @param &$access
 *   Boolean access value for current user.
 * @param $node
 *   The node to determine access for.
 */
function hook_node_export_access_export_alter(&$access, $node) {

  // no example code
}

/**
 * Override import access on a node.
 *
 * Let other modules alter this - for example to only allow some users to
 * import specific nodes or types.
 *
 * @param &$access
 *   Boolean access value for current user.
 * @param $node
 *   The node to determine access for.
 */
function hook_node_export_access_import_alter(&$access, $node) {

  // no example code
}

/**
 * Override one line of the export code output.
 *
 * @param &$out
 *   The line of output.
 * @param $tab
 *   The $tab variable from node_export_node_encode().
 * @param $key
 *   The $key variable from node_export_node_encode().
 * @param $value
 *   The $value variable from node_export_node_encode().
 * @param $iteration
 *   The $iteration variable from node_export_node_encode().
 */
function hook_node_export_node_encode_line_alter(&$out, $tab, $key, $value, $iteration) {

  // Start with something like this, and work on it:
  $out = $tab . "  '" . $key . "' => " . node_export_node_encode($value, $iteration) . ",\n";
}

/**
 * Manipulate a node on export.
 *
 * @param &$node
 *   The node to alter.
 * @param $original_node
 *   The unaltered node.
 */
function hook_node_export_node_alter(&$node, $original_node) {

  // no example code
}

/**
 * Manipulate a node on import.
 *
 * @param &$node
 *   The node to alter.
 * @param $original_node
 *   The unaltered node.
 * @param $save
 *   Whether the node will be saved by node_export_import().
 */
function hook_node_export_node_import_alter(&$node, $original_node, $save) {

  // no example code
}

/**
 * Manipulate node array before export.
 *
 * The purpose of this is to allow a module to check nodes in the array for
 * two or more nodes that must retain a relationship, and to add/remove other
 * data to the array to assist with maintaining dependencies, relationships,
 * references, and additional data required by the nodes.
 *
 * @param &$nodes
 *   The array of nodes to alter.
 * @param $format
 *   The format of node code being used.
 */
function hook_node_export_alter(&$nodes, $format) {

  // no example code
}

/**
 * Manipulate node array before import.
 *
 * The purpose of this is to allow a module to check nodes in the array for
 * two or more nodes that must retain a relationship, and to add/remove other
 * data to the array to assist with maintaining dependencies, relationships,
 * references, and additional data required by the nodes.
 *
 * @param &$nodes
 *   The array of nodes to alter.
 * @param $format
 *   The format of node code being used.
 * @param $save
 *   Whether the nodes will be saved by node_export_import().
 */
function hook_node_export_import_alter(&$nodes, $format, $save) {

  // no example code
}

/**
 * Manipulate node array after import.
 *
 * The purpose of this is to allow a module to check nodes in the array for
 * two or more nodes that must retain a relationship, and to add/remove other
 * data to the array to assist with maintaining dependencies, relationships,
 * references, and additional data required by the nodes.
 *
 * @param &$nodes
 *   The array of nodes to alter - IMPORTANT: keyed by node id.
 * @param $format
 *   The format of node code being used.
 * @param $save
 *   Whether the nodes were saved by node_export_import().
 */
function hook_node_export_after_import_alter(&$nodes, $format, $save) {

  // no example code
}

/**
 * Manipulate the code string before import.
 *
 * @param &$code_string
 *   The export code.
 */
function hook_node_export_decode_alter(&$code_string) {

  // no example code
}

/**
 * Manipulate the code string upon export.
 *
 * @param &$code_string
 *   The Node export code.  Leave as FALSE for no change.
 * @param $nodes
 *   The node.
 * @param $format
 *   A string indicating what the export format is, and whether to do anything.
 */
function hook_node_export_encode_alter(&$code_string, $nodes, $format) {

  // no example code
}

/**
 * Register a format handler.
 *
 * @return
 *   An array keyed by format names containing an array with keys:
 *   #title - the translated display name of the format
 *   #module - the module that implements it.
 *   #description - the translated description, please include links to docs that
 *   give more info about the format.
 *   #file - if a file is to be included for callbacks to work, give full path
 *     here. This is optional.
 *   #mime - to override the default text/plain mime type for the downloaded
 *     file set this to the desired mime type string.  This is optional.
 *   #settings_callback - the function name of the settings callback, this is a
 *     function that takes two params $form and $form_state, and returns an
 *     array of form elements to append to the $form['basic'] area.  The form
 *     uses system_settings_form() so values will be automatically saved into
 *     variables, but be sure your module deletes these variables upon
 *     uninstall. This is optional.
 *   #export_callback - the function name of the export callback, this is a
 *     function that takes two params $nodes and $format, where $nodes is an array
 *     of nodes and $format is the name of the format (in case same function used
 *     for multiple formats).
 *   #import_callback - the function name of the import callback, this is a
 *     function that takes one parameter $code_string, and will be called of all
 *     formats when an import is being performed, and should return:
 *       The array of nodes, or nothing if code_string not handled by this
 *       function.
 *       If there is a problem with the supplied code return an array like so:
 *         array(
 *           'success' => FALSE,
 *           'output' => array("error msg 1", "error msg 2", etc...),
 *         )
 *       Note: Do not use the t() function on error msgs, and don't mix the error
 *       message with dynamic variables/content, at least not in the first message
 *       so it can be translated properly and used as the main message.  See the
 *       XML implementation for malformed XML imports for an example that combines
 *       information for the user followed by generated errors from PHP.
 */
function hook_node_export_format_handlers() {
  return array(
    // Note: format_short_name should NOT contain the string 'node_export'.
    // Example from DSV format.
    'dsv' => array(
      '#title' => t('DSV'),
      '#module' => 'node_export',
      '#file' => drupal_get_path('module', 'node_export') . '/formats/dsv.inc',
      '#description' => t('Configurable <a href="!dsv">Delimiter-separated values</a> code. Export and import sites must be configured the same.', array(
        '!dsv' => 'http://en.wikipedia.org/wiki/Delimiter-separated_values',
      )),
      '#settings_callback' => 'node_export_dsv_settings',
      '#export_callback' => 'node_export_dsv_export',
      '#import_callback' => 'node_export_dsv_import',
    ),
  );
}

Functions

Name	Description
hook_node_export_access_export_alter	Override export access on a node.
hook_node_export_access_import_alter	Override import access on a node.
hook_node_export_after_import_alter	Manipulate node array after import.
hook_node_export_alter	Manipulate node array before export.
hook_node_export_decode_alter	Manipulate the code string before import.
hook_node_export_encode_alter	Manipulate the code string upon export.
hook_node_export_format_handlers	Register a format handler.
hook_node_export_import_alter	Manipulate node array before import.
hook_node_export_node_alter	Manipulate a node on export.
hook_node_export_node_encode_line_alter	Override one line of the export code output.
hook_node_export_node_import_alter	Manipulate a node on import.