Stripping CVS keywords

[project/privatemsg.git] / views / views_handler_field_privatemsg_link.inc

<?php

/**
 * @file
 * Contains the privatemsg link views field handler.
 */

/**
 * Provides a configurable link to the new message form for a specific user.
 */
class views_handler_field_privatemsg_link extends views_handler_field {

  /**
   * Add uid as a additional field.
   */
  function construct() {
    parent::construct();
    $this->additional_fields['uid'] = 'uid';
  }

  /**
   * Define our additional configuration setting.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['text'] = array('default' => '', 'translatable' => TRUE);
    $options['subject'] = array('default' => '', 'translatable' => TRUE);
    $options['return'] = array('default' => TRUE, 'translatable' => FALSE);
    $options['custom_destination'] = array('default' => '', 'translatable' => FALSE);
    return $options;
  }

  /**
   * Define the configuration form for our textfield.
   */
  function options_form(&$form, &$form_state) {
    $form['label'] = array(
      '#type' => 'textfield',
      '#title' => t('Label'),
      '#default_value' => isset($this->options['label']) ? $this->options['label'] : '',
      '#description' => t('The label for this field that will be displayed to end users if the style requires it.'),
    );

    $form['text'] = array(
      '#type' => 'textfield',
      '#title' => t('Text to display'),
      '#default_value' => $this->options['text'],
      '#description' => t('Define the text to use for the link title. You can use replacement tokens to insert any existing field output.'),
    );

    $form['subject'] = array(
      '#type' => 'textfield',
      '#title' => t('Pre-filled subject'),
      '#default_value' => $this->options['subject'],
      '#description' => t('Define the subject that will be pre-filled in the send message form. You can use replacement tokens to insert any existing field output.'),
    );

    $form['return'] = array(
      '#type' => 'checkbox',
      '#title' => t('Return to view after message was sent.'),
      '#default_value' => $this->options['return'],
      '#description' => t('Should the user be redirected back to the current view when the message was sent.'),
    );

    $form['custom_destination'] = array(
      '#type' => 'textfield',
      '#title' => t('Custom destination'),
      '#default_value' => $this->options['custom_destination'],
      '#description' => t('If non-empty, users will be forwared to the given url. You can use replacement tokens to insert any existing field output.'),
      '#process' => array('views_process_dependency'),
      '#dependency' => array(
        'edit-options-return' => array(1),
      ),
    );

    // Get a list of the available fields and arguments for token replacement.
    $options = array();
    foreach ($this->view->display_handler->get_handlers('field') as $field => $handler) {
      $options[t('Fields')]["[$field]"] = $handler->ui_name();
      // We only use fields up to (and including) this one.
      if ($field == $this->options['id']) {
        break;
      }
    }
    $count = 0; // This lets us prepare the key as we want it printed.
    foreach ($this->view->display_handler->get_handlers('argument') as $arg => $handler) {
      $options[t('Arguments')]['%' . ++$count] = $handler->ui_name();
    }

    // Add documentation about the new message token. Note that this is not
    // a real token that will be replaced but it is handled in
    // privatemsg_send_submit().
    $options[t('Privatemsg')]['[new-message]'] = t('This will redirect to the newly sent message.');

    // Default text.
    $output = t('<p>You must add some additional fields to this display before using this field. These fields may be marked as <em>Exclude from display</em> if you prefer. Note that due to rendering order, you cannot use fields that come after this field; if you need a field not listed here, rearrange your fields.</p>');
    // We have some options, so make a list.
    if (!empty($options)) {
      $output = t('<p>The following substitution patterns are available for this display. Use the pattern shown on the left to display the value indicated on the right. Note that due to rendering order, you cannot use fields that come after this field; if you need a field not listed here, rearrange your fields.</p>');
      foreach (array_keys($options) as $type) {
        if (!empty($options[$type])) {
          $items = array();
          $title = t(ucwords($type));
          foreach ($options[$type] as $key => $value) {
            $items[] = $key .' == '. $value;
          }
          $output .= theme('item_list', $items, $title);
        }
      }
    }

    $form['help'] = array(
      '#type' => 'markup',
      '#id' => 'views-tokens-help',
      '#value' => '<div><fieldset id="views-tokens-help"><legend>' . t('Replacement patterns') . '</legend>' . $output . '</fieldset></div>',
    );
  }

  /**
   * Renders our field, displays a link if the user is allowed to.
   */
  function render($values) {
    if (isset($values->uid)) {
      $uid = $values->uid;
    }
    elseif (isset($values->users_uid)) {
      $uid = $values->users_uid;
    }
    else {
      return '';
    }
    $text = t('Write private message');
    if (!empty($this->options['text'])) {
      $tokens = $this->get_render_tokens($this);
      $text = strip_tags(strtr($this->options['text'], $tokens));
    }
    $subject = NULL;
    if (!empty($this->options['subject'])) {
      $tokens = $this->get_render_tokens($this);
      $subject = strip_tags(strtr($this->options['subject'], $tokens));
    }

    $options = array();
    if ($this->options['return']) {
      if (!empty($this->options['custom_destination'])) {
        $tokens = $this->get_render_tokens($this);
        $destination = strip_tags(strtr($this->options['custom_destination'], $tokens));
        $options['query'] = array('destination' => $destination);
      }
      else {
        $options['query'] = drupal_get_destination();
      }
    }

    $data = '';
    if (($recipient = privatemsg_user_load($uid)) && ($url = privatemsg_get_link(array($recipient), NULL, $subject))) {
      $data = l($text, $url, $options);
    }
    return $data;
  }

  /**
   * Only display the column for users with the appropriate permission.
   */
  function access() {
    return privatemsg_user_access('write privatemsg');
  }

  /**
   * Just do some basic checks, don't add "privatemsg_link" as field.
   */
  function query() {
    $this->ensure_my_table();
    $this->add_additional_fields();
  }
}