/[drupal]/contributions/modules/workflow_ng/workflow_ng/workflow_ng.module

Diff of /contributions/modules/workflow_ng/workflow_ng/workflow_ng.module

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.1.2.15.2.8,
Tue Jul 29 10:48:41 2008 UTC
+revision 1.1.2.15.2.9,
Thu Feb 19 10:15:01 2009 UTC
 Line 1
  <?php
- // $Id: workflow_ng.module,v 1.1.2.15.2.7 2008/07/11 08:19:46 fago Exp $
+ // $Id: workflow_ng.module,v 1.1.2.15.2.8 2008/07/29 10:48:41 fago Exp $
  /**
   * Defines if an execution log should be displayed.
 Line 22 
 foreach($files as $file) {
  /*
   * Returns all defined events.
   *
   * @param $op
   *  Set it to 'labels' to get a list of event labels,
   *  otherwise you'll get the full definitions.
   * @param $key
   *   If set, only return the value for this key. E.g. $op 'labels',
   *   with key 'example' will return the label of the event example.
   */
  function workflow_ng_get_events($op = 'all', $key = NULL) {
 Line 36 
 function workflow_ng_get_events($op = 'a
  /**
   * Returns all defined actions.
   *
   * @param $op
   *   As per workflow_ng_get_events().
   * @param $key
   *   As per workflow_ng_get_events().
   */
 Line 54 
 function _workflow_ng_element_has_label(
  /**
   * Returns all defined conditions.
   *
   * @param $op
   *   As per workflow_ng_get_events().
   * @param $key
   *   As per workflow_ng_get_events().
   */
 Line 66 
 function workflow_ng_get_conditions($op
  /*
   * Returns all defined configurations.
   *
   * @param $op
   *   As per workflow_ng_get_events().
   * @param $key
   *   As per workflow_ng_get_events().
   */
 Line 83 
 function workflow_ng_get_configurations(
  /**
   * Gathers module definitions for the given name.
   * Used for collecting events, configurations, actions and condtions
   * from other modules.
   *
   * @param $name
   *   The type of the data item to collect. This is also the name of the
   *   invoked hook.
   * @param $alter
   *   If workflow_ng_alter() should be used to let modules alter the data
   *   of other modules.
   * @param $op
   *   Set it to 'labels' to get a list of data item labels,
   *   otherwise you'll get the full definitions.
   * @param $key
   *   If set, only return the value for this key. E.g. $op 'labels',
   *   with key 'example' will return the label of the data item example.
   * @param
   *   $reset If the static cache should be reseted. Note that if set to true,
   *   nothing will be returned.
   */
  function workflow_ng_gather_data($name, $alter = FALSE, $op = 'all', $key = NULL, $reset = FALSE) {
 Line 119 
 function workflow_ng_gather_data($name,
      foreach ($returned as $item_name => $info) {
        // Set the type to $name, so that element defaults can be applied later.
        $info['#type'] = $name;
        $info['#name'] = $item_name;
        $data[$name]['labels'][$item_name] = $info['#label'];
        $data[$name]['all'][$item_name] = $info;
 Line 161 
 function workflow_ng_alter($name, &$data
  /**
   * Returns all active configurations for the event $event_name.
   *
   * @param $event_name
   *   The event name, for which the configurations should be returned.
   * @param $reset
   *   May be set to true to clear the cache.
   * @return
   *   The configured configurations for this event.
   */
  function workflow_ng_event_get_configurations($event_name = NULL, $reset = FALSE) {
    // We prevent a lot of queries by storing all event names with activated
    // configurations with variable_set.
    static $configs;
 Line 195 
 function workflow_ng_event_get_configura
            cache_set('cfg_'. $name, 'cache_workflow_ng', serialize($configs[$name]));
          }
          else {
            // Write in the variable cache, that there are no configs
            // for this event.
            $variable_cache[$name] = array();
          }
 Line 218 
 function _workflow_ng_configuration_is_a
   * Gathers the configurations and returns the configurations for the given event.
   * This bypasses any database cache!
   *
   * @param $event_name
   *   The event name, for which the configurations should be returned.
   *   Leave it empty, to get all configurations sorted by event.
   * @param $reset
   *   May be set to true to clear the static cache.
   */
  function workflow_ng_get_configurations_by_event($event_name = NULL, $reset = FALSE) {
 Line 244 
 function workflow_ng_get_configurations_
  /**
   * Clear the workflow-ng cache.
   *
   * @param $immediate
   *   If FALSE, the static cache will be kept until the next page load.
   *   Might be dangerous, so only use if you know what you are doing.
   */
 Line 261 
 function workflow_ng_clear_cache($immedi
  /**
   * Invokes configured actions/conditions for the given event.
   *
   * @param $event_name
   *   As first param pass the event name.
   * @params $args
   *   Pass further arguments as defined in hook_event_info() for this event.
   */
  function workflow_ng_invoke_event() {
 Line 294 
 function workflow_ng_invoke_event() {
   * Evaluates the configurations by using workflow_ng_evaluate_elements().
   * Afterwards it cares for saving the modified arguments.
   *
   * @param $configurations
   *   The configurations to process.
   * @param $arguments
   *   An array of arguments in format as returned
   *   from _workflow_ng_process_arguments().
   * @param $log
   *   An array of log entries. Set it to FALSE to disable logging,
   *   otherwise initialize it with array().
   */
  function workflow_ng_evaluate_configurations($configurations, &$arguments, &$log) {
 Line 321 
 function workflow_ng_evaluate_configurat
  /**
   * Evaluates the elements in a recursive way.
   * The elements are a tree of configurations, conditions, actions and logical
   * operations (AND, OR,..).
   *
   * Each element is executed by using workflow_ng_execute_element().
 Line 330 
 function workflow_ng_evaluate_configurat
   * to customize the evaluation of the children. E.g. the element 'OR' does this and
   * evaluates to TRUE if at least one of its children evaluate to TRUE.
   *
   * @param $elements
   *   An array of elements to evaluate.
   * @param $arguments
   *   An array of arguments in format as returned from
   *   _workflow_ng_process_arguments().
   * @param $log
   *   An array of log entries. Set it to FALSE to disable logging,
   *   otherwise initialize it with array().
   */
  function workflow_ng_evaluate_elements(&$elements, &$arguments, &$log) {
 Line 348 
 function workflow_ng_evaluate_elements(&
      $result = workflow_ng_execute_element($elements, $arguments, $log);
    }
    // We default to evaluate like an AND, which means we stop as soon as one
    // element evaluates to FALSE so if the element hasn't evaluated the children,
    // start now.
    if ((!isset($elements['#_evaluated']) || $elements['#_evaluated'] == FALSE)) {
      $elements['#_evaluated'] = TRUE;
 Line 374 
 function _workflow_ng_sort_children(&$el
  function _workflow_ng_element_sort($a, $b) {
    if (!is_array($a) || ($b['#type'] == 'action' && $a['#type'] != 'action')) {
      return -1;
    }
    if (!is_array($b) || ($a['#type'] == 'action' && $b['#type'] != 'action')) {
      // Actions always sink down, element properties up.
      return 1;
    }
    $a += array('#weight' => 0, '#id' => 1000);
    $b += array('#weight' => 0, '#id' => 1000);
 Line 404 
 function _workflow_ng_element_defaults(&
  /*
   * Executes the element by invoking the element type's execution handler.
   *
   * @param $elements
   *   An array of elements to process.
   * @param $arguments
   *   An array of arguments in format as returned from
   *   _workflow_ng_process_arguments().
   * @param $log
   *   An array of log entries. Set it to FALSE to disable logging.
   * @return
   *   The execution result, or FALSE if there is no valid execution handler.
   */
  function workflow_ng_execute_element(&$element, &$arguments, &$log) {
 Line 426 
 function workflow_ng_execute_element(&$e
  /**
   * Execution handler for configurations.
   *
   * We want each configuration to be evaluated, so let the following
   * configurations be processed by returning always TRUE.
   *
   */
 Line 445 
 function workflow_ng_execute_configurati
  }
  /**
   * Execution handler for the OR element.
   *
   * @return
   *   Evaluates to TRUE if at least one children evaluate to TRUE.
   */
  function workflow_ng_execute_or(&$elements, &$arguments, &$log) {
 Line 468 
 function workflow_ng_execute_or(&$elemen
  /**
   * Execution handler for the AND element
   *
   * @return
   *   Evaluates to TRUE if all children evaluate to TRUE.
   */
  function workflow_ng_execute_and(&$elements, &$arguments, &$log) {
 Line 492 
 function workflow_ng_execute_and(&$eleme
  /**
   * Execution handler for actions.
   *
   * @param $element
   *   The action's configuration element.
   * @param $arguments
   *   An array of arguments in format as returned from
   *   _workflow_ng_process_arguments().
   * @param $log
   *   An array of log entries. Set it to FALSE to disable logging.
   * @return
   *   TRUE to let workflow_ng proceed wit executing actions,
   *   only FALSE if $result['#halt'] is set.
   */
  function workflow_ng_execute_action($element, &$arguments, &$log) {
 Line 514 
 function workflow_ng_execute_action($ele
        if (isset($result['#new arguments']) && $result['#new arguments']) {
          workflow_ng_add_new_arguments($element, $result['#new arguments'], $arguments, $log);
        }
        // An action may return altered arguments, which will be
        // saved automatically.
        if (isset($result) && is_array($result)) {
          $reverse_map = array_flip($element['#argument map']);
 Line 541 
 function workflow_ng_execute_action($ele
   * Execution handler for conditions.
   * Note: A condition may not alter arguments
   *
   * @param $element
   *   The condition's configuration element.
   * @param $arguments
   *   An array of arguments in format as returned from
   *   _workflow_ng_process_arguments().
   * @param $log
   *   An array of log entries. Set it to FALSE to disable logging.
   * @return
   *   The execution result of the condition, or if it is no valid condition FALSE.
   */
  function workflow_ng_execute_condition($element, &$arguments, &$log) {
 Line 582 
 function workflow_ng_write_log(&$log, $m
   * Returns the execution arguments needed by the given element.
   * It applies the #argument map and gets all needed arguments.
   *
   * @param $element
   *   The configured element, which is to be executed.
   * @param $arguments
   *   An array of arguments in format as returned from
   *   _workflow_ng_process_arguments().
   * @param $log
   *   An array of log entries. Set it to FALSE to disable logging.
   * @return
   *   If not all execution arguments are available, it returns FALSE.
   */
  function workflow_ng_get_execution_arguments(&$element, &$arguments, &$log) {
 Line 602 
 function workflow_ng_get_execution_argum
    $reverse_map = array_flip($element['#argument map']) + drupal_map_assoc(array_keys($element_info['#arguments']));
    $element['#argument map'] = array_flip($reverse_map);
    // Get the right execution arguments by applying the argument map of
    // this element.
    foreach ($element_info['#arguments'] as $argument_name => $info) {
      $event_arg_name = $reverse_map[$argument_name];
 Line 623 
 function workflow_ng_get_execution_argum
  /**
   * Implementation of hook_elements().
   * Defines default values for all available properties of workflow_ng's
   * element types.
   *
   * Note that the #process handlers are only used by the form API, but not by
   * workflow-ng itself.
   */
  function workflow_ng_elements() {
 Line 643 
 function workflow_ng_elements() {
  }
  /**
   * Processes the arguments of an event to an array in the style as it is
   * required for workflow_ng_evaluate_elements().
   *
   * The returned array format is like:
 Line 656 
 function workflow_ng_elements() {
   * Note that the order of the arguments will be kept, as it might be important for passing
   * the arguments to further argument loading handlers.
   *
   * @param $event
   *   The event info from the currently processed event.
   * @param $args
   *   The argument data passed with the event invocation.
   */
  function _workflow_ng_process_arguments($event, $args) {
 Line 680 
 function _workflow_ng_process_arguments(
  }
  /**
   * Returns the needed argument, which is given by the argument name.
   * This function will take care of loading further needed arguments,
   * as necessary.
   *
   * @param $arguments
   *   The existing arguments in the format as returned from
   *   _workflow_ng_process_arguments().
   * @param $argument_name
   *   The arguments's machine readable name.
   * @param $log
   *   An array of log entries. Set it to FALSE to disable logging.
   */
  function workflow_ng_element_get_argument(&$arguments, $argument_name, &$log) {
 Line 734 
 function workflow_ng_get_element_info(&$
        if (array_key_exists('#description', $element) && isset($info['#description'])) {
          // Make sure the description is applied.
          unset($element['#description']);
        }
        return $info;
      }
 Line 757 
 function workflow_ng_get_element_label($
  /**
   * A simple helping function, which eases the creation of configurations.
   * Example use case:
   * $configuration['or'] = workflow_ng_configure('OR', $condition1, conditions2);
   *
   * @param $op
   *   One supported operation like 'AND', 'OR'. If ommitted the passed elements
   *   will just be added to the first one.
   * @param $elements
   *   The elements to configure.
   */
  function workflow_ng_configure() {
 Line 784 
 function workflow_ng_configure() {
  /**
   * Configures a condition for using in a configuration.
   *
   * @param $name
   *   The name of condition to create, as specified at hook_condition_info().
   * @param $params
   *   An optional array of properties to add, e.g. #argument_map.
   */
  function workflow_ng_use_condition($name, $params = array()) {
 Line 797 
 function workflow_ng_use_condition($name
  /**
   * Configures an action for using in a configuration.
   *
   * @param $name
   *   The name of action to create, as specified at hook_action_info().
   * @param $params
   *   An optional array of properties to add, e.g. #argument_map.
   */
  function workflow_ng_use_action($name, $params = array()) {
 Line 808 
 function workflow_ng_use_action($name, $
  }
  /**
   * Configures an element of type $type with the further properties $params
   * for using in a configuration.
   */
  function workflow_ng_use_element($type, $params = array()) {
 Line 834 
 function workflow_ng_show_log($log) {
  }
  /**
   * Remembers the currently evaluated configurations. With this information,
   * recursion is prevented.
   *
   * @param $add_name
   *   If set to FALSE, all already processed configurations will be returned
   *   Otherwise, the passed configuration name will be stored
   *   for further lookups.
   * @param $reset
   *   Clears the saved configurations if set.
   */
  function workflow_ng_evaluated_configurations($add_name = FALSE, $reset = FALSE) {
 Line 883 
 function workflow_ng_configuration() {
      $cfg = unserialize($row->data);
      $configurations[$row->name] = $cfg;
    }
-   $configurations += workflow_ng_default_configuration();
+   if (function_exists('workflow_ng_default_configuration')) {
+     $configurations += workflow_ng_default_configuration();
+   }
    return $configurations;
  }
  /**
   * Shows an error message, that a module is missing.
   *
   * @param $element
   *   The element, for which the module is missing.
   * @param $configuration_name
   *   The name of the configuration of the element.
   */
  function workflow_ng_missing_module($element, $configuration_name = NULL) {
-Line 928 
 function workflow_ng_handle_error_msg($m
+Line 930 
 function workflow_ng_handle_error_msg($m
  /**
   * Determines if the given entity type is supported by the given info.
   *
   * @param $entity_type
   *   The entity type to check.
   * @param $info
   *   The information data containing the #entity property.
   */
  function workflow_ng_is_valid_entity($entity_type, $info) {
-Line 956 
 function workflow_ng_set_argument_to_sav
+Line 958 
 function workflow_ng_set_argument_to_sav
  /**
   * Saves a modified argument.
   *
   * @param $info
   *   The argument info as specified through hook_event_info().
   * @param $argument_name
   *   The name of the argument to save.
   * @param
   *   $value The new value of the argument.
   */
  function workflow_ng_save_argument($info, $argument_name, $value, &$log) {

 Legend:



Removed from v.1.1.2.15.2.8
 


changed lines


 
Added in v.1.1.2.15.2.9
 Legend:



Removed from v.1.1.2.15.2.8
 


changed lines


 
Added in v.1.1.2.15.2.9
-Removed from v.1.1.2.15.2.8
+Added in v.1.1.2.15.2.9

	ViewVC Help
Powered by ViewVC 1.1.2