# sfLightboxPlugin

`sfLightboxPlugin` is a symfony plugin that provides an easy to use wrapper
for the Lightbox2 javascript library.

It add a new helper : LightBoxHelper with 3 functions :
   * light_image, to display an image
   * light_slideshow, to display a slideshow
   * light_modalbox, to display a modal popup with any content

## Installation

  * Install the plugin
  
      
        symfony plugin-install http://plugins.symfony-project.com/sfLightboxPlugin
      
  
  or download 
  
  * Copy the files in 'web' to your application web directory
  
  * If you don't want to use the following structure :

    * js/lightbox/

    * css/lightbox/

    * images/lightbox/
    
  You will have to modifiy the path in 'lightbox.css', 'lightbox.js', 'modalbox.js' and the 
  'config.php' of the plugin (or make your own in your application by creating
  a sfLightboxPlugin module) You also have a french picture for the close
  button in '/web/images/fr/', you will also have to change the path if you want to use it.

  * Clear you cache
  
      
        symfony cc
      

### Usage

  * 1 - To display one image

      
    <?php
    
    // Test light_image
    $image_options = array('title' => 'Lightbox2 Taz image !');    
    
    echo light_image('logo.jpg', 'taz.jpg', $image_options);
    
    ?>
      

  * 2 - To display a slide show of several images
  
      
    <?php
    
    $images[] = array(
        'thumbnail' => 'taz.jpg',
        'image'     => 'taz2.jpg',
        'options'   => array('title' => 'taz2')
    );
    
    $images[] = array(
        'thumbnail' => 'taz2.jpg',
        'image'     => 'logo.jpg',
        'options'   => array('title' => 'Taz')
    );
    
    $images[] = array(
        'thumbnail' => 'logo.jpg',
        'image'     => 'taz.jpg',
        'options'   => array('title' => 'Taz')
    );
    
    $link_options = array(
        'title'     => 'Taz SlideShow',
        'slidename' => 'taz',
    );    
    
    
    echo light_slideshow($images, $link_options)
    
    ?>
      
  
  * 3 - To display a modal box with content of the result of an action
  
      
    // Modal Lightbox plugin test
    $link_options = array(
        'title' => 'Taz...',
        'class' => 'new blocksize_800x700'
    );    
    
    echo light_modallink('<h2>Taz presentation</h2>', 'index/presentation', $link_options);
      
        

  You can change the class to adjust the wanted size. Of course you can use 
  a route instead of a 'module/action'. Don't forget to disable the layout as
  it's as if you were in a popup.

  * That's all, ;)
  
  === Versions ===

  1.0.0 =>  First version
  1.0.1 =>  Some bug fixes in modalbox.js and also modalbox.css which affected IE6/7 and Opera.
            Renaiming of some html identifiers in modalbox to allow use of modalbox and lightbox in the same document.
            (more info in modalbox.js file)
            Modified default close image from 'closelabel.gif' which was culture dependent to 'close.gif' (only a close cross).