rules.features.inc in Rules 7.2

Provides Features integration for the Rules module.

This code is based upon the features integration provided by the Entity API.

File

rules.features.inc

<?php

/**
 * @file
 * Provides Features integration for the Rules module.
 *
 * This code is based upon the features integration provided by the Entity API.
 */

/**
 * Controller handling the features integration.
 */
class RulesFeaturesController extends EntityDefaultFeaturesController {

  /**
   * Defines the result for hook_features_api().
   */
  public function api() {
    $info = parent::api();
    $info['rules_config']['default_file'] = FEATURES_DEFAULTS_CUSTOM;
    $info['rules_config']['default_filename'] = 'rules_defaults';
    return $info;
  }

  /**
   * Generates the result for hook_features_export().
   *
   * Overridden to add in rules-specific stuff.
   */
  public function export($data, &$export, $module_name = '') {
    $pipe = parent::export($data, $export, $module_name);
    foreach (entity_load_multiple_by_name($this->type, $data) as $name => $rules_config) {

      // Add in the dependencies.
      $export['dependencies'] += drupal_map_assoc($rules_config
        ->dependencies());

      // Add in plugin / element specific additions.
      $iterator = new RecursiveIteratorIterator($rules_config, RecursiveIteratorIterator::SELF_FIRST);
      foreach ($iterator as $element) {
        if ($element
          ->facesAs('RulesPluginFeaturesIntegrationInterface')) {

          // Directly use __call() so we can pass $export by reference.
          $element
            ->__call('features_export', array(
            &$export,
            &$pipe,
            $module_name,
          ));
        }
      }
    }
    return $pipe;
  }

}

/**
 * Default extension callback used as default for the abstract plugin class.
 *
 * Actions and conditions may override this with an implementation which
 * actually does something.
 *
 * @see RulesPluginFeaturesIntegrationInterface
 */
function rules_features_abstract_default_features_export(&$export, &$pipe, $module_name, $element) {

  // Do nothing.
}

/**
 * Interface to give features access to the faces extensions mechanism.
 *
 * Interface that allows rules plugins or actions/conditions to customize the
 * features export by implementing the interface using the faces extensions
 * mechanism.
 *
 * @see hook_rules_plugin_info()
 * @see hook_rules_action_info()
 */
interface RulesPluginFeaturesIntegrationInterface {

  /**
   * Allows customizing the features export for a given rule element.
   */
  public function features_export(&$export, &$pipe, $module_name = '');

}

/**
 * Interface for backwards compatibility with older versions of Rules.
 *
 * Mis-spelled interface provided so that contributed modules which were
 * implementing the wrong spelling (corrected in Rules 7.x-2.12) will not stop
 * working now that the interface is spelled correctly.
 *
 * @todo Remove this when we can be sure that no contributed modules are
 * still using the wrong spelling.
 */
interface RulesPluginFeaturesIntegrationInterace extends RulesPluginFeaturesIntegrationInterface {

}

Functions

Name	Description
rules_features_abstract_default_features_export	Default extension callback used as default for the abstract plugin class.

Classes

Name	Description
RulesFeaturesController	Controller handling the features integration.

Interfaces

Name	Description
RulesPluginFeaturesIntegrationInterace	Interface for backwards compatibility with older versions of Rules.
RulesPluginFeaturesIntegrationInterface	Interface to give features access to the faces extensions mechanism.