AlbumZip
in package
Table of Contents
- $levels : null
- Used to store the subalbum option once handled
- AddAlbum() : mixed
- generates an array of filenames to zip recurses into the albums subalbums on option
- AddAlbumCache() : mixed
- generates an array of cachefilenames to zip recurses into the albums subalbums on option
- create() : mixed
- Creates a zip file of the album
- pageError() : mixed
- Emits a page error. Used for attempts to bypass password protection
- subalbumsOption() : int
- Handles the subalbum option only the first time it is requested and stores it to make it at once available in any subsequent cycle.
Properties
$levels
Used to store the subalbum option once handled
private
static null
$levels
= \null
Methods
AddAlbum()
generates an array of filenames to zip recurses into the albums subalbums on option
public
static AddAlbum(object $album, int $base, string $filebase, int $level[, string $root_folder = "" ]) : mixed
Parameters
- $album : object
-
album object to add
- $base : int
-
the length of the base album name
- $filebase : string
-
the server directory of the album
- $level : int
-
initial value is 0, recursing into subalbums sets it to 1
- $root_folder : string = ""
-
allows parent album's sidecars in the same folder of album
Return values
mixed —AddAlbumCache()
generates an array of cachefilenames to zip recurses into the albums subalbums on option
public
static AddAlbumCache(object $album, int $base, string $filebase, int $level) : mixed
Parameters
- $album : object
-
album object to add
- $base : int
-
the length of the base album name
- $filebase : string
-
the server directory of the album
- $level : int
-
initial value is 0, recursing into subalbums sets it to 1
Return values
mixed —create()
Creates a zip file of the album
public
static create(string $albumname, mixed $fromcache) : mixed
Parameters
- $albumname : string
-
album folder
- $fromcache : mixed
Return values
mixed —pageError()
Emits a page error. Used for attempts to bypass password protection
public
static pageError(string $err, string $text) : mixed
Parameters
- $err : string
-
error code
- $text : string
-
error message
Return values
mixed —subalbumsOption()
Handles the subalbum option only the first time it is requested and stores it to make it at once available in any subsequent cycle.
public
static subalbumsOption() : int