social_comments.module in Open Social 7

File

social_comments.module

View source

<?php

/**
 * @file
 * Social comments module.
 */
require_once 'includes/social_comments.google.inc';
require_once 'includes/social_comments.facebook.inc';
require_once 'includes/social_comments.twitter.inc';
define('SOCIAL_COMMENTS_URL_MAX_LENGTH', 2048);

/**
 * Implements hook_menu().
 */
function social_comments_menu() {
  $items = array();
  $items['admin/config/system/social-comments'] = array(
    'title' => 'Social comments',
    'description' => 'Configure social comments',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'social_comments_settings_form',
    ),
    'access arguments' => array(
      'administer site configuration',
    ),
    'file' => 'includes/social_comments.admin.inc',
  );
  return $items;
}

/**
 * Implements hook_libraries_info().
 */
function social_comments_libraries_info() {
  $libraries['acTwitterConversation'] = array(
    'name' => 'acTwitterConversation',
    'vendor url' => 'http://adriancrepaz.com/twitter_conversions_api',
    'download url' => 'https://github.com/adriancrepaz/acTwitterConversation',
    'files' => array(
      'php' => array(
        'acTwitterConversation.php',
      ),
    ),
    'version' => '1.0',
  );
  return $libraries;
}

/**
 * Implements hook_theme().
 */
function social_comments_theme() {
  $themes = array();
  $themes['social_comments_items'] = array(
    'variables' => array(
      'comments' => array(),
      'bundle' => NULL,
      'entity_type' => NULL,
      'type' => NULL,
    ),
    'template' => 'social-comments-items',
    'path' => drupal_get_path('module', 'social_comments') . '/templates',
  );
  return $themes;
}

/**
 * Prepares variables for social-comments-items template.
 */
function template_preprocess_social_comments_items(&$variables) {
  $comments =& $variables['comments'];
  if (is_array($comments)) {
    foreach ($comments as &$comment) {
      $comment['date'] = format_date($comment['timestamp'], 'medium');
      $comment['userphoto'] = theme('image', array(
        'path' => $comment['userphoto'],
      ));
    }
  }
  $variables['theme_hook_suggestions'][] = 'social_comments_items__' . $variables['entity_type'];
  $variables['theme_hook_suggestions'][] = 'social_comments_items__' . $variables['bundle'];
  $variables['theme_hook_suggestions'][] = 'social_comments_items__' . $variables['type'];
  $variables['theme_hook_suggestions'][] = 'social_comments_items__' . $variables['type'] . '__' . $variables['bundle'];
}

/**
 * Implements hook_field_info().
 */
function social_comments_field_info() {
  return array(
    'social_comments_field' => array(
      'label' => t('Social comments'),
      'description' => t('Store an URL string.'),
      'default_widget' => 'social_comments',
      'default_formatter' => 'social_comments_google',
    ),
  );
}

/**
 * Implements hook_field_is_empty().
 */
function social_comments_field_is_empty($item, $field) {
  return empty($item['url']);
}

/**
 * Implements hook_field_insert().
 */
function social_comments_field_insert($entity_type, $entity, $field, $instance, $langcode, &$items) {
  foreach ($items as $delta => $value) {
    trim($items[$delta]['url']);
  }
}

/**
 * Implements hook_field_update().
 */
function social_comments_field_update($entity_type, $entity, $field, $instance, $langcode, &$items) {
  foreach ($items as $delta => $value) {
    trim($items[$delta]['url']);
  }
}

/**
 * Implements hook_field_widget_info().
 */
function social_comments_field_widget_info() {
  return array(
    'social_comments_field' => array(
      'label' => 'Social field',
      'field types' => array(
        'social_comments_field',
      ),
      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
    ),
  );
}

/**
 * Implements hook_field_widget_form().
 */
function social_comments_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
  $element += array(
    '#type' => $instance['widget']['type'],
    '#default_value' => isset($items[$delta]) ? $items[$delta] : '',
  );
  return $element;
}

/**
 * Implements hook_element_info().
 */
function social_comments_element_info() {
  $elements = array();
  $elements['social_comments_field'] = array(
    '#input' => TRUE,
    '#process' => array(
      'social_comments_field_process',
    ),
    '#theme_wrappers' => array(
      'form_element',
    ),
  );
  return $elements;
}

/**
 * Processes the element before displaying the field.
 */
function social_comments_field_process($element, $form_state, $complete_form) {
  $element['url'] = array(
    '#type' => 'textfield',
    '#maxlength' => SOCIAL_COMMENTS_URL_MAX_LENGTH,
    '#title' => t('URL'),
    '#default_value' => isset($element['#value']['url']) ? $element['#value']['url'] : NULL,
  );
  return $element;
}

/**
 * Implements hook_field_formatter_info().
 */
function social_comments_field_formatter_info() {
  $formatters = array();
  $formatters['social_comments_google'] = array(
    'label' => t('Social comments (Google)'),
    'field types' => array(
      'social_comments_field',
    ),
    'multiple values' => FIELD_BEHAVIOR_DEFAULT,
    'settings' => array(
      'count' => 0,
    ),
  );

  // @todo: Rewrite facebook implementation.
  $formatters['social_comments_facebook'] = array(
    'label' => t('Social comments (Facebook)'),
    'field types' => array(
      'social_comments_field',
    ),
    'multiple values' => FIELD_BEHAVIOR_DEFAULT,
    'settings' => array(
      'count' => 0,
    ),
  );

  // @todo: Write own implementation.
  //  $library = libraries_detect('acTwitterConversation');
  //  if ($library['installed']) {
  //    $formatters['social_comments_twitter'] = array(
  //      'label' => t('Social comments (Twitter)'),
  //      'field types' => array('social_comments_field'),
  //      'multiple values' => FIELD_BEHAVIOR_DEFAULT,
  //      'settings' => array(
  //        'count' => 0,
  //      ),
  //    );
  //  }
  return $formatters;
}

/**
 * Implements hook_field_formatter_settings_form().
 */
function social_comments_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];
  $element = array();
  if ($display['type'] == 'social_comments_google' || $display['type'] == 'social_comments_facebook' || $display['type'] == 'social_comments_twitter') {
    $element['count'] = array(
      '#type' => 'textfield',
      '#title' => t('Count'),
      '#default_value' => $settings['count'],
      '#description' => t('Count of items to show. Input 0 to display all.'),
    );
  }
  return $element;
}

/**
 * Implements hook_field_formatter_settings_summary().
 */
function social_comments_field_formatter_settings_summary($field, $instance, $view_mode) {
  $summary = array();
  $display = $instance['display'][$view_mode];
  $settings = $display['settings'];
  if ($display['type'] == 'social_comments_google' || $display['type'] == 'social_comments_facebook' || $display['type'] == 'social_comments_twitter') {
    $count = $settings['count'];
    if (!empty($count)) {
      $summary[] = t('Display: @count items', array(
        '@count' => $count,
      ));
    }
    else {
      $summary[] = t('Display all items');
    }
  }
  return implode('</ br>', $summary);
}

/**
 * Implements hook_field_formatter_view().
 */
function social_comments_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
  $elements = array();
  $settings = $display['settings'];
  if ($display['type'] == 'social_comments_google' || $display['type'] == 'social_comments_facebook' || $display['type'] == 'social_comments_twitter') {
    $type = str_replace('social_comments_', '', $display['type']);
    $formatter = 'Social' . drupal_ucfirst($type) . 'Formatter';
    foreach ($items as $delta => $item) {
      $count = $settings['count'];
      $bundle = $instance['bundle'];
      $comments = new $formatter();
      $comments = $comments
        ->getData($item['url'], $count);
      if ($comments) {
        $elements[$delta] = array(
          '#theme' => 'social_comments_items',
          '#comments' => $comments,
          '#bundle' => $bundle,
          '#entity_type' => $entity_type,
          '#type' => $type,
        );
      }
    }
  }
  return $elements;
}

Functions

Name	Description
social_comments_element_info	Implements hook_element_info().
social_comments_field_formatter_info	Implements hook_field_formatter_info().
social_comments_field_formatter_settings_form	Implements hook_field_formatter_settings_form().
social_comments_field_formatter_settings_summary	Implements hook_field_formatter_settings_summary().
social_comments_field_formatter_view	Implements hook_field_formatter_view().
social_comments_field_info	Implements hook_field_info().
social_comments_field_insert	Implements hook_field_insert().
social_comments_field_is_empty	Implements hook_field_is_empty().
social_comments_field_process	Processes the element before displaying the field.
social_comments_field_update	Implements hook_field_update().
social_comments_field_widget_form	Implements hook_field_widget_form().
social_comments_field_widget_info	Implements hook_field_widget_info().
social_comments_libraries_info	Implements hook_libraries_info().
social_comments_menu	Implements hook_menu().
social_comments_theme	Implements hook_theme().
template_preprocess_social_comments_items	Prepares variables for social-comments-items template.

Constants

Name	Description
SOCIAL_COMMENTS_URL_MAX_LENGTH

You are here

social_comments.module in Open Social 7

File

Functions

Constants

API Navigation