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

Procedural File: slideshow.php

Source Location: /zp-extensions/slideshow.php

Page Details
Page Details | Classes | Functions

Supports showing slideshows of images in an album.

Plugin Option 'slideshow_size' -- Size of the images Plugin Option 'slideshow_mode' -- The player to be used Plugin Option 'slideshow_effect' -- The cycle effect Plugin Option 'slideshow_speed' -- How fast it runs Plugin Option 'slideshow_timeout' -- Transition time Plugin Option 'slideshow_showdesc' -- Allows the show to display image descriptions

The theme files 'slideshow.php', 'slideshow.css', and 'slideshow-controls.png' must reside in the theme folder. If you are creating a custom theme, copy these files form the "default" theme of the Zenphoto distribution. Note that the Colorbox mode does not require these files as it is called on your theme's image.php and album.php direclty via the slideshow button. The Colorbox plugin must be enabled and setup for these pages.

NOTE: The jQuery Cycle and the jQuery Colorbox modes do not support movie and audio files. If you need to show them please use the Flash mode. In Colorbox mode there will be no slideshow button on the image page if that current image is a movie/audio file.
Author:  Malte Müller (acrylian), Stephen Billard (sbillard), Don Peterson (dpeterson)
Classes
Page Details | Classes | Functions
Class Description
slideshowOptions Plugin option handling class
Functions
Page Details | Classes | Functions
is_valid  [line 269]

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


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

[ Top ]
printSlideShow  [line 304]

Prints the slideshow using the jQuery plugin Cycle (http://http://www.malsup.com/jquery/cycle/) or Flash based using Flowplayer3 http://flowplayer.org if installed

Two ways to use: a) Use on your theme's slideshow.php page and called via printSlideShowLink(): If called from image.php it starts with that image, called from album.php it starts with the first image (jQuery only) To be used on slideshow.php only and called from album.php or image.php.

b) Calling directly via printSlideShow() function (jQuery mode recommended) Call printSlideShowJS() function in the head section of the theme page you want to use the slideshow on. Then place the printSlideShow() function where you want the slideshow to appear and set $albumobj and if needed $imageobj. The controls are disabled automatically.

NOTE: The jQuery mode does not support movie and audio files anymore. If you need to show them please use the Flash mode. Also note that this function is not used for the Colorbox mode!

 Parameters:
bool   $heading:  set to true (default) to emit the slideshow breadcrumbs in flash mode
bool   $speedctl:  controls whether an option box for controlling transition speed is displayed
obj   $albumobj:  The object of the album to show the slideshow of. If set this overrides the POST data of the printSlideShowLink()
obj   $imageobj:  The object of the image to start the slideshow with. If set this overrides the POST data of the printSlideShowLink(). If not set the slideshow starts with the first image of the album.
int   $width:  The width of the images (jQuery mode). If set this overrides the size the slideshow_width plugin option that otherwise is used.
int   $height:  The heigth of the images (jQuery mode). If set this overrides the size the slideshow_height plugin option that otherwise is used.
bool   $crop:  Set to true if you want images cropped width x height (jQuery mode only)
bool   $shuffle:  Set to true if you want random (shuffled) order


void printSlideShow( [bool $heading = true], [bool $speedctl = false], [obj $albumobj = ""], [obj $imageobj = ""], [int $width = ""], [int $height = ""], [bool $crop = false], [bool $shuffle = false]  )

[ Top ]
printSlideShowJS  [line 713]

Prints the path to the slideshow JS and CSS (printed because some values need to be changed dynamically).

CSS can be adjusted To be used on slideshow.php
void printSlideShowJS( )

[ Top ]
printSlideShowLink  [line 107]

Prints a link to call the slideshow (not shown if there are no images in the album) To be used on album.php and image.php A CSS id names 'slideshowlink' is attached to the link so it can be directly styled.

If the mode is set to "jQuery Colorbox" and the Colorbox plugin is enabled this link starts a Colorbox slideshow from a hidden HTML list of all images in the album. On album.php it starts with the first always, on image.php with the current image.

 Parameters:
string   $linktext:  Text for the link
string   $linkstyle:  Style of Text for the link


void printSlideShowLink( [string $linktext = ''], [string $linkstyle = '']  )

[ Top ]
plugins
Packages:
core
admin
classes
functions
GoogleMapAPI
JSMin
OpenID
PHPMailer
plugins
Services_JSON

Files:
admin-approval.php
auto_backup.php
class-AnyFile.php
class-textobject.php
class-textobject_core.php
class-WEBdocs.php
colorbox.php
comment_form.php
contact_form.php
crop_image.php
deprecated-functions.php
downloadList.php
dynamic-locale.php
email-newuser.php
failed_access_blocker.php
flag_thumbnail.php
flowplayer3.php
functions-rating.php
GoogleMap.php
googleVerify.php
hitcounter.php
html_meta_tags.php
image_album_statistics.php
image_effects.php
jcarousel_thumb_nav.php
jplayer.php
menu_manager.php
multiple_layouts.php
none.php
paged_thumbs_nav.php
PHPMailer.php
print_album_menu.php
rating.php
reCaptcha.php
search_statistics.php
security-logger.php
seo_cleanup.php
seo_locale.php
show_not_logged-in.php
simple.php
sitemap-extended.php
slideshow.php
static_html_cache.php
tag_extras.php
tag_suggest.php
tiny_mce.php
user_mailing_list.php
viewer_size_image.php
wordpress_import.php
xmpMetadata.php
zenpage.php
zenphoto.php
zenphoto_news.php
zenphoto_sendmail.php
zenphoto_seo.php

usermanagement
federated_logon.php
Google_logon.php
image_upload_limiter.php
MyOpenID_logon.php
OpenID_logon.php
quota_manager.php
register_user.php
user-expiry.php
user_groups.php
user_login-out.php
Verisign_logon.php
Yahoo_logon.php

zenpage
zenpage-class-category.php
zenpage-class-news.php
zenpage-class-page.php
zenpage-class.php
zenpage-template-functions.php

zenphoto_news
rsslib.php

Classes:
AnyFile
AnyFile_Options
auto_backup
captcha
colorbox_Options
comment_form
contactformOptions
deprecated_functions
downloadListOptions
dynamic_locale_options
failed_access_blocker
flag_thumbnailOptions
flowplayer3
flowplayer3_options
googlemapOptions
googleVerifyOptions
hitcounter_options
htmlmetatags
image_effects
jcarouselOptions
jplayer
jplayer_options
jquery_rating
menu_manager
multipleLayoutOptions
pagedThumbsNav
pagedthumbsOptions
print_album_menu
search_statistics
security_logger
sitemap
slideshowOptions
SpamFilter
staticCache
staticCache_options
TextObject
TextObject_Options
tinymceOptions
viewer_size_image_options
WEBdocs
WEBdocs_Options
xmpMetadata_options
zenpagecms
zenphoto_seo
zp_PHPMailer
usermanagement
federated_login_options
Quota_management
register_user_options
uploadlimit
user_expiry
user_logout_options
zenpage
Zenpage
ZenpageCategory
ZenpageItems
ZenpageNews
ZenpagePage
ZenpageRoot
Documentation generated on Tue, 20 Dec 2011 16:08:09 +0100 by phpDocumentor 1.4.3