slideshow_functions.php
Table of Contents
Functions
- set_slideshow() : bool|int
- Create/ Update a slideshow image record. Use NULL for $ref to create new records.
- delete_slideshow() : bool
- Delete slideshow record
- reorder_slideshow_images() : bool
- Function used to re-order slideshow images
- get_slideshow_image_file_path() : string
- Get the full path for the slideshow image file
Functions
set_slideshow()
Create/ Update a slideshow image record. Use NULL for $ref to create new records.
set_slideshow(int $ref[, int $resource_ref = null ][, int $homepage_show = 1 ][, int $login_show = 0 ]) : bool|int
Parameters
- $ref : int
-
ID of the slideshow image. Use NULL to create a new record
- $resource_ref : int = null
-
ID of the resource this slideshow is related to. Use NULL if no link is required
- $homepage_show : int = 1
-
Set to 1 if slideshow image should appear on the home page
- $login_show : int = 0
-
Set to 1 if slideshow image should appear on the login page
Return values
bool|int —Returns ID of the slideshow image(new/ updated), FALSE otherwise
delete_slideshow()
Delete slideshow record
delete_slideshow(int $ref) : bool
Parameters
- $ref : int
-
ID of the slideshow
Return values
boolreorder_slideshow_images()
Function used to re-order slideshow images
reorder_slideshow_images(array<string|int, mixed> $from, array<string|int, mixed> $to) : bool
Parameters
- $from : array<string|int, mixed>
-
Slideshow image data we move FROM
- $to : array<string|int, mixed>
-
Slideshow image data we move TO
Return values
boolget_slideshow_image_file_path()
Get the full path for the slideshow image file
get_slideshow_image_file_path(int $ref) : string
Parameters
- $ref : int
-
ID of the slideshow image
Return values
string —The full path to the slideshow image