Docs For Class Gallery1DataParser

Methods

getAlbumHierarchy [line 160]

array getAlbumHierarchy(
string
$path 
)

Build a data tree of albums

Parameters:

string

$path:

Path to albums directory

API Tags:

Return:

GalleryStatus a status code, array of albumnames and their children, and their children...

[ Top ]

getAlbumList [line 102]

array getAlbumList(
string
$path 
)

Fetch an array of albums from a given path

Parameters:

string

$path:

Path to albums directory

API Tags:

Return:

GalleryStatus a status code, array of objects

[ Top ]

getParentAlbumList [line 132]

array getParentAlbumList(
string
$path 
)

Fetch an associative array of parentalbum names from a given path to gallery1 albums

Parameters:

string

$path:

Path to albums directory

API Tags:

Return:

GalleryStatus a status code, array of albums and their parents

[ Top ]

getPhotoCount [line 249]

array getPhotoCount(
string
$path 
)

Count the number of photos in an album dir

Parameters:

string

$path:

Path to album directory

API Tags:

Return:

GalleryStatus a status code, integer Count of photos

[ Top ]

getPhotos [line 265]

array getPhotos(
string
$path 
)

Count the photo data from an album dir

Parameters:

string

$path:

Path to album directory

API Tags:

Return:

GalleryStatus a status code, array Galleryphotos

[ Top ]

getRootAlbums [line 189]

array getRootAlbums(
string
$path 
)

Fetch an array of albums with no parents

Parameters:

string

$path:

Path to albums directory

API Tags:

Return:

GalleryStatus a status code, array of albumnames

[ Top ]

getUserFieldsByUid [line 366]

array getUserFieldsByUid(
string
$path, string
$uid 
)

Load user metadata given a path and uid

Parameters:

string	$path:	Path to album directory
string	$uid:	Uid to import

API Tags:

Return:

GalleryStatus a status code, array User metadata

[ Top ]

getUserFieldsByUsername [line 401]

array getUserFieldsByUsername(
string
$path, string
$username 
)

Load user metadata given a path and username

Parameters:

string	$path:	Path to album directory
string	$username:	Username to import

API Tags:

Return:

GalleryStatus a status code, array User metadata

[ Top ]

getUserUids [line 284]

array getUserUids(
string
$path 
)

Load user uids from path

Parameters:

string

$path:

Path to album directory

API Tags:

Return:

GalleryStatus a status code, array Associative array of uids and usernames

[ Top ]

isValidAlbumsPath [line 43]

boolean isValidAlbumsPath(
string
$path 
)

Verify that the given path holds an albumdb and that the albumdb is readable

Parameters:

string

$path:

Path to albums

API Tags:

Return:

True if the path is valid, otherwise false

[ Top ]

isValidUid [line 332]

boolean isValidUid(
string
$path, string
$uid 
)

Validate user id from gallery v1.x.x

Parameters:

string	$path:
string	$uid:	Uid to be tested

[ Top ]

isValidUidString [line 317]

boolean isValidUidString(
string
$uid 
)

Validate user id string from gallery v1.x.x

Parameters:

string

$uid:

Uid to be tested

[ Top ]

loadAlbumFields [line 219]

array loadAlbumFields(
string
$path 
)

Load and return album metadata from given directory

Parameters:

string

$path:

Path to album directory

API Tags:

Return:

GalleryStatus a status code, object Unserialized album metadata

[ Top ]

loadFile [line 62]

array loadFile(
string
$fileName 
)

Load and return user metadata from given file

Parameters:

string

$fileName:

Path to user file to unserialize

API Tags:

Return:

GalleryStatus a status code, object Unserialized user metadata

[ Top ]

	Migrate Classes

[ class tree: Migrate ] [ index: Migrate ] [ all elements ]

Class: Gallery1DataParser

Class Gallery1DataParser