Class: GalleryMembersHelper

Source Location: /modules/members/classes/GalleryMembersHelper.class

Class GalleryMembersHelper

Class Overview

Utility functions useful in managing GalleryMembers

Located in /modules/members/classes/GalleryMembersHelper.class [line 35]

Method Summary

array	canViewMembersModule()	Return true if the user has permission to view the Members Module
array	canViewProfileEmail()	Return true if the user has permission to view members email addresses
array	daysSinceCreation()	Return the calendar days since the user's creationTimestamp.
array	fetchLastUserItems()	Return the last N items a user created
array	fetchUserItemCount()	Return the total number of items a user owns
array	getMembersCount()	Get the current member count

[ Top ]

Methods

canViewMembersModule [line 174]

array canViewMembersModule(
int
$userId 
)

Return true if the user has permission to view the Members Module

Parameters:

int

$userId:

API Tags:

Return:

GalleryStatus a status code, boolean canViewMembersModule permission

[ Top ]

canViewProfileEmail [line 195]

array canViewProfileEmail(
int
$userId 
)

Return true if the user has permission to view members email addresses

Parameters:

int

$userId:

API Tags:

Return:

GalleryStatus a status code, boolean canViewProfileEmail permission

[ Top ]

daysSinceCreation [line 234]

array daysSinceCreation(
int
$userId 
)

Return the calendar days since the user's creationTimestamp.

Parameters:

int

$userId:

API Tags:

Return:

GalleryStatus a status code, int daysSinceCreation number in days

[ Top ]

fetchLastUserItems [line 93]

array fetchLastUserItems(
int
$userId, int
$offset, int
$count, [string
$orderDirection = ORDER_DESCENDING] 
)

Return the last N items a user created

Parameters:

int	$userId:
int	$offset:
int	$count:
string	$orderDirection:	(optional)

API Tags:

Return:

GalleryStatus a status code, array (GalleryItem, GalleryItem, ...)

[ Top ]

fetchUserItemCount [line 44]

array fetchUserItemCount(
int
$userId 
)

Return the total number of items a user owns

Parameters:

int

$userId:

API Tags:

Return:

GalleryStatus a status code, int ItemCount a users total item count

[ Top ]

getMembersCount [line 257]

array getMembersCount(
)

Get the current member count

API Tags:

Return:

GalleryStatus int how many members are registered

[ Top ]

Documentation generated on Fri, 03 Oct 2008 05:07:43 -0700 by phpDocumentor 1.3.0RC6

	Members Classes

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