LifeType 1.2.4 : Vue détaillée de galleryalbums.class.php

Classe: GalleryAlbums - X-Ref

\ingroup Gallery

Database access for GalleryAlbum objects.

Please keep in mind that in the context of this library, every album has to have an user who
owns it. When this library is used within pLog, users don't own albums but blogs do so we will
use blog identifier instead of user identifiers. The reason for this change on how things are
called was that this library can also be used outside pLog, and outside pLog we will most likely
not have blogs but users.

GalleryAlbums() X-Ref

Constructor. Calls the Model constructor and does nothing more.

getUserAlbums( $ownerId, $onlyShownAlbums = false, $page = DEFAULT_PAGING_ENABLED, $itemsPerPage = DEFAULT_ITEMS_PER_PAGE ) X-Ref

Returns an array with all the albums that belong to the given
owner

param: ownerId The identifier of the owner whose albums we'd like to fetch
param: onlyShownAlbums Returns only those albums that have the show_album
param: page The page we'd like to see
param: itemsPerPage number of items per page
return: An array containing GalleryAlbum objects, representing the

getAlbum( $id, $ownerId = -1, $fetchResources = true, $onlyShownAlbums = false ) X-Ref

Returns a specific album from the database.

param: id A valid album identifier.
param: ownerId (optional) The album should have the given id _and_ it should
param: fetchResources (optional) Whether at the same time, we should also fetch the
param: onlyShownAlbums Forces to retrieve only the albums that have been set to appear
return: Returns a valid GalleryAlbum object or 'false' if the album could not be found.

getAlbumByName( $name, $ownerId = -1, $fetchResources = true, $onlyShownAlbums = false ) X-Ref

Returns a specific album from the database given its 'mangled name'

param: name An album name
param: ownerId (optional) The album should have the given id _and_ it should
param: fetchResources (optional) Whether at the same time, we should also fetch the
param: onlyShownAlbums Forces to retrieve only the albums that have been set to appear
return: Returns a valid GalleryAlbum object or 'false' if the album could not be found.

check( $album, $ownerId = -1, $onlyShownAlbums = false ) X-Ref

getChildAlbums( $albumId, $ownerId, $onlyShownAlbums = false ) X-Ref

Returns an array with all the child albums of the given album, but only
the ones at the first level (it is not recursive!)

param: albumId The album identfitier whose children we'd like to get.
param: ownerId To whom should this album belong.
param: onlyShownAlbums Returns only those albums that have the show_album
return: An array of GalleryAlbum objects

getAllParentAlbumIds( $album ) X-Ref

Returns an array with all the parent album ids of the given album

param: album The album object whose parents we'd like to get.
return: An array of GalleryAlbum Id

addAlbum( &$album ) X-Ref

Adds an album to the database

param: album A GalleryAlbum object, with all its data filled in
return: Returns true if successful or false otherwise.

updateAlbum( $album ) X-Ref

updates an album in the db

param: album A GalleryAlbum object that already exists in the db.
param: Returns true if successful or false otherwise.

deleteAlbum( $albumId, $userId = -1 ) X-Ref

removes an album from the db

param: albumId The album identifier
param: userId The user identifier to whom the album belongs (optional)
return: True if successful or false otherwise.

deleteUserAlbums( $ownerId ) X-Ref

Removes all the albums from the given ownerId

param: ownerId The blog identifier

getUserAlbumsGroupedByParentId( $userId, $albumId = 0 ) X-Ref

returns all the albums of the blog in an array. The key of the array is the
parent id of all the albums in the position, and each position is either an
array with all the albums that share the same parent id or empty if none

param: userId
param: albumId - unused
return: An associative array

getNestedAlbumList( $userId ) X-Ref

returns the albums of a blog ordered in the same way as they are nested. Please use
$album->getValue("level") to check their proper nesting.

param: userId

_getNestedAlbumList( $albums, $start = 0, $level = -1 ) X-Ref

getSearchConditions( $searchTerms ) X-Ref

mapRow( $row ) X-Ref

Poids:	444 lignes (16 kb)
Inclus ou requis:	0 fois
Référencé:	3 fois
Nécessite:	0 fichiers

Code source de LifeType 1.2.4

/class/gallery/dao/ -> galleryalbums.class.php (sommaire)

Définit 1 class

Généré le : Mon Nov 26 21:04:15 2007	par Balluche grâce à PHPXref 0.7