You are here

Home » API reference » Lightbox2 5

lightbox2.module in Lightbox2 5

Same filename and directory in other branches
  1. 8 lightbox2.module
  2. 5.2 lightbox2.module
  3. 6 lightbox2.module
  4. 7.2 lightbox2.module
  5. 7 lightbox2.module

File

lightbox2.module
View source 
<?php

/**
 * Enables the use of lightbox V2 which places images above your current page,
 * not within.
 * This frees you from the constraints of the layout, particularly column
 * widths.
 *
 * This module is for Drupal 5.x only.
 *
 * Module by: Mark Ashmead
 * Mailto: bugzie@gmail.com
 * Co-maintainer: Stella Power (http://drupal.org/user/66894)
 *
 * Image Node Support: Steve McKenzie
 *
 */

/**
 * GLOBAL VARIABLES
 */
$_LIGHTBOX2_INCLUDE = false;

/**
 * Implementation of hook_help().
 * 
 * Displays the information for this module.
 * Displays the help text for this module.
 */
function lightbox2_help($section) {
  switch ($section) {
    case 'admin/modules#description':
      return t('Enables Lightbox V2 for Drupal');
    case 'admin/help#lightbox2':
      return t('<h3>Overview</h3>
      <p align="justify">Lightbox JS V2 is a simple, unobtrusive script used to overlay images on the current page. It\'s a snap to setup and works on all modern browsers. The module comes with a Lightbox2 Lite option which does not use the Scriptaculous/Prototype libraries; it is therefore less likely to conflict with anything else.</p>
      <p align="justify">Places images above your current page, not within. This frees you from the constraints of the layout, particularly column widths. Keeps users on the same page. Clicking to view an image and then having to click the back button to return to your site is bad for continuity (and no fun!).</p>
      <p align="justify"><h3>Usage</h3></p>
      <p>Add rel=&quot;lightbox&quot; attribute to any link tag to activate the lightbox. For example: </p>
      <p>&lt;a href=&quot;image-1.jpg&quot; rel=&quot;lightbox&quot; title=&quot;my caption&quot;&gt;image #1&lt;/a&gt;</p>
      <p>Optional: Use the title attribute if you want to show a caption.</p>
   <p>If you have a set of related images that you would like to group, follow
   step one but additionally include a group name between square brackets in the
   rel attribute. For example:</p><p>&lt;a href="images/image-1.jpg"
   rel="lightbox[roadtrip]"&gt;image #1&lt;/a&gt;<br />
&lt;a href="images/image-2.jpg" rel="lightbox[roadtrip]"&gt;image
#2&lt;/a&gt;<br />
&lt;a href="images/image-3.jpg" rel="lightbox[roadtrip]"&gt;image
#3&lt;/a&gt;<br /></p>
<p>No limits to the number of image sets per page or how many images are allowed
in each set. Go nuts!</p>');
      break;
  }
}

/**
 * Implementation of hook_perm()
 * Define the permissions this module uses
 */
function lightbox2_perm() {
  return array(
    'administer lightbox2',
  );
}

/**
 * Implementation of hook_menu()
 */
function lightbox2_menu($may_cache) {
  $items = array();
  if ($may_cache) {
    $items[] = array(
      'path' => 'admin/settings/lightbox2',
      'title' => t('Lightbox2'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array(
        'lightbox2_settings_form',
      ),
      'access' => user_access('administer lightbox2'),
      'description' => t('Allows the user to configure the lightbox2 settings'),
    );
  }
  return $items;
}

/**
 * Implementation of hook_nodeapi().
 */
function lightbox2_nodeapi(&$node, $op, $teaser = NULL, $page = NULL) {
  global $_LIGHTBOX2_INCLUDE;
  if (lightbox2_exclude_these_paths() != 1) {
    if ($op == 'view' && !$_LIGHTBOX2_INCLUDE) {
      lightbox2_add_files();
      $_LIGHTBOX2_INCLUDE = true;
    }
    elseif ($node->type == 'image' && !$_LIGHTBOX2_INCLUDE) {
      lightbox2_add_files();
      $_LIGHTBOX2_INCLUDE = true;
    }
  }
}

/**
 * Implementation of hook_settings()
 */
function lightbox2_settings_form() {

  // Define Lightbox2 Plus form.
  $form['lightbox2_plus_options'] = array(
    '#type' => 'fieldset',
    '#title' => t('Lightbox2 Plus'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );

  // Add Checkbox for Lightbox2 Plus.
  $form['lightbox2_plus_options']['lightbox2_plus'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use Lightbox2 Plus'),
    '#description' => t('Un-checking this box will enable Lightbox2 Lite.'),
    '#default_value' => variable_get('lightbox2_plus', true),
  );

  // Define Image Node Options form.
  $form['image_node_options'] = array(
    '#type' => 'fieldset',
    '#title' => t('Lightbox2 Plus Image Node options'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );

  // Add Checkbox for Image Node.
  $form['image_node_options']['lightbox2_image_node'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable for Image Nodes'),
    '#description' => t('Checking this box will enable automatic URL formatting for Image Nodes.'),
    '#default_value' => variable_get('lightbox2_image_node', true),
  );

  // Add Checkbox for Image Node Grouping.
  $form['image_node_options']['lightbox2_image_group'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable Grouping'),
    '#description' => t('Checking this box will enable automatic grouping of Image Nodes on a page. Useful for image galleries.'),
    '#default_value' => variable_get('lightbox2_image_group', true),
  );

  // Add Checkbox for disabling lightbox for gallery lists
  $form['image_node_options']['lightbox2_disable_nested_galleries'] = array(
    '#type' => 'checkbox',
    '#title' => t('Disable Lightbox for Gallery Lists'),
    '#description' => t('Checking this box will disable the lightbox for images in gallery lists, but will still use the lightbox when viewing gallery images.'),
    '#default_value' => variable_get('lightbox2_disable_nested_galleries', true),
  );

  // Add Checkbox for Gallery2 Image Filter.
  $form['image_node_options']['lightbox2G2_filter'] = array(
    '#type' => 'checkbox',
    '#title' => t('Enable Gallery 2 Filter'),
    '#description' => t('Checking this box will enable the Gallery 2 filter.'),
    '#default_value' => variable_get('lightbox2G2_filter', true),
  );

  // Add Textarea for urls without lightbox
  $form['image_node_options']['lightbox2_disable_these_urls'] = array(
    '#type' => 'textarea',
    '#title' => t('Disable LightBox for these urls'),
    '#description' => t('List the urls where the lightbox should be disabled, e.g. "node/add/page".  Put each url on a separate line. You can use the % character as a wildcard.'),
    '#default_value' => variable_get('lightbox2_disable_these_urls', ''),
  );
  return system_settings_form($form);
}

/**
 * Implementation of hook_filter().
 */
function lightbox2_filter_tips($delta, $format, $long = false) {
  return t('Image links from G2 are formatted for use with Lightbox.V2');
}

// Check to see if the G2 Filter is Enabled in Settings
if (variable_get('lightbox2G2_filter', true)) {
  function lightbox2_filter($op, $delta = 0, $format = -1, $text = '') {
    switch ($op) {
      case 'list':
        return array(
          0 => t('Lightbox filter'),
        );
      case 'description':
        return t('Turns g2_filter links into Lighbox.V2 appropriate links');
      case 'process':
        $text = ' ' . $text . ' ';
        $text = preg_replace('/ShowItem/', 'DownloadItem', $text);
        $text = preg_replace('/target=""/', 'rel="lightbox"', $text);
        $text = substr($text, 1, -1);
        return $text;
      default:
        return $text;
    }
  }
}

/**
 * Provides a link to the CSS stylesheet associated with this module.
 * Provides a link to the JS file associated with this module.
 */
function lightbox2_add_files() {

  // Load required js and css files.
  $path = drupal_get_path('module', 'lightbox2');

  // Check to see if Lightbox2 Plus is enabled.
  if (variable_get('lightbox2_plus', true)) {
    if (function_exists('drupal_add_css')) {
      drupal_add_css($path . '/lightbox.css');
    }
    else {
      theme('add_style', $path . '/lightbox.css');
    }

    // Check to see if Libraries are installed correctly.
    if (file_exists($path . '/js/prototype.js')) {
      drupal_add_js($path . '/js/prototype.js');

      // Check to see if the Image Node Option is enabled in settings.
      if (variable_get('lightbox2_image_node', true)) {
        if (variable_get('lightbox2_image_group', true)) {
          if (variable_get('lightbox2_disable_nested_galleries', true)) {
            drupal_add_js($path . '/js/image_nodes_galleries.js');
          }
          else {
            drupal_add_js($path . '/js/image_nodes.js');
          }
        }
        else {
          if (variable_get('lightbox2_disable_nested_galleries', true)) {
            drupal_add_js($path . '/js/image_nodes_nogroup_galleries.js');
          }
          else {
            drupal_add_js($path . '/js/image_nodes_nogroup.js');
          }
        }
      }
      drupal_add_js($path . '/js/scriptaculous.js?load=effects');
      drupal_add_js($path . '/js/lightbox.js');

      // Future support for non-images will go here.

      //drupal_add_js($path .'/js/lightbox_docs.js');
    }
    else {
      drupal_set_message(t('The script.aculo.us library is in not installed correctly. Please download from <a href="http://www.stellapowerdesign.net/scriptaculous.zip">http://www.stellapowerdesign.net/scriptaculous-drupal.zip</a>, follow the instructions in the Lightbox V.2 README.TXT file to copy the files to their correct locations.'), 'error');
    }
  }
  else {
    if (function_exists('drupal_add_css')) {
      drupal_add_css($path . '/lightbox_lite.css');
    }
    else {
      theme('add_style', $path . '/lightbox_lite.css');
    }
    drupal_add_js($path . '/js/lightbox_lite.js');
  }
  drupal_add_js($path . '/js/lightningload.js');
}

/**
 * Implementation of hook_field_formatter_info().
 * Adds certain lightbox+imagecache formatters to CCK image fields if the
 * imagefield.module and the imagecache.module exist.
 */
function lightbox2_field_formatter_info() {
  $formatter = array();
  if (module_exists('imagefield') && module_exists('imagecache')) {
    $rules = _imagecache_get_presets();
    foreach ($rules as $ruleid => $rulename) {
      $formatters['lightbox2][' . $rulename] = array(
        'label' => 'Lightbox2: ' . $rulename,
        'field types' => array(
          'image',
        ),
      );
    }
  }
  return $formatters;
}

/**
 * Implementation of hook_field_formatter().
 */
function lightbox2_field_formatter($field, $item, $formatter) {
  if (module_exists('imagefield') && module_exists('imagecache')) {
    if (!isset($item['fid'])) {
      return '';
    }
    if (!$_LIGHTBOX2_INCLUDE && lightbox2_exclude_these_paths() != 1) {
      lightbox2_add_files();
      $_LIGHTBOX2_INCLUDE = true;
    }
    $file = _imagefield_file_load($item['fid']);
    $item = array_merge($item, $file);
    if (strpos($formatter, 'lightbox2][') !== false) {
      list($null, $namespace) = explode('][', $formatter, 2);
      $rules = _imagecache_get_presets();
      if (in_array($namespace, (array) $rules)) {
        return theme('imagefield_image_imagecache_lightbox2', $namespace, $field, $item);
      }
    }
  }
}

/**
 * Implementation of theme_imagefield_image_imagecache_lightbox2().
 */
function theme_imagefield_image_imagecache_lightbox2($namespace, $field, $item, $attributes = NULL) {
  $imagecache_path = file_create_url(file_directory_path() . '/imagecache/' . $namespace . '/' . $item['filepath']);
  $rel = 'lightbox';
  if (variable_get('lightbox2_image_group', TRUE)) {
    $rel = 'lightbox[cck_image_nodes]';
  }
  $node_link = '';
  if (!empty($item['nid'])) {
    $node_link = '<br /><br />' . l(t('View Image Information'), 'node/' . $item['nid']);
  }
  $link_attributes = array(
    'rel' => $rel,
    'title' => $item['alt'] . $node_link,
  );
  $image = theme('imagecache', $namespace, $item['filepath'], $item['alt'], $item['title'], $attributes);
  $output = l($image, $item['filepath'], $link_attributes, NULL, NULL, FALSE, TRUE);
  return $output;
}
function lightbox2_exclude_these_paths() {

  // Use lightbox if this url is not excluded
  $disabled_urls = variable_get('lightbox2_disable_these_urls', '');
  if (!empty($disabled_urls)) {
    $urls = explode("\n", $disabled_urls);
    foreach ($urls as $url) {
      $url = rtrim($url);
      $url = preg_replace('/%/', '.*?', preg_quote($url, '/'));
      $pattern = '/^' . $url . '$/';
      if (preg_match($pattern, $_REQUEST['q'])) {
        return 1;
      }
    }
  }
  return 0;
}

Functions

Namesort descending Description
lightbox2_add_files Provides a link to the CSS stylesheet associated with this module. Provides a link to the JS file associated with this module.
lightbox2_exclude_these_paths
lightbox2_field_formatter Implementation of hook_field_formatter().
lightbox2_field_formatter_info Implementation of hook_field_formatter_info(). Adds certain lightbox+imagecache formatters to CCK image fields if the imagefield.module and the imagecache.module exist.
lightbox2_filter_tips Implementation of hook_filter().
lightbox2_help Implementation of hook_help().
lightbox2_menu Implementation of hook_menu()
lightbox2_nodeapi Implementation of hook_nodeapi().
lightbox2_perm Implementation of hook_perm() Define the permissions this module uses
lightbox2_settings_form Implementation of hook_settings()
theme_imagefield_image_imagecache_lightbox2 Implementation of theme_imagefield_image_imagecache_lightbox2().