cycle
in package
Plugin option handling class
Table of Contents
- __construct() : mixed
- cycleJS() : mixed
- getOptionsSupported() : mixed
- getShow() : mixed
- getSlide() : mixed
- Helper function to print the individual slides
- getSlideObj() : type
- We might need this to exclude file types or not…
- getSlideshowPlayer() : mixed
- handleOption() : mixed
- is_valid() : mixed
- 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() : mixed
- printSlide() : mixed
- Helper function to print the individual slides
Methods
__construct()
public
__construct() : mixed
Return values
mixed —cycleJS()
public
static cycleJS() : mixed
Return values
mixed —getOptionsSupported()
public
getOptionsSupported() : mixed
Return values
mixed —getShow()
public
static getShow(mixed $heading, mixed $speedctl, mixed $albumobj, mixed $imageobj, mixed $width, mixed $height, mixed $crop, mixed $shuffle, mixed $linkslides, mixed $controls, mixed $returnpath, mixed $imagenumber) : mixed
Parameters
- $heading : mixed
- $speedctl : mixed
- $albumobj : mixed
- $imageobj : mixed
- $width : mixed
- $height : mixed
- $crop : mixed
- $shuffle : mixed
- $linkslides : mixed
- $controls : mixed
- $returnpath : mixed
- $imagenumber : mixed
Return values
mixed —getSlide()
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!)
Return values
mixed —getSlideObj()
We might need this to exclude file types or not…
public
static getSlideObj(type $slide, type $albumobj) : type
Parameters
- $slide : type
- $albumobj : type
Return values
type —getSlideshowPlayer()
public
static getSlideshowPlayer(mixed $album[, mixed $controls = false ][, mixed $width = NULL ][, mixed $height = NULL ]) : mixed
Parameters
- $album : mixed
- $controls : mixed = false
- $width : mixed = NULL
- $height : mixed = NULL
Return values
mixed —handleOption()
public
handleOption(mixed $option, mixed $currentValue) : mixed
Parameters
- $option : mixed
- $currentValue : mixed
Return values
mixed —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) : mixed
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
Return values
mixed —macro()
public
static macro(mixed $macros) : mixed
Parameters
- $macros : mixed
Return values
mixed —printSlide()
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!)