twitter_post.field.inc in Twitter 7.6

Field configuration for twitter_post module.

File

twitter_post/twitter_post.field.inc

<?php

/**
 * @file
 * Field configuration for twitter_post module.
 */

/**
 * Implements hook_field_info()
 */
function twitter_post_field_info() {
  return array(
    'twitter_post' => array(
      'label' => t('Twitter'),
      'description' => t('Allows posting to Twitter.com.'),
      'default_widget' => 'twitter_post_widget',
      'default_formatter' => 'text_text',
    ),
  );
}

/**
 * Implement hook_field_widget_info().
 */
function twitter_post_field_widget_info() {
  return array(
    'twitter_post_widget' => array(
      'label' => t('Post to Twitter'),
      'field types' => array(
        'twitter_post',
      ),
    ),
  );
}

/**
 * Implements hook_field_widget_form().
 */
function twitter_post_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
  if (!is_numeric($delta)) {
    $delta = 0;
  }

  // Load the default values for this field.
  if (isset($instance['default_value'][$delta])) {
    $defaults = $instance['default_value'][$delta];
  }
  else {
    $defaults = array(
      'status' => 0,
      'message' => _twitter_post_default_message($instance['entity_type']),
    );
  }

  // Work out the field's current values, use the defaults if not found.
  $status = isset($items[$delta]['status']) ? $items[$delta]['status'] : $defaults['status'];
  $message = isset($items[$delta]['message']) ? $items[$delta]['message'] : $defaults['message'];

  // If this entity was previously published, disable the status.
  if (isset($element['#entity']) && !empty($element['#entity']->status)) {
    $status = 0;
  }

  // Build the basic fields.
  $element += array(
    '#attached' => array(
      'js' => array(
        drupal_get_path('module', 'twitter_post') . '/twitter_post.js',
      ),
    ),
    'status' => array(
      '#type' => 'checkbox',
      '#title' => t('Announce this post on Twitter'),
      '#default_value' => $status,
      '#id' => 'twitter-toggle',
    ),
    'message' => array(
      '#type' => 'textfield',
      '#title' => t('Twitter.com status'),
      '#default_value' => $message,
      '#description' => t('The given text will be posted to Twitter.com. See Replacement Patterns below for a list of available tokens. Note that if a URL is being included, the maximum length of the rest of the tweet is 117 characters.'),
      '#maxlength' => 150,
      '#attributes' => array(
        'class' => array(
          'twitter-post-message',
        ),
      ),
      '#states' => array(
        'visible' => array(
          'input#twitter-toggle' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    ),
    'token_help' => array(
      '#title' => t('Replacement patterns'),
      '#type' => 'fieldset',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#description' => t('Prefer raw-text replacements for text to avoid problems with HTML entities!'),
      '#states' => array(
        'visible' => array(
          'input#twitter-toggle' => array(
            'checked' => TRUE,
          ),
        ),
      ),
      'help' => array(
        '#theme' => 'token_tree',
        '#token_types' => array(
          $instance['entity_type'],
        ),
        '#global_types' => TRUE,
        '#click_insert' => TRUE,
        '#dialog' => TRUE,
      ),
    ),
  );

  // Only add the account selector when editing a node.
  if (!empty($element['#entity'])) {
    global $user;
    $account = user_load($user->uid);
    $langcode = empty($langcode) ? entity_language($entity_type, $entity) : $langcode;
    module_load_include('inc', 'twitter');

    // Only show Twitter accounts that are either global or are tied to this
    // user.
    $access_global = user_access('post to twitter with global account', $account);
    $twitter_accounts = twitter_load_authenticated_accounts($account->uid, $access_global);
    $options = array();
    foreach ($twitter_accounts as $twitter_account) {
      $options[$twitter_account->twitter_uid] = $twitter_account->screen_name;
    }

    // The current value on the form field.
    $twitter_uid = isset($items[$delta]['account']) ? $items[$delta]['account'] : NULL;

    // No accounts were found. Oops.
    if (empty($options)) {

      // Save the current value.
      $element += array(
        'account' => array(
          '#type' => 'value',
          '#value' => $twitter_uid,
          '#id' => 'twitter-account',
        ),
      );

      // Disable the tweet options.
      $element['status']['#disabled'] = TRUE;
      $element['message']['#disabled'] = TRUE;
      $element['token_help']['#access'] = TRUE;
    }
    elseif (count($options) > 1) {
      $element += array(
        'account' => array(
          '#type' => 'select',
          '#title' => t('Twitter Account'),
          '#options' => $options,
          '#id' => 'twitter-account',
          '#default_value' => $twitter_uid,
          '#states' => array(
            'visible' => array(
              'input#twitter-toggle' => array(
                'checked' => TRUE,
              ),
            ),
          ),
        ),
      );
    }
    else {
      if (empty($twitter_uid)) {
        $twitter_uid = key($options);
      }
      $screen_name = twitter_screen_name_from_uid($twitter_uid);
      $element += array(
        'account' => array(
          '#type' => 'value',
          '#value' => $twitter_uid,
          '#id' => 'twitter-account',
        ),
        'account_name' => array(
          '#type' => 'item',
          '#title' => t('Twitter account'),
          '#markup' => _twitter_user_profile($screen_name),
          '#states' => array(
            'visible' => array(
              'input#twitter-toggle' => array(
                'checked' => TRUE,
              ),
            ),
          ),
        ),
      );
    }
  }
  return $element;
}

/**
 * Sets default messages for core entities.
 *
 * @param string $entity_type
 *   The entity type name.
 * @return
 *   A string with a suggested default message for the tweet.
 */
function _twitter_post_default_message($entity_type) {
  switch ($entity_type) {
    case 'comment':
      $message = 'New comment: [comment:url:absolute]';
      break;
    case 'node':
      $message = 'New post: [node:title] [node:url:absolute]';
      break;
    case 'user':
      $message = 'New user: [current-user:name]';
      break;
    default:
      $message = 'Select replacement patterns below to build your tweet.';
      break;
  }
  return $message;
}

/**
 * Implements hook_field_formatter_settings_summary().
 */
function twitter_post_field_formatter_settings_summary($field, $instance, $view_mode) {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];
  if ($settings['type'] != 'none') {
    $summary = t('Default status: @status. Message: @message', array(
      '@status' => $settings['status'],
      '@message' => $settings['message'],
    ));
  }
  else {
    $summary = t('Twitter post field is disabled.');
  }
  return $summary;
}

/**
 * Implement hook_field_is_empty().
 */
function twitter_post_field_is_empty($item, $field) {
  return strlen($item['message']) == 0;
}

/**
 * Implements hook_field_access()
 */
function twitter_post_field_access($op, $field, $entity_type, $entity, $account) {
  if ($field['type'] == 'twitter_post') {
    return user_access('post to twitter', $account);
  }
}

Functions

Name	Description
twitter_post_field_access	Implements hook_field_access()
twitter_post_field_formatter_settings_summary	Implements hook_field_formatter_settings_summary().
twitter_post_field_info	Implements hook_field_info()
twitter_post_field_is_empty	Implement hook_field_is_empty().
twitter_post_field_widget_form	Implements hook_field_widget_form().
twitter_post_field_widget_info	Implement hook_field_widget_info().
_twitter_post_default_message	Sets default messages for core entities.