static void clearCache(
[string
$cachefolder = NULL]
)
|
|
Cleans out the cache folder
Parameters:
|
string |
$cachefolder: |
the sub-folder to clean |
Creates an instance of a gallery
void checkforGuest(
[
&$hint = NULL], [
&$show = NULL], unknown_type
$hint, unknown_type
$show
)
|
|
Checks if guest is loggedin for the album
Parameters:
|
unknown_type |
$hint: |
|
|
unknown_type |
$show: |
|
|
|
&$hint: |
|
|
|
&$show: |
|
void commentClean(
$table
)
|
|
Parameters:
counts visits to the object
bool garbageCollect(
[bool
$cascade = true], [bool
$complete = false], [int
$restart = '']
)
|
|
For every album in the gallery, look for its file. Delete from the database if the file does not exist. Do the same for images. Clean up comments that have been left orphaned.
Returns true if the operation was interrupted because it was taking too long
Parameters:
|
bool |
$cascade: |
garbage collect every image and album in the gallery. |
|
bool |
$complete: |
garbage collect every image and album in the *database* - completely cleans the database. |
|
int |
$restart: |
Image ID to restart scan from |
Album getAlbum(
int
$index
)
|
|
Returns the a specific album in the array indicated by index.
Takes care of bounds checking, no need to check input.
Parameters:
|
int |
$index: |
the index of the album sought |
Returns the main albums directory
array getAlbums(
[int
$page = 0], [string
$sorttype = null], [string
$direction = null], [bool
$care = true], [bool
$mine = NULL]
)
|
|
Get Albums will create our $albums array with a fully populated set of Album names in the correct order.
Returns an array of albums (a pages worth if $page is not zero)
Parameters:
|
int |
$page: |
An option parameter that can be used to return a slice of the array. |
|
string |
$sorttype: |
the kind of sort desired |
|
string |
$direction: |
set to a direction to override the default option |
|
bool |
$care: |
set to false if the order of the albums does not matter |
|
bool |
$mine: |
set true/false to override ownership |
string getAlbumSortKey(
[string
$sorttype = null]
)
|
|
Returns the DB field corresponding to the album sort type desired
Parameters:
|
string |
$sorttype: |
the desired sort |
void getAlbumUseImagedate(
)
|
|
Option to update album date from date of new images
string getBareTitle(
[string
$locale = NULL]
)
|
|
Returns a tag stripped title
Parameters:
Returns the codeblocks as an serialized array
string getCurrentTheme(
)
|
|
Returns the foldername of the current theme.
if no theme is set, returns "default".
string getDesc(
[
$locale = NULL]
)
|
|
Returns the gallery description
Parameters:
void getGallerySession(
)
|
|
Option of for gallery sessions
int getNumAlbums(
[bool
$db = false], [bool
$publishedOnly = false]
)
|
|
Returns the total number of TOPLEVEL albums in the gallery (does not include sub-albums)
Parameters:
|
bool |
$db: |
whether or not to use the database (includes ALL detected albums) or the directories |
|
bool |
$publishedOnly: |
set to true to exclude un-published albums |
array getNumComments(
[bool
$moderated = false]
)
|
|
Returns the count of comments
Parameters:
|
bool |
$moderated: |
set true if you want to see moderated comments |
int getNumImages(
[int
$what = 0]
)
|
|
Returns the number of images in the gallery
Parameters:
|
int |
$what: |
0: all images from the database 1: published images from the database 2: "viewable" images via the object model |
Returns the hashed password for guest gallery access
string getPasswordHint(
[
$locale = NULL]
)
|
|
Returns the hind associated with the gallery password
Parameters:
void getSecondLevelThumbs(
)
|
|
Option to show subalbum images in the thumbnail selector
Option to allow only registered users view the site
Populates the theme array and returns it. The theme array contains information about all the currently available themes.
void getThumbSelectImages(
)
|
|
Option to show images in the thumbnail selector
string getTitle(
[
$locale = NULL]
)
|
|
Returns the gallery title
Parameters:
void getUserLogonField(
)
|
|
Option to expose the user field on logon forms
void getWebsiteTitle(
[
$locale = NULL]
)
|
|
Title to be used for the home (not Zenphoto gallery) WEBsite
Parameters:
The URL of the home (not Zenphoto gallery) WEBsite
returns true if there is any protection on the gallery
void isUnprotectedPage(
$page
$page
)
|
|
Tests if a page is excluded from password protection
Parameters:
void set(
$field,
$value
)
|
|
Parameters:
void setAlbumPublish(
$v
)
|
|
Parameters:
void setAlbumUseImagedate(
$value
)
|
|
Parameters:
set the codeblocks as an serialized array
Parameters:
void setCurrentTheme(
string
$theme
)
|
|
Sets the current theme
Parameters:
|
string |
$theme: |
the name of the current theme |
void setDesc(
string
$desc
)
|
|
Sets the gallery description
Parameters:
void setGallerySession(
$value
)
|
|
Parameters:
void setImagePublish(
$v
)
|
|
Parameters:
void setPassword(
$value
)
|
|
Parameters:
void setPasswordHint(
$value
)
|
|
Parameters:
void setSecondLevelThumbs(
$value
)
|
|
Parameters:
void setSecurity(
$value
)
|
|
Parameters:
void setSortDirection(
$value
)
|
|
Parameters:
void setSortType(
$value
)
|
|
Parameters:
void setThumbSelectImages(
$value
)
|
|
Parameters:
void setUnprotectedPage(
$page,
$on
)
|
|
Parameters:
void setUserLogonField(
$value
)
|
|
Parameters:
void setWebsiteTitle(
$value
)
|
|
Parameters:
void setWebsiteURL(
$value
)
|
|
Parameters:
array sortAlbumArray(
$parentalbum, array
$albums, [string
$sortkey = '`sort_order`'], [string
$sortdirection = NULL], [bool
$mine = NULL]
)
|
|
Sort the album array based on either according to the sort key.
Default is to sort on the `sort_order` field.
Returns an array with the albums in the desired sort order
Parameters:
|
array |
$albums: |
array of album names |
|
string |
$sortkey: |
the sorting scheme |
|
string |
$sortdirection: |
|
|
bool |
$mine: |
set true/false to override ownership |
|
|
$parentalbum: |
|
Information Tags:
| Author: | Todd Papaioannou (lucky@luckyspin.org) |
| Since: | 1.0.0 |
"Magic" function to return a string identifying the object when it is treated as a string
API Tags:
