user.inc in Chaos Tool Suite (ctools) 6

Plugin to provide a user context

File

plugins/contexts/user.inc

<?php

/**
 * @file
 *
 * Plugin to provide a user context
 */

/**
 * Plugins are described by creating a $plugin array which will be used
 * by the system that includes this file.
 */
$plugin = array(
  'title' => t("User"),
  'description' => t('A single user object.'),
  'context' => 'ctools_context_create_user',
  'settings form' => 'ctools_context_user_settings_form',
  'settings form validate' => 'ctools_context_user_settings_form_validate',
  'settings form submit' => 'ctools_context_user_settings_form_submit',
  'keyword' => 'user',
  'defaults' => array(
    'type' => 'select',
    'uid' => '',
  ),
  'context name' => 'user',
  'convert list' => 'ctools_context_user_convert_list',
  'convert' => 'ctools_context_user_convert',
  'convert default' => 'name',
  'js' => array(
    'misc/autocomplete.js',
  ),
);

/**
 * It's important to remember that $conf is optional here, because contexts
 * are not always created from the UI.
 */
function ctools_context_create_user($empty, $data = NULL, $conf = FALSE) {
  $context = new ctools_context('user');
  $context->plugin = 'user';
  if ($empty) {
    return $context;
  }
  if ($conf) {
    if ($data['type'] == 'current') {
      global $user;
      $data = $user;
      if (user_is_logged_in()) {
        $data->logged_in_user = TRUE;
      }
    }
    else {
      $data = user_load(array(
        'uid' => $data['uid'],
      ));
    }
  }
  if (!empty($data)) {
    $context->data = $data;
    $context->title = isset($data->name) ? $data->name : t('Anonymous');
    $context->argument = $data->uid;
    return $context;
  }
}
function ctools_context_user_settings_form($conf) {
  ctools_include('dependent');
  $form['type'] = array(
    '#title' => t('Enter the context type'),
    '#type' => 'radios',
    '#options' => array(
      'select' => t('Select a user'),
      'current' => t('Logged in user'),
    ),
    '#default_value' => $conf['type'],
  );
  $form['user'] = array(
    '#title' => t('Enter a user name'),
    '#type' => 'textfield',
    '#maxlength' => 512,
    '#autocomplete_path' => 'user/autocomplete',
    '#process' => array(
      'ctools_dependent_process',
    ),
    '#dependency' => array(
      'radio:context[context_settings][type]' => array(
        'select',
      ),
    ),
  );
  if (!empty($conf['uid'])) {
    $info = user_load($conf['uid']);
    if ($info) {
      $form['user']['#description'] = t('Currently set to !link', array(
        '!link' => theme('username', $info),
      ));
    }
  }
  $form['uid'] = array(
    '#type' => 'value',
    '#value' => $conf['uid'],
  );
  $form['set_identifier'] = array(
    '#type' => 'checkbox',
    '#default_value' => FALSE,
    '#title' => t('Reset identifier to username'),
    '#description' => t('If checked, the identifier will be reset to the user name of the selected user.'),
    '#process' => array(
      'ctools_dependent_process',
    ),
    '#dependency' => array(
      'radio:context[context_settings][type]' => array(
        'select',
      ),
    ),
  );
  return $form;
}

/**
 * Validate a user.
 */
function ctools_context_user_settings_form_validate($form, &$form_values, &$form_state) {
  if ($form_values['type'] != 'select') {
    return;
  }

  // Validate the autocomplete
  if (empty($form_values['uid']) && empty($form_values['user'])) {
    form_error($form['user'], t('You must select a user.'));
    return;
  }
  if (empty($form_values['user'])) {
    return;
  }
  $account = user_load(array(
    'name' => $form_values['user'],
  ));
  if (!$account) {
    form_error($form['user'], t('Invalid user selected.'));
  }
  else {
    form_set_value($form['uid'], $account->uid, $form_state);
  }
}
function ctools_context_user_settings_form_submit($form, &$form_values, &$form_state) {
  if ($form_values['set_identifier']) {
    $account = user_load($form_values['uid']);
    $form_state['values']['context']['identifier'] = $account->name;
  }

  // Don't let this be stored.
  unset($form_values['set_identifier']);
}

/**
 * Provide a list of replacements.
 */
function ctools_context_user_convert_list() {
  $list = array(
    'uid' => t('User ID'),
    'name' => t('User name'),
  );

  // Include tokens provided by token.module.
  if (module_exists('token')) {
    foreach (token_get_list(array(
      'user',
    )) as $tokens) {
      $list += $tokens;
    }
  }
  return $list;
}

/**
 * Convert a context into a string.
 */
function ctools_context_user_convert($context, $type) {
  switch ($type) {
    case 'uid':
      return $context->data->uid;
    case 'name':
      return $context->data->name;
  }

  // Check if token.module can provide the replacement.
  if (module_exists('token')) {
    $values = token_get_values('user', $context->data);
    $key = array_search($type, $values->tokens);
    if ($key !== FALSE) {
      return $values->values[$key];
    }
  }
}

Functions

Name	Description
ctools_context_create_user	It's important to remember that $conf is optional here, because contexts are not always created from the UI.
ctools_context_user_convert	Convert a context into a string.
ctools_context_user_convert_list	Provide a list of replacements.
ctools_context_user_settings_form
ctools_context_user_settings_form_submit
ctools_context_user_settings_form_validate	Validate a user.