template.php in Drupal Commons 6.2

Same filename in this branch
File

themes/commons_roots/template.php
View source
<?php

/**
 * Breadcrumb themeing
 */
function commons_roots_breadcrumb($breadcrumb) {
  if (!empty($breadcrumb)) {
    return '<div class="breadcrumb">' . implode(' > ', $breadcrumb) . '</div>';
  }
}

/**
 * Node preprocessing
 */
function commons_roots_preprocess_node(&$vars) {

  // Only build custom submitted information if it was first available
  // If it's not, that indicates that it's been turned off for this
  // node type
  if ($vars['submitted']) {

    // Load the node author
    $author = user_load($vars['node']->uid);

    // Author picture
    if (theme_get_setting('toggle_node_user_picture')) {
      $picture = $vars['picture'];
      unset($vars['picture']);
      $submitted = $author->uid && user_access('access user profiles') ? l($picture, "user/{$author->uid}", array(
        'html' => TRUE,
      )) : $picture;
    }

    // Author information
    $submitted .= '<span class="submitted-by">';
    $submitted .= t('Submitted by !name', array(
      '!name' => theme('username', $author),
    ));
    $submitted .= '</span>';
    $vars['submitted_name'] = theme('username', $author);

    // User points
    if ($author->uid && module_exists('userpoints')) {
      $points = userpoints_get_current_points($author->uid);
      $submitted .= '<span class="userpoints-value" title="' . t('!val user points', array(
        '!val' => $points,
      )) . '">';
      $submitted .= "({$points})";
      $submitted .= '</span>';
    }

    // User badges
    if ($author->uid && module_exists('user_badges')) {
      if (is_array($author->badges)) {
        foreach ($author->badges as $badge) {
          $badges[] = theme('user_badge', $badge, $author);
        }
      }
      if (!empty($badges)) {
        $submitted .= theme('user_badge_group', $badges);
      }
    }

    // Created time
    $submitted .= '<span class="submitted-on">';
    $submitted .= format_date($vars['node']->created);
    $submitted .= '</span>';
    $vars['submitted'] = $submitted;
  }
}

/**
 * Page preprocessing
 */
function commons_roots_preprocess_page(&$vars) {

  // Format the footer message
  // We do this here instead of in page.tpl.php because
  // we need a formatted message to pass along to the
  // same theme function as the $footer in order to have
  // them nested together
  if (isset($vars['footer_message']) && strlen($vars['footer_message'])) {
    $markup = '';
    $markup .= '<div id="footer-message" class="footer-message">';
    $markup .= '<div id="footer-message-inner" class="footer-message-inner inner">';
    $markup .= $vars['footer_message'];
    $markup .= '</div><!-- /footer-message-inner -->';
    $markup .= '</div><!-- /footer-message -->';
    $vars['footer_message'] = $markup;
  }
}

/**
 * Comment preprocessing
 */
function commons_roots_preprocess_comment(&$vars) {
  global $user;
  static $comment_odd = TRUE;

  // Comment is odd or even
  // Build array of handy comment classes
  $comment_classes = array();
  $comment_classes[] = $comment_odd ? 'odd' : 'even';
  $comment_odd = !$comment_odd;
  $comment_classes[] = $vars['comment']->status == COMMENT_NOT_PUBLISHED ? 'comment-unpublished' : '';

  // Comment is unpublished
  $comment_classes[] = $vars['comment']->new ? 'comment-new' : '';

  // Comment is new
  $comment_classes[] = $vars['comment']->uid == 0 ? 'comment-by-anon' : '';

  // Comment is by anonymous user
  $comment_classes[] = $user->uid && $vars['comment']->uid == $user->uid ? 'comment-mine' : '';

  // Comment is by current user
  $node = node_load($vars['comment']->nid);

  // Comment is by node author
  $vars['author_comment'] = $vars['comment']->uid == $node->uid ? TRUE : FALSE;
  $comment_classes[] = $vars['author_comment'] ? 'comment-by-author' : '';
  $comment_classes = array_filter($comment_classes);

  // Remove empty elements
  $vars['comment_classes'] = implode(' ', $comment_classes);

  // Create class list separated by spaces
  // Date & author
  $ago = t('!interval ago', array(
    '!interval' => format_interval(time() - $vars['comment']->timestamp),
  ));
  $submitted_by = '<span class="comment-name">' . theme('username', $vars['comment']) . '</span>';
  $submitted_by .= '<span class="comment-date">' . $ago . '</span>';

  // Format date as small, medium, or large
  $vars['submitted'] = $submitted_by;

  // Picture
  if (theme_get_setting('toggle_comment_user_picture')) {
    if (!$vars['comment']->picture && variable_get('user_picture_default', '') != '') {
      $vars['comment']->picture = variable_get('user_picture_default', '');
    }
    if ($vars['comment']->picture) {
      $picture = theme_imagecache('user_picture_meta', $vars['comment']->picture, $vars['comment']->name, $vars['comment']->name);
      if (user_access('access user profiles')) {
        $vars['comment']->picture = l($picture, "user/{$vars['comment']->uid}", array(
          'html' => TRUE,
        ));
      }
      else {
        $vars['comment']->picture = $picture;
      }
    }
  }
  else {
    unset($vars['comment']);
  }
}

/**
 * Profile preprocessing
 */
function commons_roots_preprocess_user_profile_item(&$vars) {

  // Separate userpoints value from the edit links
  if ($vars['title'] == 'Points') {
    $userpoints = explode(' - ', $vars['value']);
    $vars['value'] = '<span class="points">' . $userpoints[0] . '</span><span class="edit-links">' . $userpoints[1] . '</span>';
    unset($vars['title']);
  }
}

/**
 * Implementation of theme_shoutbox_post()
 */
function commons_roots_shoutbox_post($shout, $links = array(), $alter_row_color = TRUE) {
  global $user;

  // Gather moderation links
  if ($links) {
    foreach ($links as $link) {
      $linkattributes = $link['linkattributes'];
      $link_html = '<img src="' . $link['img'] . '" alt="' . $link['title'] . '" class="shoutbox-imglink"/>';
      $link_url = 'shout/' . $shout->shout_id . '/' . $link['action'];
      $img_links = l($link_html, $link_url, array(
        'html' => TRUE,
        'query' => array(
          'destination' => drupal_get_path_alias($_GET['q']),
        ),
      )) . $img_links;
    }
  }

  // Generate user name with link
  $user_name = shoutbox_get_user_link($shout);

  // Generate title attribute
  $title = t('Posted !date at !time by !name', array(
    '!date' => format_date($shout->created, 'custom', 'm/d/y'),
    '!time' => format_date($shout->created, 'custom', 'h:ia'),
    '!name' => $shout->nick,
  ));

  // Add to the shout classes
  $shout_classes = array();
  $shout_classes[] = 'shoutbox-msg';

  // Check for moderation
  if ($shout->moderate == 1) {
    $shout_classes[] = 'shoutbox-unpublished';
    $approval_message = '&nbsp;(' . t('This shout is waiting for approval by a moderator.') . ')';
  }

  // Check for specific user class
  $user_classes = array();
  $user_classes[] = 'shoutbox-user-name';
  if ($shout->uid == $user->uid) {
    $user_classes[] = 'shoutbox-current-user-name';
  }
  else {
    if ($shout->uid == 0) {
      $user_classes[] = 'shoutbox-anonymous-user';
    }
  }

  // Load user image and format
  $author_picture = '';
  $shout_author = user_load($shout->uid);
  if (!$shout_author->picture && variable_get('user_picture_default', '')) {
    $shout_author->picture = variable_get('user_picture_default', '');
  }
  if ($shout_author->picture) {
    $author_picture = theme_imagecache('user_picture_meta', $shout_author->picture, $shout_author->name, $shout_author->name);
  }

  // Time format
  $format = variable_get('shoutbox_time_format', 'ago');
  switch ($format) {
    case 'ago':
      $submitted = t('!interval ago', array(
        '!interval' => format_interval(time() - $shout->created),
      ));
      break;
    case 'small':
    case 'medium':
    case 'large':
      $submitted = format_date($shout->created, $format);
      break;
  }

  // Build the post
  $post = '';
  $post .= '<div class="' . implode(' ', $shout_classes) . '" title="' . $title . '">';
  $post .= '<div class="shoutbox-admin-links">' . $img_links . '</div>';
  $post .= '<div class="shoutbox-post-info">' . $author_picture;
  $post .= '<span class="shoutbox-user-name ' . implode(' ', $user_classes) . '">' . $user_name . '</span>';
  $post .= '<span class="shoutbox-msg-time">' . $submitted . '</span>';
  $post .= '</div>';
  $post .= '<div class="shout-message">' . $shout->shout . $approval_message . '</div>';
  $post .= '</div>' . "\n";
  return $post;
}
function commons_roots_item_list($items = array(), $title = NULL, $type = 'ul', $attributes = NULL) {
  $output = '<div class="item-list">';
  if (isset($title)) {
    $output .= '<h3>' . $title . '</h3>';
  }
  if (!empty($items)) {
    $output .= "<{$type}" . drupal_attributes($attributes) . '>';
    $num_items = count($items);
    $c = $num_items;
    foreach ($items as $i => $item) {
      $c--;
      $attributes = array();
      $children = array();
      if (is_array($item)) {
        foreach ($item as $key => $value) {
          if ($key == 'data') {
            $data = $value;
          }
          elseif ($key == 'children') {
            $children = $value;
          }
          else {
            $attributes[$key] = $value;
          }
        }
      }
      else {
        $data = $item;
      }
      if (!is_numeric($i)) {
        if (count($children) > 0) {
          $data .= theme_item_list($children, NULL, $type, $attributes);

          // Render nested list
        }
        if ($c == $num_items - 1) {
          $attributes['class'] = empty($attributes['class']) ? 'first' : $attributes['class'] . ' first';
        }
        if ($c == 0) {
          $attributes['class'] = empty($attributes['class']) ? 'last' : $attributes['class'] . ' last';
        }
        $nth = $c % 2 ? 'even' : 'odd';
        $attributes['class'] = empty($attributes['class']) ? $nth : $attributes['class'] . ' ' . $nth;
        $output .= '<li' . drupal_attributes($attributes) . '>' . $data . "</li>\n";
      }
      else {
        if (count($children) > 0) {
          $data .= theme_item_list($children, NULL, $type, $attributes);

          // Render nested list
        }
        if ($i == 0) {
          $attributes['class'] = empty($attributes['class']) ? 'first' : $attributes['class'] . ' first';
        }
        if ($i == $num_items - 1) {
          $attributes['class'] = empty($attributes['class']) ? 'last' : $attributes['class'] . ' last';
        }
        $nth = $i % 2 ? 'even' : 'odd';
        $attributes['class'] = empty($attributes['class']) ? $nth : $attributes['class'] . ' ' . $nth;
        $output .= '<li' . drupal_attributes($attributes) . '>' . $data . "</li>\n";
      }
    }
    $output .= "</{$type}>";
  }
  $output .= '</div>';
  return $output;
}
function commons_roots_preprocess_block($variables) {
  $variables['template_files'][] = 'block-' . $variables['block']->region . '-' . $variables['block']->module;
  $variables['template_files'][] = 'block-' . $variables['block']->region . '-' . $variables['block']->module . '-' . $variables['block']->delta;
}
function commons_roots_thumb_user_picture($picture, $imagecache_preset, $user_name, $user_uid) {
  if (!isset($picture) || $picture == '') {
    $picture = variable_get('user_picture_default', '');
  }
  $img = theme('imagecache', $imagecache_preset, $picture, $user_name, $user_name);
  if (user_access('access user profiles')) {
    return l($img, "user/{$user_uid}", array(
      'html' => TRUE,
    ));
  }
  else {
    return $img;
  }
}

/**
 * Theme a box
 */
function commons_roots_boxes_box($block) {
  $output = "<div id='boxes-box-" . $block['delta'] . "' class='boxes-box" . (!empty($block['editing']) ? ' boxes-box-editing' : '') . "'>";
  $output .= '<div class="boxes-box-content">' . $block['content'] . '</div>';

  // Remove the box controls and editing portion because it doesn't
  // currently work with WYSIWYG
  $output .= '</div>';
  return $output;
}
function commons_roots_user_relationships_request_relationship_direct_link($relate_to, $relationship_type) {
  $string = t("Become %name's %rel_name", array(
    '%name' => $relate_to->name,
    '%rel_name' => ur_tt("user_relationships:rtid:{$relationship_type->rtid}:name", $relationship_type->name),
    '%rel_plural_name' => ur_tt("user_relationships:rtid:{$relationship_type->rtid}:plural_name", $relationship_type->plural_name),
  ));
  $class = 'user_relationships_popup_link';
  if ($relationship_type->name == 'follower') {
    $string = t('Follow');
    $class .= ' follow-link';
  }
  return l($string, "relationship/{$relate_to->uid}/request/{$relationship_type->rtid}", array(
    'query' => drupal_get_destination(),
    'html' => TRUE,
    'attributes' => array(
      'class' => $class,
    ),
  ));
}

/**
 * This handles the logic of whether or not there should be a recipient link so
 * that non-user recipient_links will be displayed.
 */
function commons_roots_preprocess_facebook_status_item(&$vars) {
  $status = $vars['status'];

  // Remove the recipient link if it is the recipient is the sender.
  if ($status->type == 'user' && $status->sender == $status->recipient) {
    unset($vars['recipient_link']);
  }
}
function commons_roots_search_theme_form($form) {
  return '<div id="search" class="container-inline">' . drupal_render($form) . '</div>';
}
Functions

Name	Description
commons_roots_boxes_box	Theme a box
commons_roots_breadcrumb	Breadcrumb themeing
commons_roots_item_list
commons_roots_preprocess_block
commons_roots_preprocess_comment	Comment preprocessing
commons_roots_preprocess_facebook_status_item	This handles the logic of whether or not there should be a recipient link so that non-user recipient_links will be displayed.
commons_roots_preprocess_node	Node preprocessing
commons_roots_preprocess_page	Page preprocessing
commons_roots_preprocess_user_profile_item	Profile preprocessing
commons_roots_search_theme_form
commons_roots_shoutbox_post	Implementation of theme_shoutbox_post()
commons_roots_thumb_user_picture
commons_roots_user_relationships_request_relationship_direct_link
You are here

template.php in Drupal Commons 6.2

File

Functions

API Navigation
