flickrgallery.module in FlickrGallery 7

This module shows the sets and photo's from a Flickr account

File

flickrgallery.module

<?php

/**
 * @file
 * This module shows the sets and photo's from a Flickr account
 */

/**
 * Implements hook_help().
 */
function flickrgallery_help($path, $arg) {
  if ($path == 'admin/help#flickrgallery') {
    return '<p>' . t('This module shows the sets and photo\'s from a Flickr account.') . '</p>';
  }
}

/**
 * Implements hook_permission().
 */
function flickrgallery_permission() {
  return array(
    'view photosets' => array(
      'title' => t('View photosets'),
      'description' => t('View the sets and images from the Flickr Gallery'),
    ),
    'administer flickr settings' => array(
      'title' => t('Administer Flickr settings'),
      'description' => t('Administer the settings for the Flickr Gallery'),
    ),
  );
}

/**
 * Implements hook_menu().
 */
function flickrgallery_menu() {
  $items = array();
  $items['admin/config/media/flickrapi/settings'] = array(
    'title' => 'Flickr API',
    'description' => 'Flickr API settings',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/config/media/flickrapi/gallery'] = array(
    'title' => 'Flickr Gallery',
    'description' => 'Configure options for the flickr Gallery module',
    'page callback' => 'flickrgallery_admin_settings',
    'access arguments' => array(
      'administer flickr settings',
    ),
    'type' => MENU_LOCAL_TASK,
    'file' => 'flickrgallery.admin.inc',
  );
  $items[variable_get('flickrgallery_path', 'flickr')] = array(
    'title' => 'Flickr Gallery',
    'page callback' => 'flickrgallery_wrapper_albums',
    'access arguments' => array(
      'view photosets',
    ),
    'type' => MENU_NORMAL_ITEM,
    'weight' => -100,
  );
  $items[variable_get('flickrgallery_path', 'flickr') . '/set/%'] = array(
    'title' => 'Flickr Gallery Set',
    'page callback' => 'flickrgallery_set',
    'access arguments' => array(
      'view photosets',
    ),
    'type' => MENU_CALLBACK,
  );
  return $items;
}
function flickrgallery_admin_settings() {
  return drupal_get_form('flickrgallery_settings_form');
}
function flickrgallery_block_info() {
  $blocks['flickrgallery_block'] = array(
    'info' => t('FlickrGallery block'),
  );
  return $blocks;
}

/**
 * Implements hook_theme().
 */
function flickrgallery_theme($existing, $type, $theme, $path) {
  return array(
    'flickrgallery_wrapper_albums' => array(),
    'flickrgallery_albums' => array(
      'variables' => array(
        'description' => NULL,
        'albums' => NULL,
      ),
      'template' => 'flickrgallery_albums',
    ),
    'flickrgallery_set' => array(
      'arguments' => 'set',
    ),
    'flickrgallery_photoset' => array(
      'variables' => array(
        'photoset' => NULL,
        'meta' => NULL,
      ),
      'template' => 'flickrgallery_photoset',
    ),
    'flickrgallery_photo' => array(
      'variables' => array(
        'image' => NULL,
        'image_meta' => NULL,
      ),
      'template' => 'flickrgallery_photo',
    ),
  );
}
function flickrgallery_wrapper_albums() {
  return theme('flickrgallery_wrapper_albums', array());
}
function flickrgallery_set() {
  return theme('flickrgallery_set', array(
    'set_id' => arg(2),
  ));
}
function theme_flickrgallery_wrapper_albums() {

  // Require FlickrAPI.
  module_load_include('module', 'flickrapi');

  // Add CSS file.
  drupal_add_css(drupal_get_path('module', 'flickrgallery') . '/flickrgallery.css');

  // Set custom title.
  drupal_set_title(variable_get('flickrgallery_title', 'Flickr Gallery'));

  // Create Flickr object.
  $f = flickrapi_phpFlickr();

  // Get Flickr User info and User ID.
  $flickr_user = array();
  $flickr_user = $f
    ->people_getInfo(variable_get('flickrgallery_userID', NULL));
  $flickr_uid = $flickr_user['id'];

  // Get Flickr sets.
  $sets = $f
    ->photosets_getList($flickr_uid, NULL, variable_get('flickrgallery_privacy_filter', 1));

  /* PHPFlickr photosets_getList() doesn't support pager option, so we have to write it ourselves
     * Not is use on this moment
    if (variable_get('flickrgallery_sets_pager', NULL)) {
      $pager_val = variable_get('flickrgallery_pager_val', NULL);

    }
     *
     */
  $description = variable_get('flickrgallery_description', NULL);
  $albums = array();
  if (!empty($sets)) {
    foreach ($sets['photoset'] as $set) {
      $thumb_url = "http://farm" . $set['farm'] . ".static.flickr.com/" . $set['server'] . "/" . $set['primary'] . "_" . $set['secret'] . "_" . variable_get('flickrgallery_albums', 's') . ".jpg";
      $variables = array(
        'path' => $thumb_url,
        'alt' => $set['title'],
        'title' => $set['title'],
        'attributes' => array(
          'class' => 'flickrgallery-set-image',
        ),
      );
      $img = theme('image', $variables);
      $image = array();
      $image['info'] = $set;
      $image['total'] = $set['photos'];
      $image['image_link'] = l($img, "flickr/set/" . $set['id'], array(
        'attributes' => array(
          'class' => 'flickrgallery',
          'title' => $set['title'],
        ),
        'html' => 'true',
      ));
      $image['title_link'] = l($set['title'], "flickr/set/" . $set['id'], array(
        'attributes' => array(
          'class' => 'flickrgallery-title',
          'title' => $set['title'],
        ),
        'html' => 'true',
      ));
      $albums[] = $image;
    }
    return theme('flickrgallery_albums', array(
      'description' => $description,
      'albums' => $albums,
    ));
  }
  else {

    // If no sets, display msg.
    return "<h2>" . t("No pictures available") . "</h2>";
  }
}
function theme_flickrgallery_set($set_id = NULL) {

  // Require FlickrAPI.
  module_load_include('module', 'flickrapi');

  // Add CSS file.
  drupal_add_css(drupal_get_path('module', 'flickrgallery') . '/flickrgallery.css');

  // Create Flickr object.
  $f = flickrapi_phpFlickr();

  // Get Flickr set title.
  $set = $set_id['set_id'];
  $set_info = $f
    ->photosets_getInfo($set);

  // Set Flickr set title as page title.
  drupal_set_title($set_info['title'], 'Flickr Set');

  // Get Flickr photos for this set.
  $photos = $f
    ->photosets_getPhotos($set, NULL, variable_get('flickrgallery_privacy_filter', 1));

  // Get META data for this set.
  $meta = $f
    ->photosets_getInfo($set);

  // If there aren't any photo's, display message.
  if (empty($set) || empty($photos)) {
    drupal_set_message(t('This set doesn\'t exists or there aren\'t any pictures available for this set.'), 'error');
    drupal_not_found();
    exit;
  }

  // Get the type for Lightbox.
  $type = variable_get('flickrgallery_lightbox_type', 'lighbox2');

  // Declare variables.
  $photoset = array();
  $image_meta = array();
  foreach ($photos['photoset']['photo'] as $photo) {
    $variables = array(
      'path' => $f
        ->buildPhotoURL($photo, variable_get('flickrgallery_thumb', 'square')),
      'alt' => $photo['title'],
      'title' => $photo['title'],
      'attributes' => array(
        'class' => 'flickrgallery-set-image',
      ),
    );
    $img = theme('image', $variables);
    $image = array();

    // Get META data for this image, only if flickrgallery_override is set to TRUE in the admin screen
    // This will lead to slower performance
    if (variable_get('flickrgallery_override') == TRUE) {
      $image_meta = $f
        ->photos_getInfo($photo['id']);
    }
    $image['info'] = $photo;
    $image['image'] = l($img, $f
      ->buildPhotoURL($photo, variable_get('flickrgallery_large', 'large')), array(
      'attributes' => array(
        'class' => 'flickrgallery-image ' . $type,
        'rel' => $type . "[flickrgallery]",
        'title' => $photo['title'],
      ),
      'html' => 'true',
    ));
    $photoset[] = theme('flickrgallery_photo', array(
      'image' => $image,
      'image_meta' => $image_meta,
    ));
  }

  // Return the output.
  return theme('flickrgallery_photoset', array(
    'photoset' => $photoset,
    'meta' => $meta,
  ));
}
function flickrgallery_block_view($delta) {
  $block = array();
  switch ($delta) {
    case 'flickrgallery_block':
      $block['title'] = variable_get('flickrgallery_title', 'Flickr Gallery');
      break;
  }
  return $block;
}

Functions

Name	Description
flickrgallery_admin_settings
flickrgallery_block_info
flickrgallery_block_view
flickrgallery_help	Implements hook_help().
flickrgallery_menu	Implements hook_menu().
flickrgallery_permission	Implements hook_permission().
flickrgallery_set
flickrgallery_theme	Implements hook_theme().
flickrgallery_wrapper_albums
theme_flickrgallery_set
theme_flickrgallery_wrapper_albums