cycle
in package
Plugin option handling class
Tags
Table of Contents
Methods
- __construct() : mixed
- cycleJS() : mixed
- getOptionsSupported() : type
- getShow() : string
- getSlide() : mixed
- Helper function to print the individual slides
- getSlideObj() : type
- We might need this to exclude file types or not…
- getSlideshowPlayer() : type
- handleOption() : mixed
- is_valid() : string
- 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
- macro() : string
- printSlide() : mixed
- Helper function to print the individual slides
Methods
__construct()
public
__construct() : mixed
Tags
cycleJS()
public
static cycleJS() : mixed
Tags
getOptionsSupported()
public
getOptionsSupported() : type
Tags
Return values
typegetShow()
public
static getShow(type $heading, type $speedctl, type $albumobj, type $imageobj, type $width, type $height, type $crop, type $shuffle, type $linkslides, type $controls, type $returnpath, type $imagenumber) : string
Parameters
- $heading : type
- $speedctl : type
- $albumobj : type
- $imageobj : type
- $width : type
- $height : type
- $crop : type
- $shuffle : type
- $linkslides : type
- $controls : type
- $returnpath : type
- $imagenumber : type
Tags
Return values
stringgetSlide()
Helper function to print the individual slides
public
static getSlide(obj $albumobj, obj $imgobj, int $width, int $height, int $cropw, int $croph, bool $linkslides[, bool $crop = false ][, bool $carousel = false ]) : mixed
Parameters
- $albumobj : obj
-
Album object
- $imgobj : obj
-
Current slide obj
- $width : int
-
Slide image width
- $height : int
-
Slide image height
- $cropw : int
-
Slide image crop width
- $croph : int
-
Slide image crop height
- $linkslides : bool
-
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 : bool = false
-
True or false to crop the image
- $carousel : bool = false
-
if the slideshow is a carousel so we can enable full image linking (only images allowed!)
Tags
getSlideObj()
We might need this to exclude file types or not…
public
static getSlideObj(type $slide, type $albumobj) : type
Parameters
- $slide : type
- $albumobj : type
Tags
Return values
typegetSlideshowPlayer()
public
static getSlideshowPlayer(type $album[, type $controls = false ][, type $width = NULL ][, type $height = NULL ]) : type
Parameters
- $album : type
- $controls : type = false
- $width : type = NULL
- $height : type = NULL
Tags
Return values
typehandleOption()
public
handleOption(type $option, type $currentValue) : mixed
Parameters
- $option : type
- $currentValue : type
Tags
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
public
static is_valid(mixed $image, array<string|int, mixed> $valid_types) : string
Parameters
- $image : mixed
-
either an image object or the filename of an image.
- $valid_types : array<string|int, mixed>
-
list of the types we will accept
Tags
Return values
stringmacro()
public
static macro(type $macros) : string
Parameters
- $macros : type
Tags
Return values
stringprintSlide()
Helper function to print the individual slides
public
static printSlide(obj $albumobj, obj $imgobj, int $width, int $height, int $cropw, int $croph, bool $linkslides[, bool $crop = false ][, bool $carousel = false ]) : mixed
Parameters
- $albumobj : obj
-
Album object
- $imgobj : obj
-
Current slide obj
- $width : int
-
Slide image width
- $height : int
-
Slide image height
- $cropw : int
-
Slide image crop width
- $croph : int
-
Slide image crop height
- $linkslides : bool
-
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 : bool = false
-
True or false to crop the image
- $carousel : bool = false
-
if the slideshow is a carousel so we can enable full image linking (only images allowed!)