[ class tree: plugins ] [ index: plugins ] [ all elements ]

Class: cycle

Source Location: /zp-extensions/slideshow2.php

Class cycle

Method Summary
static void   cycleJS()  
static void   getShow()  
static type   getSlideObj()   We might need this to exclude file types or not…
static void   getSlideshowPlayer()  
static string;   is_valid()   TODO WE MIGHT NOT NEED THIS AS CYCLE2 MIGHT BE ABLE TO DISPLAY ANYTHING! Returns the file extension if the item passed is displayable by the player
static void   macro()  
static void   printSlide()   Helper function to print the individual slides
cycle   __construct()  
void   getOptionsSupported()  
void   handleOption()  

[ Top ]
Methods
static method cycleJS  [line 406]

  static void cycleJS( )



[ Top ]
static method getShow  [line 191]

  static void getShow( $heading, $speedctl, $albumobj, $imageobj, $width, $height, $crop, $shuffle, $linkslides, $controls, $returnpath, $imagenumber  )

Parameters:
   $heading: 
   $speedctl: 
   $albumobj: 
   $imageobj: 
   $width: 
   $height: 
   $crop: 
   $shuffle: 
   $linkslides: 
   $controls: 
   $returnpath: 
   $imagenumber: 


[ Top ]
static method getSlideObj  [line 391]

  static type getSlideObj( type $slide, type $albumobj  )

We might need this to exclude file types or not…

Parameters:
type   $slide: 
type   $albumobj: 


[ Top ]
static method getSlideshowPlayer  [line 178]

  static void getSlideshowPlayer( $album, [ $controls = false], [ $width = NULL], [ $height = NULL]  )

Parameters:
   $album: 
   $controls: 
   $width: 
   $height: 


[ Top ]
static method is_valid  [line 456]

  static string; is_valid( mixed $image, array $valid_types  )

TODO WE MIGHT NOT NEED THIS AS CYCLE2 MIGHT BE ABLE TO DISPLAY ANYTHING! Returns the file extension if the item passed is displayable by the player

Parameters:
mixed   $image:  either an image object or the filename of an image.
array   $valid_types:  list of the types we will accept


[ Top ]
static method macro  [line 395]

  static void macro( $macros  )

Parameters:
   $macros: 


[ Top ]
static method printSlide  [line 338]

  static void printSlide( obj $albumobj, obj $imgobj, int $width, int $height, int $cropw, int $croph, bool $linkslides, [bool $crop = false], [bool $carousel = false]  )

Helper function to print the individual slides

Parameters:
obj   $albumobj:  Album object
obj   $imgobj:  Current slide obj
int   $width:  Slide image width
int   $height:  Slide image height
int   $cropw:  Slide image crop width
int   $croph:  Slide image crop height
bool   $linkslides:  True or false if the slides should be linked to their image page. Note: In carousel mode this means full image links as here slides are always linked to the image page.
bool   $crop:  True or false to crop the image
bool   $carousel:  if the slideshow is a carousel so we can enable full image linking (only images allowed!)


[ Top ]
Constructor __construct  [line 54]

  cycle __construct( )



[ Top ]
getOptionsSupported  [line 75]

  void getOptionsSupported( )



[ Top ]
handleOption  [line 174]

  void handleOption( $option, $currentValue  )

Parameters:
   $option: 
   $currentValue: 


[ Top ]

Documentation generated on Sat, 07 Jun 2014 18:03:45 +0200 by phpDocumentor 1.4.3