twitterfield.module in TwitterField 6

TwitterField: Defines a CCK widget and display formatters for Twitter items.

The CCK text field type is used for storing information.

File

twitterfield.module

<?php

/**
 * @file
 * TwitterField: Defines a CCK widget and display formatters for Twitter items.
 *
 * The CCK text field type is used for storing information.
 */

/**
 * Implementation of hook_theme().
 */
function twitterfield_theme() {
  return array(
    'twitterfield_widget' => array(
      'arguments' => array(
        'element' => NULL,
      ),
    ),
    'twitterfield_formatter_twitter_link' => array(
      'arguments' => array(
        'element' => NULL,
      ),
    ),
    'twitterfield_formatter_twitter_widget' => array(
      'arguments' => array(
        'element' => NULL,
      ),
    ),
    'twitter_widget' => array(
      'arguments' => array(
        'type' => NULL,
        'value' => NULL,
        'title' => NULL,
        'subject' => NULL,
      ),
      'template' => 'twitter-widget',
    ),
    'twitterfield_formatter_twitter_pull' => array(
      'arguments' => array(
        'element' => NULL,
      ),
    ),
  );
}

/* ****************************************************************************
 * Widget Functions
 */

/**
 * Implementation of hook_widget().
 */
function twitterfield_widget(&$form, &$form_state, $field, $items, $delta = 0) {
  $element = array(
    '#title' => $field['widget']['label'],
    '#type' => $field['widget']['type'],
    '#default_value' => isset($items[$delta]) ? $items[$delta] : '',
  );
  return $element;
}

/**
 * Implementation of hook_widget_info().
 */
function twitterfield_widget_info() {
  return array(
    'twitterfield_widget' => array(
      'label' => t('Twitter Item'),
      'field types' => array(
        'text',
      ),
      'multiple values' => CONTENT_HANDLE_CORE,
      'callbacks' => array(
        'default value' => CONTENT_CALLBACK_DEFAULT,
      ),
      'description' => t('Store Twitter Usernames, Lists, Hastags, or Searches'),
    ),
  );
}

/**
 * Implementation of hook_widget_settings().
 */
function twitterfield_widget_settings($op, $widget) {
  switch ($op) {
    case 'form':
      $form = array();
      $form['allowed_types'] = array(
        '#type' => 'checkboxes',
        '#title' => t('Allowed Types'),
        '#default_value' => isset($widget['allowed_types']) ? $widget['allowed_types'] : array(
          'username',
        ),
        '#options' => array(
          'username' => t('Usernames (@username)'),
          'list' => t('Lists (@username/list)'),
          'hashtag' => t('Hashtags (#topic)'),
          'search' => t('Searches'),
        ),
        '#description' => t('Select which types of expressions can be stored in this field.'),
        '#element_validate' => array(
          '_twitterfield_widget_settings_allowed_types_validate',
        ),
      );
      $form['size'] = array(
        '#type' => 'textfield',
        '#title' => t('Size of textfield'),
        '#default_value' => isset($widget['size']) ? $widget['size'] : 60,
        '#element_validate' => array(
          '_element_validate_integer_positive',
        ),
        '#required' => TRUE,
      );
      return $form;
    case 'save':
      return array(
        'allowed_types',
        'size',
      );
  }
}

/**
 * #element_validate function for widget settings form Allowed Types selection.
 */
function _twitterfield_widget_settings_allowed_types_validate($element, &$form_state) {
  if (!array_filter($form_state['values']['allowed_types'])) {
    form_set_error('allowed_types', t('You must select at least one type to allow.'));
  }
}

/**
 * Implementation of hook_elements().
 */
function twitterfield_elements() {
  return array(
    'twitterfield_widget' => array(
      '#input' => TRUE,
      '#process' => array(
        'twitterfield_widget_process',
      ),
      '#element_validate' => array(
        'twitterfield_widget_validate',
      ),
    ),
  );
}

/**
 * An element #process callback for the twitterfield_widget field type.
 */
function twitterfield_widget_process($element, $edit, &$form_state, $form) {
  $field = $form['#field_info'][$element['#field_name']];
  $element['value'] = array(
    '#type' => 'textfield',
    '#default_value' => isset($element['#value']['value']) ? $element['#value']['value'] : NULL,
    '#size' => !empty($field['widget']['size']) ? $field['widget']['size'] : 60,
    '#attributes' => array(
      'class' => 'text',
    ),
    // The following values were set by the content module and need
    // to be passed down to the nested element.
    '#title' => $element['#title'],
    '#description' => $element['#description'],
    '#required' => $element['#required'],
    '#field_name' => $element['#field_name'],
    '#type_name' => $element['#type_name'],
    '#delta' => $element['#delta'],
    '#columns' => $element['#columns'],
  );
  $element['value']['#maxlength'] = !empty($field['max_length']) ? $field['max_length'] : NULL;

  // Used so that hook_field('validate') knows where to flag an error.
  $element['_error_element'] = array(
    '#type' => 'value',
    '#value' => implode('][', array_merge($element['#parents'], array(
      'value',
    ))),
  );
  return $element;
}

/**
 * An #element_validate callback for the twitterfield_widget field type.
 */
function twitterfield_widget_validate($element, &$form_state) {
  $value = $element['#value']['value'];
  if (empty($value)) {
    return;
  }
  $field = content_fields($element['#field_name'], $element['#type_name']);
  $allowed_types = $field['widget']['allowed_types'];
  $allowed_types_count = count(array_filter($allowed_types));
  $error = '';
  if ($allowed_types_count == 0) {

    // We must be on the settings page, checking the default value,
    // and the allowed types failed validation.
    return;
  }
  elseif ($allowed_types_count == 1) {
    if ($allowed_types['username'] && !_twitterfield_is_username($value)) {
      $error = t('Only Usernames are allowed, and must be prepended with "@".');
    }
    elseif ($allowed_types['list'] && !_twitterfield_is_list($value)) {
      $error = t('Only Lists are allowed, and must be in the format "@username/list".');
    }
    elseif ($allowed_types['hashtag'] && !_twitterfield_is_hashtag($value)) {
      $error = t('Only Hashtags are allowed, and must be prepended with "#".');
    }
    elseif ($allowed_types['search'] && !_twitterfield_is_search($value)) {
      $error = t('Only search strings are allowed.');
    }
  }
  else {
    if (!$allowed_types['username'] && _twitterfield_is_username($value)) {
      $error = t('Usernames are not allowed.');
    }
    elseif (!$allowed_types['list'] && _twitterfield_is_list($value)) {
      $error = t('Lists are not allowed.');
    }
    elseif (!$allowed_types['hashtag'] && _twitterfield_is_hashtag($value)) {
      $error = t('Hashtags are not allowed.');
    }
    elseif (!$allowed_types['search'] && _twitterfield_is_search($value)) {
      $error = t('Search strings are not allowed.');
    }
  }
  if ($error) {
    form_error($element['value'], $error);
  }
}

/**
 * Theme function for twitterfield widget.
 */
function theme_twitterfield_widget($element) {
  return $element['#children'];
}

/* ****************************************************************************
 * Formatter Functions
 */

/**
 * Implementation of hook_field_formatter_info().
 */
function twitterfield_field_formatter_info() {
  $values = array(
    'twitter_link' => array(
      'label' => t('Twitter Link'),
      'field types' => array(
        'text',
      ),
    ),
    'twitter_widget' => array(
      'label' => t('Twitter Widget'),
      'field types' => array(
        'text',
      ),
    ),
  );
  if (module_exists('twitter_pull')) {
    $values['twitter_pull'] = array(
      'label' => t('Twitter Pull'),
      'field types' => array(
        'text',
      ),
    );
  }
  return $values;
}

/**
 * Theme function for twitter link display formatter.
 */
function theme_twitterfield_formatter_twitter_link($element) {
  if (empty($element['#item']['value'])) {
    return;
  }
  $value = $element['#item']['safe'];
  if (_twitterfield_is_username($value) || _twitterfield_is_list($value)) {
    $url_part = substr($value, 1);
  }
  else {

    // hashtag or search string.
    $url_part = 'search?q=' . rawurlencode($value);
  }
  return l($value, 'http://twitter.com/' . $url_part, array(
    'attributes' => array(
      'class' => 'twitterfield_twitter_link',
    ),
  ));
}

/**
 * Theme function for twitter widget display formatter.
 */
function theme_twitterfield_formatter_twitter_widget($element) {
  if (empty($element['#item']['value'])) {
    return;
  }
  $type = 'search';
  $value = $element['#item']['safe'];

  // Title and subject need to be escaped for insertion into javascript string.
  $title = NULL;
  $subject = addslashes($value);
  if (_twitterfield_is_username($value)) {
    $type = 'profile';
    $value = substr($value, 1);
  }
  elseif (_twitterfield_is_list($value)) {
    $type = 'list';
    $value = explode('/', substr($value, 1));
  }
  else {

    // Search expressions need to be escaped for insertion in javascript string.
    $value = addslashes($value);
  }
  return theme('twitter_widget', $type, $value, $title, $subject);
}

/**
 * Theme function for twitter_pull display formatter.
 */
function theme_twitterfield_formatter_twitter_pull($element) {
  if (!empty($element['#item']['value']) && module_exists('twitter_pull')) {
    return twitter_pull_render($element['#item']['safe'], $element['#item']['safe']);
  }
}

/* ****************************************************************************
 * Helper Functions
 */

/**
 * Check if the given value is a twitter username.
 *
 * @param $value String to check.
 * @return boolean
 */
function _twitterfield_is_username($value) {
  return preg_match('/^@[\\w]+$/', $value);
}

/**
 * Check if the given value is a twitter list.
 *
 * @param $value String to check.
 * @return boolean
 */
function _twitterfield_is_list($value) {
  return preg_match('/^@[\\w]+\\/[\\w]+$/', $value);
}

/**
 * Check if the given value is a Hashtag.
 *
 * @param $value String to check.
 * @return boolean
 */
function _twitterfield_is_hashtag($value) {
  return preg_match('/^#[\\w]+$/', $value);
}

/**
 * Check if the given value is a search phrase.
 *
 * @param $value String to check.
 * @return boolean
 */
function _twitterfield_is_search($value) {
  return strpos($value, ' ') !== FALSE || !preg_match('/^[@#]/', $value);
}

Functions

Name	Description
theme_twitterfield_formatter_twitter_link	Theme function for twitter link display formatter.
theme_twitterfield_formatter_twitter_pull	Theme function for twitter_pull display formatter.
theme_twitterfield_formatter_twitter_widget	Theme function for twitter widget display formatter.
theme_twitterfield_widget	Theme function for twitterfield widget.
twitterfield_elements	Implementation of hook_elements().
twitterfield_field_formatter_info	Implementation of hook_field_formatter_info().
twitterfield_theme	Implementation of hook_theme().
twitterfield_widget	Implementation of hook_widget().
twitterfield_widget_info	Implementation of hook_widget_info().
twitterfield_widget_process	An element #process callback for the twitterfield_widget field type.
twitterfield_widget_settings	Implementation of hook_widget_settings().
twitterfield_widget_validate	An #element_validate callback for the twitterfield_widget field type.
_twitterfield_is_hashtag	Check if the given value is a Hashtag.
_twitterfield_is_list	Check if the given value is a twitter list.
_twitterfield_is_search	Check if the given value is a search phrase.
_twitterfield_is_username	Check if the given value is a twitter username.
_twitterfield_widget_settings_allowed_types_validate	#element_validate function for widget settings form Allowed Types selection.