og_actions.module in Organic groups 6

File

modules/og_actions/og_actions.module

<?php

/**
 * Implementation of hook_action_info().
 */
function og_actions_action_info() {
  $actions = array(
    'og_remove_groups_action' => array(
      'type' => 'node',
      'description' => t('Remove post from all groups'),
      'configurable' => FALSE,
      'behavior' => array(
        'changes_node_property',
      ),
      // For Views Bulk Operations module
      'hooks' => array(
        'nodeapi' => array(
          'insert',
          'update',
        ),
      ),
    ),
    'og_add_group_action' => array(
      'type' => 'node',
      'description' => t('Add post to the specified group'),
      'behavior' => array(
        'changes_node_property',
      ),
      // For Views Bulk Operations module
      'configurable' => TRUE,
      'hooks' => array(
        'nodeapi' => array(
          'insert',
          'update',
        ),
      ),
    ),
    'og_remove_group_action' => array(
      'type' => 'node',
      'description' => t('Remove post from the specified group'),
      'behavior' => array(
        'changes_node_property',
      ),
      // For Views Bulk Operations module
      'configurable' => TRUE,
      'hooks' => array(
        'nodeapi' => array(
          'insert',
          'update',
        ),
      ),
    ),
    'og_subscribe_user_action' => array(
      'type' => 'user',
      'description' => t('Subscribe user to the specified group'),
      'configurable' => TRUE,
      'hooks' => array(),
    ),
    'og_unsubscribe_user_action' => array(
      'type' => 'user',
      'description' => t('Unsubscribe user from the specified group'),
      'configurable' => TRUE,
      'hooks' => array(),
    ),
    'og_promote_user_action' => array(
      'type' => 'user',
      'description' => t('Promote user to an administrator in the specified group'),
      'configurable' => TRUE,
      'hooks' => array(),
    ),
    'og_demote_user_action' => array(
      'type' => 'user',
      'description' => t('Demote user from an administrator in the specified group'),
      'configurable' => TRUE,
      'hooks' => array(),
    ),
    'og_approve_user_action' => array(
      'type' => 'user',
      'description' => t('Approve user subscription to the specified group'),
      'configurable' => TRUE,
      'hooks' => array(),
    ),
    'og_deny_user_action' => array(
      'type' => 'user',
      'description' => t('Deny user subscription to the specified group'),
      'configurable' => TRUE,
      'hooks' => array(),
    ),
  );
  if (module_exists('og_access')) {
    $actions += array(
      'og_make_public_action' => array(
        'type' => 'node',
        'description' => t('Make post publicly visible'),
        'behavior' => array(
          'changes_node_property',
        ),
        // For Views Bulk Operations module
        'configurable' => FALSE,
        'hooks' => array(
          'nodeapi' => array(
            'insert',
            'update',
          ),
        ),
      ),
      'og_make_private_action' => array(
        'type' => 'node',
        'description' => t('Make post private to its groups'),
        'behavior' => array(
          'changes_node_property',
        ),
        // For Views Bulk Operations module
        'configurable' => FALSE,
        'hooks' => array(
          'nodeapi' => array(
            'insert',
            'update',
          ),
        ),
      ),
    );
  }
  return $actions;
}

/**
 * Action to make a node public in organic groups. Requires actions.module.
 */
function og_make_public_action($node, $context) {
  if (isset($node->og_groups)) {
    $node->og_public = 1;
    watchdog('action', 'Set node %id to public.', array(
      '%id' => intval($node->nid),
    ));
  }
}

/**
 * Action to make a node private in organic groups. Requires actions.module.
 */
function og_make_private_action($node, $context) {
  if (isset($node->og_groups)) {
    $node->og_public = 0;
    watchdog('action', 'Set node %id to private.', array(
      '%id' => intval($node->nid),
    ));
  }
}

/**
 * Action to remove a node from all groups. Requires actions.module.
 */
function og_remove_groups_action($node, $context) {
  if (!empty($node->og_groups)) {
    $node->og_groups = array();
    watchdog('action', 'Removed node %id from all groups.', array(
      '%id' => intval($node->nid),
    ));
  }
}

/**
 * A configurable action to add a node to a specific group in organic groups.
 * Requires actions.module.
 */
function og_add_group_action($node, $context) {
  if (isset($context['group'])) {
    $node->og_groups[$context['group']] = $context['group'];
    watchdog('action', 'Added node id %id to %group.', array(
      '%id' => intval($node->nid),
      '%group' => $context['group'],
    ));
  }
}

/**
 * Configuration form for Add Group action.
 */
function og_add_group_action_form($context) {
  if (!isset($context['group'])) {
    $context['group'] = '';
  }
  $groups = og_all_groups_options();
  if (count($groups)) {
    $form = array();
    $form['group'] = array(
      '#type' => 'select',
      '#title' => t('Group'),
      '#options' => $groups,
      '#description' => t('Select the group to add to the node.'),
      '#default_value' => $context['group'],
      '#required' => TRUE,
    );
  }
  else {
    drupal_set_message(t('Please <a href="!url">create</a> a group first.', array(
      '!url' => url('admin/content'),
    )));
  }
  return $form;
}
function og_add_group_action_submit($form, &$form_state) {
  return array(
    'group' => $form_state['values']['group'],
  );
}

/**
 * A configurable action to remove a node from a specific group in og.
 * Requires actions.module
 */
function og_remove_group_action($node, $context) {
  if (isset($context['group'])) {
    foreach ($node->og_groups as $key => $gid) {
      if ($gid == $context['group']) {
        unset($node->og_groups[$key]);
      }
    }
    watchdog('action', 'Removed node id %id from %group.', array(
      '%id' => intval($node->nid),
      '%group' => $context['group'],
    ));
  }
}

/**
 * Configuration form for Remove Group action.
 */
function og_remove_group_action_form($context) {
  if (!isset($context['group'])) {
    $context['group'] = '';
  }
  $groups = og_all_groups_options();
  if (count($groups)) {
    $form = array();
    $form['group'] = array(
      '#type' => 'select',
      '#title' => t('Group'),
      '#options' => $groups,
      '#description' => t('Select the group to remove from the node.'),
      '#default_value' => $context['group'],
      '#required' => TRUE,
    );
  }
  else {
    drupal_set_message(t('There are no groups. You must have at least one existing group with nodes assigned to use this action.'));
  }
  return $form;
}

/**
 * Submit handler for Remove Group action configuration.
 */
function og_remove_group_action_submit($form, &$form_state) {
  return array(
    'group' => $form_state['values']['group'],
  );
}

/**
 * A configurable action to subscribe a user to a specific group.
 */
function og_subscribe_user_action($account, $context) {
  if (isset($context['group'])) {
    og_save_subscription($context['group'], $account->uid, array(
      'is_active' => 1,
    ));
    watchdog('action', 'Subscribed user %name to %group.', array(
      '%name' => $account->name,
      '%group' => $context['group'],
    ));
  }
}

/**
 * Configuration form for Add User action.
 */
function og_subscribe_user_action_form($context) {
  $form = array();
  if (!isset($context['group'])) {
    $context['group'] = '';
  }
  $groups = og_all_groups_options();
  if (count($groups)) {
    $form['group'] = array(
      '#type' => 'select',
      '#title' => t('Group'),
      '#options' => $groups,
      '#description' => t('Select the group to which this user should be subscribed.'),
      '#default_value' => $context['group'],
      '#required' => TRUE,
    );
  }
  else {
    drupal_set_message(t('Please <a href="!url">create</a> a group first.', array(
      '!url' => url('admin/content'),
    )));
  }
  return $form;
}

/**
 * Submission handler for Subscribe User action configuration form.
 */
function og_subscribe_user_action_submit($form, &$form_state) {
  return array(
    'group' => $form_state['values']['group'],
  );
}

/**
 * A configurable action to unsubscribe a user from a specific group.
 */
function og_unsubscribe_user_action($account, $context) {
  if (isset($context['group'])) {
    og_delete_subscription($context['group'], $account->uid);
    watchdog('action', 'Unsubscribed user %name to %group.', array(
      '%name' => $account->name,
      '%group' => $context['group'],
    ));
  }
}

/**
 * Configuration form for Unsubscribe User action.
 */
function og_unsubscribe_user_action_form($context) {
  $form = array();
  if (!isset($context['group'])) {
    $context['group'] = '';
  }
  $groups = og_all_groups_options();
  if (count($groups)) {
    $form['group'] = array(
      '#type' => 'select',
      '#title' => t('Group'),
      '#options' => $groups,
      '#description' => t('Select the group to which this user should be unsubscribed.'),
      '#default_value' => $context['group'],
      '#required' => TRUE,
    );
  }
  else {
    drupal_set_message(t('Please <a href="!url">create</a> a group first.', array(
      '!url' => url('admin/conten
t'),
    )));
  }
  return $form;
}

/**
 * Submission handler for Unsubscribe User action configuration form.
 */
function og_unsubscribe_user_action_submit($form, &$form_state) {
  return array(
    'group' => $form_state['values']['group'],
  );
}

/**
 * A configurable action to promote a user to a group administrator.
 */
function og_promote_user_action($account, $context) {
  if (isset($context['group'])) {
    og_save_subscription($context['group'], $account->uid, array(
      'is_admin' => 1,
    ));
    watchdog('action', '%name was promoted to <em>group administrator</em> in %group.', array(
      '%name' => $account->name,
      '%group' => $context['group'],
    ));
  }
}

/**
 * Configuration form for Promote User action.
 */
function og_promote_user_action_form($context) {
  $form = array();
  if (!isset($context['group'])) {
    $context['group'] = '';
  }
  $groups = og_all_groups_options();
  if (count($groups)) {
    $form['group'] = array(
      '#type' => 'select',
      '#title' => t('Group'),
      '#options' => $groups,
      '#description' => t('Select the group to which this user should be promoted.'),
      '#default_value' => $context['group'],
      '#required' => TRUE,
    );
  }
  else {
    drupal_set_message(t('Please <a href="!url">create</a> a group first.', array(
      '!url' => url('admin/conten
t'),
    )));
  }
  return $form;
}

/**
 * Submission handler for Promote User action configuration form.
 */
function og_promote_user_action_submit($form, &$form_state) {
  return array(
    'group' => $form_state['values']['group'],
  );
}

/**
 * A configurable action to demote a user from a group administrator.
 */
function og_demote_user_action($account, $context) {
  if (isset($context['group'])) {
    og_save_subscription($context['group'], $account->uid, array(
      'is_admin' => 0,
    ));
    watchdog('action', 'Demoted user %name from <em>group administrator</em> in %group.', array(
      '%name' => $account->name,
      '%group' => $context['group'],
    ));
  }
}

/**
 * Configuration form for Demote User action.
 */
function og_demote_user_action_form($context) {
  $form = array();
  if (!isset($context['group'])) {
    $context['group'] = '';
  }
  $groups = og_all_groups_options();
  if (count($groups)) {
    $form['group'] = array(
      '#type' => 'select',
      '#title' => t('Group'),
      '#options' => $groups,
      '#description' => t('Select the group from which this user should be demoted.'),
      '#default_value' => $context['group'],
      '#required' => TRUE,
    );
  }
  else {
    drupal_set_message(t('Please <a href="!url">create</a> a group first.', array(
      '!url' => url('admin/conten
t'),
    )));
  }
  return $form;
}

/**
 * Submission handler for Demote User action configuration form.
 */
function og_demote_user_action_submit($form, &$form_state) {
  return array(
    'group' => $form_state['values']['group'],
  );
}

/**
 * A configurable action to approve a user from a group administrator.
 */
function og_approve_user_action($account, $context) {
  if (isset($context['group'])) {
    og_save_subscription($context['group'], $account->uid, array(
      'is_active' => 1,
    ));
    watchdog('action', "Approved user %name's subscription to %group.", array(
      '%name' => $account->name,
      '%group' => $context['group'],
    ));
  }
}

/**
 * Configuration form for Approve User action.
 */
function og_approve_user_action_form($context) {
  $form = array();
  if (!isset($context['group'])) {
    $context['group'] = '';
  }
  $groups = og_all_groups_options();
  if (count($groups)) {
    $form['group'] = array(
      '#type' => 'select',
      '#title' => t('Group'),
      '#options' => $groups,
      '#description' => t('Select the group whose user subscription request should be approved.'),
      '#default_value' => $context['group'],
      '#required' => TRUE,
    );
  }
  else {
    drupal_set_message(t('Please <a href="!url">create</a> a group first.', array(
      '!url' => url('admin/conten
t'),
    )));
  }
  return $form;
}

/**
 * Submission handler for Approve User action configuration form.
 */
function og_approve_user_action_submit($form, &$form_state) {
  return array(
    'group' => $form_state['values']['group'],
  );
}

/**
 * A configurable action to deny a user's group subscription request.
 */
function og_deny_user_action($account, $context) {
  if (isset($context['group'])) {
    og_save_subscription($context['group'], $account->uid, array(
      'is_active' => 0,
    ));
    watchdog('action', "Denied user %name's subscription to %group.", array(
      '%name' => $account->name,
      '%group' => $context['group'],
    ));
  }
}

/**
 * Configuration form for Deny User action.
 */
function og_deny_user_action_form($context) {
  $form = array();
  if (!isset($context['group'])) {
    $context['group'] = '';
  }
  $groups = og_all_groups_options();
  if (count($groups)) {
    $form['group'] = array(
      '#type' => 'select',
      '#title' => t('Group'),
      '#options' => $groups,
      '#description' => t('Select the group whose user subscription request should be denied.'),
      '#default_value' => $context['group'],
      '#required' => TRUE,
    );
  }
  else {
    drupal_set_message(t('Please <a href="!url">create</a> a group first.', array(
      '!url' => url('admin/conten
t'),
    )));
  }
  return $form;
}

/**
 * Submission handler for Deny User action configuration form.
 */
function og_deny_user_action_submit($form, &$form_state) {
  return array(
    'group' => $form_state['values']['group'],
  );
}

/**
 * Implementation of hook_rules_action_info_alter().
 *
 * Lets the actions show up under "Organic Groups" in rules.
 */
function og_actions_rules_action_info_alter(&$actions) {
  foreach (array_keys(og_actions_action_info()) as $action_name) {
    $actions['rules_core_' . $action_name]['module'] = 'Organic groups';
  }
}

Functions

Name	Description
og_actions_action_info	Implementation of hook_action_info().
og_actions_rules_action_info_alter	Implementation of hook_rules_action_info_alter().
og_add_group_action	A configurable action to add a node to a specific group in organic groups. Requires actions.module.
og_add_group_action_form	Configuration form for Add Group action.
og_add_group_action_submit
og_approve_user_action	A configurable action to approve a user from a group administrator.
og_approve_user_action_form	Configuration form for Approve User action.
og_approve_user_action_submit	Submission handler for Approve User action configuration form.
og_demote_user_action	A configurable action to demote a user from a group administrator.
og_demote_user_action_form	Configuration form for Demote User action.
og_demote_user_action_submit	Submission handler for Demote User action configuration form.
og_deny_user_action	A configurable action to deny a user's group subscription request.
og_deny_user_action_form	Configuration form for Deny User action.
og_deny_user_action_submit	Submission handler for Deny User action configuration form.
og_make_private_action	Action to make a node private in organic groups. Requires actions.module.
og_make_public_action	Action to make a node public in organic groups. Requires actions.module.
og_promote_user_action	A configurable action to promote a user to a group administrator.
og_promote_user_action_form	Configuration form for Promote User action.
og_promote_user_action_submit	Submission handler for Promote User action configuration form.
og_remove_groups_action	Action to remove a node from all groups. Requires actions.module.
og_remove_group_action	A configurable action to remove a node from a specific group in og. Requires actions.module
og_remove_group_action_form	Configuration form for Remove Group action.
og_remove_group_action_submit	Submit handler for Remove Group action configuration.
og_subscribe_user_action	A configurable action to subscribe a user to a specific group.
og_subscribe_user_action_form	Configuration form for Add User action.
og_subscribe_user_action_submit	Submission handler for Subscribe User action configuration form.
og_unsubscribe_user_action	A configurable action to unsubscribe a user from a specific group.
og_unsubscribe_user_action_form	Configuration form for Unsubscribe User action.
og_unsubscribe_user_action_submit	Submission handler for Unsubscribe User action configuration form.