ding_campaign_plus.api.php

<?php

/**
 * @file
 * Hooks provided by Ding Campaign plus.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Tells campaign plus that the modules provides campaign triggers.
 *
 * @return array
 *   The array contains node edit form elements, the title for the tab and
 *   the type that identifies this group of campaign triggers.
 */
function hook_ding_campaign_plus_info() {
  return array(
    'title' => t('Test'),
    'type' => 'test',
    'form' => 'ding_campaign_plus_test_admin_form',
    'auto' => 'ding_campaign_plus_test_auto_admin_form',
    'weight' => 0,
  );
}

/**
 * Used to find the campaigns that is trigger by current context.
 *
 * @param array $contexts
 *   Panel pane contexts for the current page.
 * @param string $style
 *   The style set in the pane - ribbon or box.
 *
 * @return array
 *   The camping node id's keyed by type (here the weight type).
 */
function hook_ding_campaign_plus_matches(array $contexts, $style) {
  $matches = array();

  foreach ($contexts as $key => $context) {
    switch ($key) {
      case 'path':
        $matches['path'] = _ding_campaign_plus_basic_match('path', $context->path);
        break;
    }
  }

  return $matches;
}

/**
 * Defines default weight for the trigger that the module provides.
 */
function hook_ding_campaign_plus_default_weights() {
  return array(
    'search' => array(
      'prefix' => t('Search'),
      'title' => t('CQL statement'),
      'weight' => 10,
    ),
  );
}

/**
 * Defines the rules for a given trigger for auto generated campaigns.
 *
 * @param array $config
 *   The auto generate administration configuration.
 * @param object $campaign_node
 *   The campaign node that the rules should be generated for.
 * @param \Entity $node
 *   The node that has triggered the auto generated campaign. Note that the node
 *   have not yet been saved to the database.
 * @param array $subjects
 *   The subjects entered by the user.
 *
 * @return array
 *   Matching the modules rules format for the module.
 */
function hook_ding_campaign_plus_auto_trigger(array $config, $campaign_node, \Entity $node, array $subjects) {
  return array('TYPE' => array('rules' => array()));
}

/**
 * @} End of "addtogroup hooks".
 */