user_relationships_rules.rules_forms.inc in User Relationships 6

Rules configuration forms for the system module

File

user_relationships_rules/user_relationships_rules.rules_forms.inc

<?php

/**
 * @file Rules configuration forms for the system module
 */

/**
 * Action create relationship configuration form.
 */
function user_relationships_rules_action_create_relationship_form($settings, &$form) {
  $settings += array(
    'requester' => '',
    'requestee' => '',
    'relationship_type' => '',
    'message' => '',
    'confirmation' => '',
  );
  $form['settings']['requester'] = array(
    '#type' => 'textfield',
    '#title' => t('Requester'),
    '#default_value' => $settings['requester'],
    '#description' => t('User ID of requester. Insert token here for dynamic action.'),
  );
  $form['settings']['requestee'] = array(
    '#type' => 'textfield',
    '#title' => t('Requestee'),
    '#default_value' => $settings['requestee'],
    '#description' => t('User ID of requestee. Insert token here for dynamic action.'),
  );
  $options = array();
  $relationship_types = user_relationships_types_load();
  foreach ($relationship_types as $relationship_type) {
    $options[$relationship_type->rtid] = $relationship_type->name;
  }
  $form['settings']['relationship_type'] = array(
    '#type' => 'select',
    '#title' => t('Relationship type'),
    '#default_value' => $settings['relationship_type'],
    '#options' => $options,
    '#description' => t('Select relationship type.'),
  );
  $form['settings']['approve'] = array(
    '#type' => 'checkbox',
    '#title' => t('Approve relationship'),
    '#default_value' => $settings['approve'],
    '#description' => t('Check if relationship should be approved.'),
  );
}

/**
 * Action delete relationship configuration form.
 */
function user_relationships_rules_action_delete_relationship_form($settings, &$form) {
  $settings += array(
    'requester' => '',
    'requestee' => '',
    'op' => '',
  );
  $form['settings']['requester'] = array(
    '#type' => 'textfield',
    '#title' => t('Requester'),
    '#default_value' => $settings['requester'],
    '#description' => t('User ID of requester. Insert token here for dynamic action.'),
  );
  $form['settings']['requestee'] = array(
    '#type' => 'textfield',
    '#title' => t('Requestee'),
    '#default_value' => $settings['requestee'],
    '#description' => t('User ID of requestee. Insert token here for dynamic action.'),
  );
  $options = array();
  $relationship_types = user_relationships_types_load();
  foreach ($relationship_types as $relationship_type) {
    $options[$relationship_type->rtid] = $relationship_type->name;
  }
  $form['settings']['relationship_type'] = array(
    '#type' => 'select',
    '#title' => t('Relationship type'),
    '#default_value' => $settings['relationship_type'],
    '#options' => $options,
    '#description' => t('Select relationship type.'),
  );
  $form['settings']['op'] = array(
    '#type' => 'select',
    '#title' => t('Operation'),
    '#default_value' => $settings['op'],
    '#options' => array(
      'remove' => t('Remove'),
      'cancel' => t('Cancel'),
      'disapprove' => t('Disapprove'),
    ),
    '#description' => t('Select the operation you wish to perform.'),
  );
}

/**
 * Condition relationship has type configuration form.
 */
function user_relationships_rules_condition_relationship_has_type_form($settings, &$form) {
  $settings += array(
    'relationship_type' => '',
  );
  $options = array();
  $relationship_types = user_relationships_types_load();
  foreach ($relationship_types as $relationship_type) {
    $options[$relationship_type->rtid] = $relationship_type->name;
  }
  $form['settings']['rtid'] = array(
    '#type' => 'select',
    '#multiple' => TRUE,
    '#title' => t('Relationship type'),
    '#default_value' => $settings['rtid'],
    '#options' => $options,
    '#description' => t('Select relationship type you want to check for.'),
  );
}

/**
 * Condition users are related configuration form.
 */
function user_relationships_rules_condition_users_are_related_form($settings, &$form) {
  $settings += array(
    'relationship_types' => '',
  );
  $options = array();
  $relationship_types = user_relationships_types_load();
  foreach ($relationship_types as $relationship_type) {
    $options[$relationship_type->rtid] = $relationship_type->name;
  }
  $form['settings']['relationship_types'] = array(
    '#type' => 'select',
    '#multiple' => TRUE,
    '#title' => t('Relationship types'),
    '#default_value' => $settings['relationship_types'],
    '#options' => $options,
    '#description' => t('Select a special relationship type you want to check for. Leave empty to check for all.'),
  );
}

Functions

Name	Description
user_relationships_rules_action_create_relationship_form	Action create relationship configuration form.
user_relationships_rules_action_delete_relationship_form	Action delete relationship configuration form.
user_relationships_rules_condition_relationship_has_type_form	Condition relationship has type configuration form.
user_relationships_rules_condition_users_are_related_form	Condition users are related configuration form.