radioactivity.rules.inc in Radioactivity 7.2

File

radioactivity.rules.inc

<?php

/**
 * Implements hook_rules_action_info().
 */
function radioactivity_rules_action_info() {
  $items = array();
  $defaults = array(
    'group' => t('Radioactivity'),
    'access callback' => 'radioactivity_access_callback',
  );

  // Emit energy
  $items['radioactivity_emit'] = $defaults + array(
    'label' => t('Add an incident to a field'),
    'base' => 'radioactivity_rules_action_emit',
    'parameter' => array(
      'data' => array(
        'type' => '*',
        'label' => t('Radioactivity field'),
        'description' => t('The radioactivity field in which you want to add an incident to'),
        'restriction' => 'selector',
        'wrapped' => TRUE,
        'allow null' => TRUE,
      ),
      'value' => array(
        'type' => 'decimal',
        'label' => t('Energy amount'),
        'description' => t('The variable which contains the amount of energy to be added to or substracted from the field'),
        'allow null' => FALSE,
        'optional' => FALSE,
      ),
      'floodcheck' => array(
        'type' => 'boolean',
        'label' => t('Flood protected'),
        'description' => t('If checked the emitter has to pass flood check.'),
        'allow null' => FALSE,
        'optional' => TRUE,
      ),
    ),
  );

  // Emit energy
  $items['radioactivity_add_emitter'] = $defaults + array(
    'label' => t('Add an ajax emitter on page'),
    'base' => 'radioactivity_rules_action_add_emitter',
    'parameter' => array(
      'data' => array(
        'type' => '*',
        'label' => t('Radioactivity field'),
        'description' => t('The radioactivity field which will be added to the page as an emitter'),
        'restriction' => 'selector',
        'wrapped' => TRUE,
        'allow null' => TRUE,
      ),
      'energy' => array(
        'type' => 'decimal',
        'label' => t('Energy'),
        'description' => t('The variable which contains the amount of energy to emit'),
        'allow null' => FALSE,
        'optional' => FALSE,
      ),
      'accuracy' => array(
        'type' => 'decimal',
        'label' => t('Accuracy'),
        'description' => t('The variable which contains the accuracy of this emitter'),
        'allow null' => FALSE,
        'optional' => FALSE,
      ),
    ),
  );

  // Set energy
  $items['radioactivity_set'] = $defaults + array(
    'label' => t('Set the energy of a field'),
    'base' => 'radioactivity_rules_action_set',
    'parameter' => array(
      'data' => array(
        'type' => '*',
        'label' => t('Radioactivity field'),
        'description' => t('The radioactivity field which you wish to set'),
        'restriction' => 'selector',
        'wrapped' => TRUE,
        'allow null' => TRUE,
      ),
      'value' => array(
        'type' => 'decimal',
        'label' => t('Energy level'),
        'description' => t('The variable which contains the new energy level for the field'),
        'allow null' => FALSE,
        'optional' => FALSE,
      ),
    ),
  );

  // Get maximum
  $items['radioactivity_maximum'] = $defaults + array(
    'label' => t('Get the maximum energy from a field'),
    'base' => 'radioactivity_rules_action_maximum',
    'parameter' => array(
      'data' => array(
        'type' => '*',
        'label' => t('Radioactivity field'),
        'description' => t('The radioactivity field from which you want the maximum energy to be retrieved from'),
        'restriction' => 'selector',
        'wrapped' => TRUE,
        'allow null' => FALSE,
      ),
    ),
    'provides' => array(
      'maximum_energy' => array(
        'type' => 'decimal',
        'label' => t('Maximum energy'),
      ),
    ),
  );
  return $items;
}

/**
 * Implements hook_rules_event_info().
 */
function radioactivity_rules_event_info() {
  return array(
    'radioactivity_field_cut_off' => array(
      'label' => t('Energy is below the cut off level'),
      'group' => t('Radioactivity'),
      'variables' => array(
        'entity' => array(
          'type' => 'entity',
          'label' => t('Entity'),
        ),
      ),
    ),
  );
}

/**
 * Action: Emit energy
 */
function radioactivity_rules_action_emit($field, $energy, $floodProtected) {
  $info = $field
    ->info();
  $field_name = $info['name'];
  $entity_type = $info['parent']
    ->type();
  $bundle = $info['parent']
    ->getBundle();
  $id = $info['parent']
    ->getIdentifier();
  $lang = LANGUAGE_NONE;
  if ($info['translatable']) {
    global $language;
    $lang = $language->language;
  }
  $profile = radioactivity_get_field_profile($entity_type, $bundle, $field_name);
  if ($profile && $profile->storageObject) {
    $profile->storageObject
      ->addIncident(new RadioactivityIncident($entity_type, $bundle, $field_name, $lang, $id, $energy, time(), $floodProtected));
  }
}

/**
 * Action: Set energy
 */
function radioactivity_rules_action_set($field, $energy) {
  $info = $field
    ->info();
  $field_name = $info['name'];
  $entity_type = $info['parent']
    ->type();
  $bundle = $info['parent']
    ->getBundle();
  $id = $info['parent']
    ->getIdentifier();
  $lang = LANGUAGE_NONE;
  if ($info['translatable']) {
    global $language;
    $lang = $language->language;
  }
  _radioactivity_update_energy($entity_type, $id, $field_name, $lang, $energy, time(), TRUE);
}

/**
 * Action: Add emitter on page
 */
function radioactivity_rules_action_add_emitter($field, $energy, $accuracy) {
  $info = $field
    ->info();
  $field_id = $info['name'];
  $entity = $info['parent'];
  $entity_type = $entity
    ->type();
  $bundle = $entity
    ->getBundle();
  $entity_id = $entity
    ->getIdentifier();
  $lang = LANGUAGE_NONE;
  if ($info['translatable']) {
    global $language;
    $lang = $language->language;
  }
  $settings = array(
    'accuracy' => $accuracy,
    'energy' => $energy,
    'type' => 'energy',
  );
  $profile = radioactivity_get_field_profile($entity_type, $bundle, $field_id);
  _radioactivity_register_emitter($profile->storage, $entity_type, $bundle, $field_id, $lang, $entity_id, $settings);
  radioactivity_update_emitters();
}

/**
 * Action: Get maximum energy
 */
function radioactivity_rules_action_maximum($field) {
  $info = $field
    ->info();
  $field_id = $info['name'];
  $entity_type = $info['parent']
    ->type();
  $max = _radioactivity_get_field_maximum($field_id, $entity_type);
  return array(
    'maximum_energy' => $max,
  );
}

/**
 * User integration access callback.
 */
function radioactivity_access_callback($type, $name) {
  return user_access('administer radioactivity');
}

Functions

Name	Description
radioactivity_access_callback	User integration access callback.
radioactivity_rules_action_add_emitter	Action: Add emitter on page
radioactivity_rules_action_emit	Action: Emit energy
radioactivity_rules_action_info	Implements hook_rules_action_info().
radioactivity_rules_action_maximum	Action: Get maximum energy
radioactivity_rules_action_set	Action: Set energy
radioactivity_rules_event_info	Implements hook_rules_event_info().