this class implements methods to display snapshots
Located in /program/modules/snapshots/snapshots_view.php (line 70)
Class | Description |
---|---|
![]() |
this class implements methods to display snapshots |
the constructor only stores relevant data for future use
add a navigation bar / tool bar for a snapshot
this bar contains the following elements:
retrieve all image files (snapshots) from directory $path
This creates an array containing a (filtered) listing of the images in the directory called $path. These items are suppressed:
A second filtering makes sure that the items returned are actually images.
retrieve configuration data for this set of snapshots
this routine fetches the configuration from the snapshots table and stores the sanitised information from the various fields in the object variables.
construct an image configuration array
this steps through the snapshots list and prepares an array. The n'th image (starting at 0) in that array is defined as follows:
img[n][0] = width of the image (in pixels) img[n][1] = height of the image (in pixels) img[n][2] = the url of the image file (src-attribute of the img tag) img[n][3] = the number of seconds to display this image img[n][4] = title to add to the display (document title)
construct configuration data for javascript processing
this outputs JavaScript code that is necessary to setup a slideshow. We create a 0-based array img[] with information about all available images. We also plug in a few translations and our own URL-variant.
include an external javascript file once
this adds an inclusion of a javascript file once in the document we are creating in $this->theme. If multiple instances of this SnapshowViewer-class exist the file is included only once.
task dispatcher
this routine decides what to do and calls the appropriate workhorse routine(s)
output the raw image data as a tab-delimited file
output format ('|' denotes TAB-character): width | height | image url | displaytime | title
show the regular thumbnails overview and then pop-up a full-screen slideshow on top
this is basically the same as the thumbnail overview, be it that we get the effect of 'automagically' entering the slideshow (take it from the top).
display a single full-size snapshot scaled to the specified dimension
display snapshots in the form of 0 or more clickable thumbnails
Documentation generated on Tue, 28 Jun 2016 19:11:59 +0200 by phpDocumentor 1.4.0