ting_recommendation_panes.module

<?php

/**
 * Implements hook_menu().
 */
function ting_recommendation_panes_menu() {
  $path = drupal_get_path('module', 'ting_recommendation_panes');
  $items = array();

  $items['admin/config/ting_recommendation_panes'] = array(
    'title' => 'Ting recommendation panes',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('ting_recommendation_panes_settings_form'),
    'access arguments' => array('administer recommendation panes'),
    'file' => 'ting_recommendation_panes.admin.inc',
    'file path' => $path,
  );

  return $items;
}

/**
 * Implements hook_permission().
 */
function ting_recommendation_panes_permission() {
  return array(
    'administer recommendation panes' => array(
      'title' => t('administer recommendation panes'),
      'description' => t('TODO Add a description for \'administer recommendation panes\''),
    ),
  );
}

/**
 * Implements hook_theme().
 *
 * This lets us tell Drupal about our theme functions and their arguments.
 */
function ting_recommendation_panes_theme() {
  return array(
    'ting_recommendation_panes_recommendation_list' => array(
      'variables' => array('objects' => NULL),
      'template' => 'ting_recommendation_panes_recommendation_list',
    ),
    'ting_recommendation_panes_recommendation_list_entry' => array(
      'variables' => array('object' => NULL),
      'template' => 'ting_recommendation_panes_recommendation_list_entry',
    ),
  );
}

/**
 * Implements hook_flush_caches().
 */
function ting_recommendation_panes_flush_caches() {
  return array('cache_ting_recommendation_panes');
}

/**
 * Implements hook_ctools_plugin_directory().
 *
 * Tells CTools (and thus Panels) where to look for plugin code.
 */
function ting_recommendation_panes_ctools_plugin_directory($module, $plugin) {
  if ($module == 'ctools' || $module == 'panels') {
    return 'plugins/' . $plugin;
  }
}

/**
 * Load TingClientObjects for each recommendation.
 */
function ting_recommendation_panes_get_recommended_objects($objects) {
  $identifiers = ting_recommendation_panes_extract_identifers($objects);

  $cacheId = md5(implode('|', $identifiers));
  $cache = cache_get($cacheId, 'cache_ting_recommendation_panes');
  if ($cache) {
    $recommended_objects = $cache->data;
  }
  else {
    $numResults = 24;

    $localIds = array();
    foreach ($identifiers as $id) {
      // Don't get more than 24 local ids..
      if (count($localIds) >= 24) {
        break;
      }

      try {
        $recommendations = ting_get_object_recommendations($id, $numResults);
        foreach ($recommendations as $recommendation) {
          $localIds[$recommendation->localId] = $recommendation;
        }
      }
      catch (TingClientException $e) {
        watchdog('ting client', 'Error retrieving recommendations: ' . $e->getMessage(), array($id, $e), WATCHDOG_WARNING, $_SERVER["REQUEST_URI"]);
      }
    }
    arsort($localIds);

    $recommended_objects = array();
    $agency = variable_get('ting_agency', -1);

    foreach (array_keys($localIds) as $localId) {
      $ting_object = ding_entity_load("$agency:$localId");

      // Only show objects belonging to our own library.
      if ($ting_object && $ting_object->ownerId == $agency) {
        $recommended_objects[] = $ting_object;

        // Don't get more than 10 valid objects.
        if (count($recommended_objects) >= 10) {
          break;
        }
      }
    }

    cache_set($cacheId, $recommended_objects, 'cache_ting_recommendation_panes', REQUEST_TIME + variable_get('ting_recommendation_panes_cache_duration', 604800));
  }

  return $recommended_objects;
}

/**
 * @todo Please document this function.
 * @see http://drupal.org/node/1354
 */
function ting_recommendation_panes_extract_identifers($objects) {
  if (is_array($objects)) {
    //if passing an array then extract ids from each of the entries
    $ids = array();
    foreach ($objects as $o) {
      $ids = array_merge($ids, ting_recommendation_panes_extract_identifers($o));
    }
    return array_unique($ids);
  }
  else {
    //if passing a single value then extract ids depending on type
    switch (get_class($objects)) {
      case 'TingClientObject':
        if (!empty($objects->record['dc:identifier']['dkdcplus:ISBN'])) {
          return $objects->record['dc:identifier']['dkdcplus:ISBN'];
        }
        else {
          return array();
        }
        break;
      case 'TingClientObjectCollection':
        //get ids from each of the objects in the collection
        return ting_recommendation_panes_extract_identifers($objects->objects);
        break;
      default:
        //assume a string or integer has been passed and return it
        return array($objects);
        break;
    }
  }
}