workflow.node.type_map.inc in Workflow 7

Node specific functions, remnants of nodeapi.

File

workflow.node.type_map.inc

<?php

/**
 * @file
 * Node specific functions, remnants of nodeapi.
 */

/**
 * Functions related to table workflow_type_map.
 */

/**
 * Get all workflow_type_map.
 */
function workflow_get_workflow_type_map() {
  $results = db_query('SELECT type, wid FROM {workflow_type_map}');
  return $results
    ->fetchAllKeyed();
}

/**
 * Get workflow_type_map for a type. On no record, FALSE is returned.
 * Currently this is a unique result but requests have been made to allow a node to have multiple
 * workflows. This is trickier than it sounds as a lot of our processing code will have to be
 * tweaked to account for multiple results.
 * ALERT: If a node type is *not* mapped to a workflow it will be listed as wid 0.
 * Hence, we filter out the non-mapped results.
 *
 * @todo: remove in a future (D8) version. This function is deprecated in favor of
 * @see workflow_get_workflows_by_type()
 */
function workflow_get_workflow_type_map_by_type($type) {
  static $map = array();
  if (!isset($map[$type])) {
    $results = db_query('SELECT type, wid FROM {workflow_type_map} WHERE type = :type AND wid <> 0', array(
      ':type' => $type,
    ));
    $map[$type] = $results
      ->fetchObject();
  }
  return $map[$type];
}

/**
 * Given a wid, find all node types mapped to it.
 */
function workflow_get_workflow_type_map_by_wid($wid) {
  static $map = array();
  if (!isset($map[$wid])) {
    $results = db_query('SELECT type, wid FROM {workflow_type_map} WHERE wid = :wid', array(
      ':wid' => $wid,
    ));
    $map[$wid] = $results
      ->fetchAll();
  }
  return $map[$wid];
}

/**
 * Delete all type maps.
 * @TODO: why is this here instead of the admin_ui?
 */
function workflow_delete_workflow_type_map_all() {
  return db_delete('workflow_type_map')
    ->execute();
}

/**
 * Given a wid, delete the map for that workflow.
 */
function workflow_delete_workflow_type_map_by_wid($wid) {
  return db_delete('workflow_type_map')
    ->condition('wid', $wid)
    ->execute();
}

/**
 * Given a type, delete the map for that workflow.
 */
function workflow_delete_workflow_type_map_by_type($type) {
  return db_delete('workflow_type_map')
    ->condition('type', $type)
    ->execute();
}

/**
 * Given information, insert a new workflow_type_map. Returns data by ref. (like node_save).
 * @TODO: why is this here instead of the admin_ui?
 */
function workflow_insert_workflow_type_map(&$data) {
  $data = (object) $data;

  // Be sure we have a clean insert. There should never be more than one map for a type.
  if (isset($data->type)) {
    workflow_delete_workflow_type_map_by_type($data->type);
  }
  drupal_write_record('workflow_type_map', $data);
}

Functions

Name	Description
workflow_delete_workflow_type_map_all	Delete all type maps. @TODO: why is this here instead of the admin_ui?
workflow_delete_workflow_type_map_by_type	Given a type, delete the map for that workflow.
workflow_delete_workflow_type_map_by_wid	Given a wid, delete the map for that workflow.
workflow_get_workflow_type_map	Get all workflow_type_map.
workflow_get_workflow_type_map_by_type	Get workflow_type_map for a type. On no record, FALSE is returned. Currently this is a unique result but requests have been made to allow a node to have multiple workflows. This is trickier than it sounds as a lot of our processing code will have to…
workflow_get_workflow_type_map_by_wid	Given a wid, find all node types mapped to it.
workflow_insert_workflow_type_map	Given information, insert a new workflow_type_map. Returns data by ref. (like node_save). @TODO: why is this here instead of the admin_ui?