message_handler_field_message_render.inc in Message 7

Contains the message field handler.

File

includes/views/handlers/message_handler_field_message_render.inc

<?php

/**
 * @file
 * Contains the message field handler.
 */

/**
 * Views field handler for rendering a message.
 *
 * @ingroup views
 */
class message_handler_field_message_render extends views_handler_field {

  /**
   * Set default field name to render.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['field_name'] = array(
      'default' => MESSAGE_FIELD_MESSAGE_TEXT,
    );
    $options['partials'] = array(
      'default' => FALSE,
    );
    $options['partials_delta'] = array(
      'default' => 0,
    );
    return $options;
  }

  /**
   * Provide form to select a field name to render.
   */
  function options_form(&$form, &$form_state) {
    $options = array();
    foreach (field_info_instances('message_type') as $bundle => $instances) {
      foreach ($instances as $field_name => $instance) {
        if (!empty($options[$field_name])) {
          continue;
        }
        $field = field_info_field($field_name);
        if (!in_array($field['type'], array(
          'text_long',
          'text',
        ))) {
          continue;
        }
        $options[$field_name] = $instance['label'];
      }
    }

    // Get all the text fields attached to a message-type.
    $form['field_name'] = array(
      '#type' => 'select',
      '#title' => t('Field name'),
      '#description' => t('Select the field name to render.'),
      '#options' => $options,
      '#default_value' => $this->options['field_name'],
      '#required' => TRUE,
    );

    // Get all the text fields attached to a message-type.
    $form['partials'] = array(
      '#type' => 'checkbox',
      '#title' => t('Partial'),
      '#description' => t('Render only a single delta out of the whole message (in case it is separated in multiple deltas).'),
      '#default_value' => $this->options['partials'],
    );
    $form['partials_delta'] = array(
      '#type' => 'select',
      '#title' => t('Partial delta'),
      '#description' => t('The delta to use for partial rendering.'),
      '#default_value' => $this->options['partials_delta'],
      '#options' => range(0, 20),
      '#dependency' => array(
        'edit-options-partials' => array(
          TRUE,
        ),
      ),
    );
    parent::options_form($form, $form_state);
  }
  function render($values) {
    $field_alias = $this->field_alias;
    if (!empty($values->{$field_alias}) && ($message = message_load($values->{$field_alias}))) {
      $options = array(
        'field name' => $this->options['field_name'],
        'partials' => $this->options['partials'],
        'partial delta' => $this->options['partials_delta'],
      );
      return $message
        ->getText(NULL, $options);
    }
  }

}

Classes

Name	Description
message_handler_field_message_render	Views field handler for rendering a message.