... and there were! Here's what I've got as a working copy for
/includes/modules/YOUR_TEMPLATE/additional_images.php:
<?php
/**
* additional_images module
*
* Prepares list of additional product images to be displayed in template
*
* @package templateSystem
* @copyright Copyright 2003-2016 Zen Cart Development Team
* @copyright Portions Copyright 2003 osCommerce
* @license http://www.zen-cart.com/license/2_0.txt GNU Public License V2.0
* @version $Id: Author: DrByte Wed Jan 6 12:47:43 2016 -0500 Modified in v1.5.5 $
*/
if (!defined('IS_ADMIN_FLAG')) {
die('Illegal Access');
}
$zco_notifier->notify('NOTIFY_MODULES_ADDITIONAL_PRODUCT_IMAGES_START');
if (!defined('IMAGE_ADDITIONAL_DISPLAY_LINK_EVEN_WHEN_NO_LARGE')) define('IMAGE_ADDITIONAL_DISPLAY_LINK_EVEN_WHEN_NO_LARGE','Yes');
$images_array = array();
// do not check for additional images when turned off
if ($products_image != '' && $flag_show_product_info_additional_images != 0) {
// prepare image name
$products_image_extension = substr($products_image, strrpos($products_image, '.'));
$products_image_base = str_replace($products_image_extension, '', $products_image);
// if in a subdirectory
if (strrpos($products_image, '/')) {
$products_image_match = substr($products_image, strrpos($products_image, '/')+1);
//echo 'TEST 1: I match ' . $products_image_match . ' - ' . $file . ' - base ' . $products_image_base . '<br>';
$products_image_match = str_replace($products_image_extension, '', $products_image_match) . '_';
$products_image_base = $products_image_match;
}
$products_image_directory = str_replace($products_image, '', substr($products_image, strrpos($products_image, '/')));
if ($products_image_directory != '') {
$products_image_directory = DIR_WS_IMAGES . str_replace($products_image_directory, '', $products_image) . "/";
} else {
$products_image_directory = DIR_WS_IMAGES;
}
// Check for additional matching images
$file_extension = $products_image_extension;
$products_image_match_array = array();
if ($dir = @dir($products_image_directory)) {
while ($file = $dir->read()) {
if (!is_dir($products_image_directory . $file)) {
//-bof-image_handler-lat9 *** 1 of 4 ***
// if (substr($file, strrpos($file, '.')) == $file_extension) {
// if(preg_match('/\Q' . $products_image_base . '\E/i', $file) == 1) {
// if ($file != $products_image) {
// -----
// Some additional-image-display plugins (like Fual Slimbox) have some additional checks to see
// if the file is "valid"; this notifier "accomodates" that processing, providing these parameters:
//
// $p1 ... (r/o) ... An array containing the variables identifying the current image.
// $p2 ... (r/w) ... A boolean indicator, set to true by any observer to note that the image is "acceptable".
//
$current_image_match = false;
$zco_notifier->notify(
'NOTIFY_MODULES_ADDITIONAL_IMAGES_FILE_MATCH',
array(
'file' => $file,
'file_extension' => $file_extension,
'products_image' => $products_image,
'products_image_base' => $products_image_base
),
$current_image_match
);
if ($current_image_match || substr($file, strrpos($file, '.')) == $file_extension) {
if ($current_image_match || preg_match('/\Q' . $products_image_base . '\E/i', $file) == 1) {
if ($current_image_match || $file != $products_image) {
//-eof-image_handler-lat9 *** 1 of 4 ***
if ($products_image_base . str_replace($products_image_base, '', $file) == $file) {
// echo 'I AM A MATCH ' . $file . '<br>';
$images_array[] = $file;
} else {
// echo 'I AM NOT A MATCH ' . $file . '<br>';
}
}
}
}
}
}
if (count($images_array) > 0) {
sort($images_array);
}
$dir->close();
}
}
$zco_notifier->notify('NOTIFY_MODULES_ADDITIONAL_PRODUCT_IMAGES_LIST', NULL, $images_array);
// Build output based on images found
$num_images = count($images_array);
$list_box_contents = array();
$title = '';
if ($num_images > 0) {
$row = 0;
$col = 0;
if ($num_images < IMAGES_AUTO_ADDED || IMAGES_AUTO_ADDED == 0 ) {
$col_width = floor(100/$num_images);
} else {
$col_width = floor(100/IMAGES_AUTO_ADDED);
}
for ($i=0, $n=$num_images; $i<$n; $i++) {
$file = $images_array[$i];
$products_image_large = str_replace(DIR_WS_IMAGES, DIR_WS_IMAGES . 'large/', $products_image_directory) . str_replace($products_image_extension, '', $file) . IMAGE_SUFFIX_LARGE . $products_image_extension;
//-bof-image_handler-lat9 *** 2 of 4 ***
// -----
// This notifier lets any image-handler know the current image being processed, providing the following parameters:
//
// $p1 ... (r/o) ... The current product's name
// $p2 ... (r/w) ... The (possibly updated) filename (including path) of the current additional image.
//
$zco_notifier->notify('NOTIFY_MODULES_ADDITIONAL_IMAGES_GET_LARGE', $products_name, $products_image_large);
//-eof-image_handler-lat9 *** 2 of 4 ***
$flag_has_large = file_exists($products_image_large);
$products_image_large = ($flag_has_large ? $products_image_large : $products_image_directory . $file);
$flag_display_large = (IMAGE_ADDITIONAL_DISPLAY_LINK_EVEN_WHEN_NO_LARGE == 'Yes' || $flag_has_large);
$base_image = $products_image_directory . $file;
$thumb_slashes = zen_image(addslashes($base_image), addslashes($products_name), SMALL_IMAGE_WIDTH, SMALL_IMAGE_HEIGHT);
//-bof-image_handler-lat9 *** 3 of 4 ***
// -----
// This notifier lets any image-handler "massage" the name of the current thumbnail image name (with appropriate
// slashes for javascript/jQuery display):
//
// $p1 ... (n/a) ... An empty array, not applicable.
// $p2 ... (r/w) ... A reference to the "slashed" thumbnail image name.
//
$zco_notifier->notify('NOTIFY_MODULES_ADDITIONAL_IMAGES_THUMB_SLASHES', array(), $thumb_slashes);
//-eof-image_handler-lat9 *** 3 of 4 ***
$thumb_regular = zen_image($base_image, $products_name, SMALL_IMAGE_WIDTH, SMALL_IMAGE_HEIGHT);
$large_link = zen_href_link(FILENAME_POPUP_IMAGE_ADDITIONAL, 'pID=' . $_GET['products_id'] . '&pic=' . $i . '&products_image_large_additional=' . $products_image_large);
// Link Preparation:
//-bof-image_handler-lat9 *** 4 of 4 ***
// -----
// This notifier gives notice that an additional image's script link is requested. A monitoring observer sets
// the $p2 value to boolean true if it has provided an alternate form of that link; otherwise, the base code will
// create that value.
//
// $p1 ... (r/o) ... An associative array, containing the 'flag_display_large', 'products_name', 'products_image_large' and 'thumb_slashes' values.
// $p2 ... (r/w) ... A reference to the $script_link value, set here to boolean false; if an observer modifies that value, the
// this module's processing is bypassed.
//
$script_link = false;
$zco_notifier->notify(
'NOTIFY_MODULES_ADDITIONAL_IMAGES_SCRIPT_LINK',
array(
'flag_display_large' => $flag_display_large,
'products_name' => $products_name,
'products_image_large' => $products_image_large,
'thumb_slashes' => $thumb_slashes
),
$script_link
);
if ($script_link === false) {
$script_link = '<script type="text/javascript"><!--' . "\n" . 'document.write(\'' . ($flag_display_large ? '<a href="javascript:popupWindow(\\\'' . str_replace($products_image_large, urlencode(addslashes($products_image_large)), $large_link) . '\\\')">' . $thumb_slashes . '<br />' . TEXT_CLICK_TO_ENLARGE . '</a>' : $thumb_slashes) . '\');' . "\n" . '//--></script>';
}
//-eof-image_handler-lat9 *** 4 of 4 ***
$noscript_link = '<noscript>' . ($flag_display_large ? '<a href="' . zen_href_link(FILENAME_POPUP_IMAGE_ADDITIONAL, 'pID=' . $_GET['products_id'] . '&pic=' . $i . '&products_image_large_additional=' . $products_image_large) . '" target="_blank">' . $thumb_regular . '<br /><span class="imgLinkAdditional">' . TEXT_CLICK_TO_ENLARGE . '</span></a>' : $thumb_regular ) . '</noscript>';
// $alternate_link = '<a href="' . $products_image_large . '" onclick="javascript:popupWindow(\''. $large_link . '\') return false;" title="' . $products_name . '" target="_blank">' . $thumb_regular . '<br />' . TEXT_CLICK_TO_ENLARGE . '</a>';
$link = $script_link . "\n " . $noscript_link;
// $link = $alternate_link;
// List Box array generation:
$list_box_contents[$row][$col] = array(
'params' => 'class="additionalImages centeredContent back"' . ' ' . 'style="width:' . $col_width . '%;"',
'text' => "\n " . $link
);
$col++;
if ($col > (IMAGES_AUTO_ADDED -1)) {
$col = 0;
$row++;
}
} // end for loop
} // endif
$zco_notifier->notify('NOTIFY_MODULES_ADDITIONAL_PRODUCT_IMAGES_END');
/includes/modules/YOUR_TEMPLATE/main_product_image.php:
<?php
/**
* main_product_image module
*
* @package templateSystem
* @copyright Copyright 2003-2006 Zen Cart Development Team
* @copyright Portions Copyright 2003 osCommerce
* @license http://www.zen-cart.com/license/2_0.txt GNU Public License V2.0
* @version $Id: main_product_image.php 4663 2006-10-02 04:08:32Z drbyte $
*/
if (!defined('IS_ADMIN_FLAG')) {
die('Illegal Access');
}
//-bof-image_handler-lat9 *** 1 of 3 ***
// -----
// This notifier lets an observer know that the module has begun its processing.
//
$zco_notifier->notify('NOTIFY_MODULES_MAIN_PRODUCT_IMAGE_START');
//-eof-image_handler-lat9 *** 1 of 3 ***
$products_image_extension = substr($products_image, strrpos($products_image, '.'));
$products_image_base = str_replace($products_image_extension, '', $products_image);
$products_image_medium = $products_image_base . IMAGE_SUFFIX_MEDIUM . $products_image_extension;
$products_image_large = $products_image_base . IMAGE_SUFFIX_LARGE . $products_image_extension;
//-bof-image_handler-lat9 *** 2 of 3 ***
// -----
// This notifier lets an image-handling observer know that it's time to determine the image information,
// providing the following parameters:
//
// $p1 ... (r/o) ... A copy of the $products_image value
// $p2 ... (r/w) ... A boolean value, set by the observer to true if the image has been handled.
// $p3 ... (r/w) ... A reference to the $products_image_extension value
// $p4 ... (r/w) ... A reference to the $products_image_base value
// $p5 ... (r/w) ... A reference to the medium product-image-name
// $p6 ... (r/w) ... A reference to the large product-image-name.
//
// If the observer has set the $product_image_handled flag to true, it's indicated that any of the
// other values have been updated for separate handling.
//
$main_image_handled = false;
$zco_notifier->notify(
'NOTIFY_MODULES_MAIN_PRODUCT_IMAGE_FILENAME',
$products_image,
$main_image_handled,
$products_image_extension,
$products_image_base,
$products_image_medium,
$products_image_large
);
if ($main_image_handled !== true) {
//-eof-image_handler-lat9 *** 2 of 3 ***
// check for a medium image else use small
if (!file_exists(DIR_WS_IMAGES . 'medium/' . $products_image_medium)) {
$products_image_medium = DIR_WS_IMAGES . $products_image;
} else {
$products_image_medium = DIR_WS_IMAGES . 'medium/' . $products_image_medium;
}
// check for a large image else use medium else use small
if (!file_exists(DIR_WS_IMAGES . 'large/' . $products_image_large)) {
if (!file_exists(DIR_WS_IMAGES . 'medium/' . $products_image_medium)) {
$products_image_large = DIR_WS_IMAGES . $products_image;
} else {
$products_image_large = DIR_WS_IMAGES . 'medium/' . $products_image_medium;
}
} else {
$products_image_large = DIR_WS_IMAGES . 'large/' . $products_image_large;
}
/*
echo
'Base ' . $products_image_base . ' - ' . $products_image_extension . '<br>' .
'Medium ' . $products_image_medium . '<br><br>' .
'Large ' . $products_image_large . '<br><br>';
*/
// to be built into a single variable string
//-bof-image_handler-lat9 *** 3 of 3 ***
}
$zco_notifier->notify('NOTIFY_MODULES_MAIN_PRODUCT_IMAGE_END');
//-eof-image_handler-lat9 *** 3 of 3 ***
... and finally, an observer-class object for Image Handler to do its magic:
<?php
// -----
// Part of the "Image Handler" plugin for Zen Cart 1.5.5b and later.
// Copyright (c) 2017 Vinos de Frutas Tropicales
//
if (!defined('IS_ADMIN_FLAG')) {
die('Illegal Access');
}
class ImageHandlerObserver extends base
{
public function __construct()
{
if (defined('IH_VERSION')) {
$this->attach(
$this,
array(
//- From /includes/modules/main_product_image.php
'NOTIFY_MODULES_MAIN_PRODUCT_IMAGE_FILENAME',
//- From /includes/modules/additional_images.php
'NOTIFY_MODULES_ADDITIONAL_IMAGES_GET_LARGE',
'NOTIFY_MODULES_ADDITIONAL_IMAGES_THUMB_SLASHES',
//- From /includes/pages/popup_image/header_php.php
'NOTIFY_HEADER_END_POPUP_IMAGES',
)
);
}
}
public function update(&$class, $eventID, $p1, &$p2, &$p3, &$p4, &$p5, &$p6)
{
switch ($eventID) {
// -----
// This notifier lets an image-handling observer know that it's time to determine the image information,
// providing the following parameters:
//
// $p1 ... (r/o) ... A copy of the $products_image value
// $p2 ... (r/w) ... A boolean value, set by the observer to true if the image has been handled.
// $p3 ... (r/w) ... A reference to the $products_image_extension value
// $p4 ... (r/w) ... A reference to the $products_image_base value
// $p5 ... (r/w) ... A reference to the medium product-image-name
// $p6 ... (r/w) ... A reference to the large product-image-name.
//
// If the observer has set the $product_image_handled flag to true, it's indicated that any of the
// other values have been updated for separate handling.
//
case 'NOTIFY_MODULES_MAIN_PRODUCT_IMAGE_FILENAME':
$products_image = $p1;
$products_image_extension = $p3;
$p4 = $products_image_base = preg_replace('/' . $products_image_extension . '$/', '', $products_image);
$p5 = DIR_WS_IMAGES . 'medium/' . $products_image_base . IMAGE_SUFFIX_MEDIUM . $products_image_extension;
$p6 = DIR_WS_IMAGES . 'large/' . $products_image_base . IMAGE_SUFFIX_LARGE . $products_image_extension;
$p2 = true; //-Indicate that the image has been "handled".
break;
// -----
// This notifier lets any image-handler know the current image being processed, providing the following parameters:
//
// $p1 ... (r/o) ... The current product's name
// $p2 ... (r/w) ... The (possibly updated) filename (including path) of the current additional image.
//
case 'NOTIFY_MODULES_ADDITIONAL_IMAGES_GET_LARGE':
$products_name = $p1;
$products_image_large = $p2;
if (function_exists('handle_image')) {
$newimg = handle_image($products_image_large, addslashes($products_name), LARGE_IMAGE_WIDTH, LARGE_IMAGE_HEIGHT, '');
list($src, $alt, $width, $height, $parameters) = $newimg;
$p2 = zen_output_string($src);
}
break;
// -----
// This notifier lets any image-handler "massage" the name of the current thumbnail image name with appropriate
// slashes for javascript/jQuery display:
//
// $p1 ... (n/a) ... An empty array, not applicable.
// $p2 ... (r/w) ... A reference to the "slashed" thumbnail image name.
//
case 'NOTIFY_MODULES_ADDITIONAL_IMAGES_THUMB_SLASHES':
// remove additional single quotes from image attributes (important!)
$thumb_slashes = $p2;
$p2 = preg_replace("/([^\\\\])'/", '$1\\\'', $thumb_slashes);
break;
// -----
// Update the (globally-available) image names for any rendering of the popup_image page.
//
case 'NOTIFY_HEADER_END_POPUP_IMAGES':
$products_image_extension = $GLOBALS['products_image_extension'];
$products_image_base = preg_replace('/' . $products_image_extension . '$/', '', $GLOBALS['products_image']);
$GLOBALS['products_image_base'] = $products_image_base;
$GLOBALS['products_image_medium'] = DIR_WS_IMAGES . 'medium/' . $products_image_base . IMAGE_SUFFIX_MEDIUM . $products_image_extension;
$GLOBALS['products_image_large'] = DIR_WS_IMAGES . 'large/' . $products_image_base . IMAGE_SUFFIX_LARGE . $products_image_extension;
break;
default:
break;
}
}
}
The additional notifications added to the two "stock" Zen Cart modules allow image-display plugins (e.g. Fuel Slimbox or ColorBox) to attach and perform their functions separately as well.
I plan to submit the updated module files for the zc156 and zc160 repositories and will be shipping those updates in a to-be-coming update for Image Handler as well. Comments and/or change suggestions appreciated.
