Overview

Packages

  • admin
  • classes
    • media
  • CodeIgniter
    • Libraries
  • core
  • functions
  • JSMin
  • None
  • OpenID
  • PHP
  • PHPMailer
  • plugins
    • admin
    • development
    • feed
    • mail
    • media
    • misc
    • seo
    • spam
    • uploader
    • users
    • zenpage
    • zenphoto
      • news
  • Services
    • JSON

Classes

  • AnyFile
  • AnyFile_Options
  • bxslider
  • colorbox
  • cycle
  • favoritesOptions
  • flag_thumbnail
  • image_effects
  • jcarousel
  • jPlayer
  • jplayer_options
  • slideshow
  • TextObject_Options
  • viewer_size_image_options
  • WEBdocs
  • WEBdocs_Options
  • xmpMetadata

Functions

  • get_AnyFile_suffixes
  • getFavoritesURL
  • getjPlayerSkinCSS
  • getjPlayerSkins
  • getViewerImageSize
  • printAddToFavorites
  • printFavoritesURL
  • printjPlayerPlaylist
  • printUserSizeImage
  • printUserSizeSelector
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class cycle

Plugin option handling class

Package: plugins\media
Author: Malte Müller (acrylian)
Located at zp-extensions/slideshow2.php
Methods summary
public
# __construct( )
public
# getOptionsSupported( )
public
# handleOption( $option, $currentValue )
public static
# getSlideshowPlayer( $album, $controls = false, $width = NULL, $height = NULL )
public static
# getShow( $heading, $speedctl, $albumobj, $imageobj, $width, $height, $crop, $shuffle, $linkslides, $controls, $returnpath, $imagenumber )
public static
# getSlide( obj $albumobj, obj $imgobj, integer $width, integer $height, integer $cropw, integer $croph, boolean $linkslides, boolean $crop = false, boolean $carousel = false )

Helper function to print the individual slides

Helper function to print the individual slides

Parameters

$albumobj
Album object
$imgobj
Current slide obj
$width
Slide image width
$height
Slide image height
$cropw
Slide image crop width
$croph
Slide image crop height
$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.

$crop
True or false to crop the image
$carousel
if the slideshow is a carousel so we can enable full image linking (only images allowed!)
public static
# printSlide( obj $albumobj, obj $imgobj, integer $width, integer $height, integer $cropw, integer $croph, boolean $linkslides, boolean $crop = false, boolean $carousel = false )

Helper function to print the individual slides

Helper function to print the individual slides

Parameters

$albumobj
Album object
$imgobj
Current slide obj
$width
Slide image width
$height
Slide image height
$cropw
Slide image crop width
$croph
Slide image crop height
$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.

$crop
True or false to crop the image
$carousel
if the slideshow is a carousel so we can enable full image linking (only images allowed!)
public static type
# getSlideObj( type $slide, type $albumobj )

We might need this to exclude file types or not…

We might need this to exclude file types or not…

Parameters

$slide
$albumobj

Returns

type
public static
# macro( $macros )
public static
# cycleJS( )
public 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

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

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

Returns

string;
Zenphoto doc API documentation generated by ApiGen