Zikula Developer Documentation :: Docs For Class UserUtil

[ ] [ ] [ ] [ Todo List ]

Class: UserUtil

Source Location: /pnobjlib/UserUtil.class.php

Class Overview

UserUtil

Methods

Inherited Variables

Inherited Methods

Class Details

[line 19] UserUtil

[ Top ]

Class Methods

method getDynamicDataFields [line 251]

an getDynamicDataFields(
)

Return the defined dynamic user data fields

Tags:

return:

array of dynamic data field definitions

[ Top ]

method getGroupListForUser [line 200]

A getGroupListForUser(
uid
$uid, [separator
$separator = ","])

Return a string list of group-ids for the specified user

Tags:

return:

string list of group ids

Parameters:

uid	$uid	The user ID for which we want the groups
separator	$separator	The field separator to use (default=",") (optional)

[ Top ]

method getGroupsForUser [line 176]

An getGroupsForUser(
uid
$uid)

Return an array group-ids for the specified user

Tags:

return:

array of group IDs

Parameters:

uid

$uid

The user ID for which we want the groups

[ Top ]

method getPNGroup [line 84]

The getPNGroup(
gid
$gid)

Return a group object

Tags:

return:

resulting group object

Parameters:

gid

$gid

The groupID to retrieve

[ Top ]

method getPNGroupIdList [line 149]

A getPNGroupIdList(
[where
$where = ''], [orderBy
$orderBy = ''], [separator
$separator = ','])

Return a (string) list of group-ids which can then be used in a SQL 'IN (...)' clause

Tags:

return:

string list of group ids

Parameters:

where	$where	The where clause to use (optional)
orderBy	$orderBy	The order by clause to use (optional)
separator	$separator	The field separator to use (default=",") (optional)

[ Top ]

method getPNGroups [line 101]

An getPNGroups(
[where
$where = ''], [orderBy
$orderBy = ''], [limitOffset
$limitOffset = -1], [limitNumRows
$limitNumRows = -1], [assocKey
$assocKey = 'gid'])

Return a hash structure mapping gid to groupname

Tags:

return:

array mapping gid to groupname

Parameters:

where	$where	The where clause to use (optional) (default='')
orderBy	$orderBy	The order by clause to use (optional) (default='')
limitOffset	$limitOffset	The select-limit offset (optional) (default=-1)
limitNumRows	$limitNumRows	The number of rows to fetch (optional) (default=-1)
assocKey	$assocKey	The associative key to apply (optional) (default='gid')

[ Top ]

method getPNUser [line 29]

The getPNUser(
uid
$uid, [getVars
$getVars = false])

Return a user object

Tags:

return:

resulting user object

Parameters:

uid	$uid	The userID of the user to retrieve
getVars	$getVars	whether or not to also get the user-variables (not implemented yet)

[ Top ]

method getPNUserField [line 53]

The getPNUserField(
id
$id, field
$field)

Return a field from a user object

Tags:

return:

requested field

Parameters:

id	$id	The userID of the user to retrieve
field	$field	The field from the user object to get

[ Top ]

method getPNUserIdList [line 116]

A getPNUserIdList(
[where
$where = ''], [orderBy
$orderBy = ''], [separator
$separator = ','])

Return a (string) list of user-ids which can then be used in a SQL 'IN (...)' clause

Tags:

return:

string list of user ids

Parameters:

where	$where	The where clause to use (optional)
orderBy	$orderBy	The order by clause to use (optional)
separator	$separator	The field separator to use (default=",") (optional)

[ Top ]

method getPNUsers [line 71]

An getPNUsers(
[where
$where = ''], [orderBy
$orderBy = ''], [limitOffset
$limitOffset = -1], [limitNumRows
$limitNumRows = -1], [assocKey
$assocKey = 'uid'])

Return a hash structure mapping uid to username

Tags:

return:

array mapping uid to username

Parameters:

where	$where	The where clause to use (optional)
orderBy	$orderBy	The order by clause to use (optional)
limitOffset	$limitOffset	The select-limit offset (optional) (default=-1)
limitNumRows	$limitNumRows	The number of rows to fetch (optional) (default=-1)
assocKey	$assocKey	The associative key to apply (optional) (default='gid')

[ Top ]

method getSelectorData_PNGroup [line 300]

The getSelectorData_PNGroup(
defaultValue
$defaultValue, [defaultText
$defaultText = ''], [ignore
$ignore = array()], includeAll
$includeAll, [allText
$allText = ''])

Return a PN array structure for the PN user group selector

Tags:

return:

PN array structure for the user group selector

Parameters:

defaultValue	$defaultValue	The default value of the selector (default=0) (optional)
defaultText	$defaultText	The text of the default value (optional)
ignore	$ignore	An array of keys to ignore (optional)
includeAll	$includeAll	whether to include an "All" choice (optional)
allText	$allText	The text to display for the "All" choice (optional)

[ Top ]

method getSelectorData_PNUser [line 344]

The getSelectorData_PNUser(
defaultValue
$defaultValue, [defaultText
$defaultText = ''], [ignore
$ignore = array()], includeAll
$includeAll, [allText
$allText = ''], [exclude
$exclude = ''])

Return a PN array strcuture for the PN user dropdown box

Tags:

return:

PN array structure for the user group selector

Parameters:

defaultValue	$defaultValue	The default value of the selector (optional) (default=0)
defaultText	$defaultText	The text of the default value (optional) (default='')
ignore	$ignore	An array of keys to ignore (optional) (default=array())
includeAll	$includeAll	whether to include an "All" choice (optional) (default=0)
allText	$allText	The text to display for the "All" choice (optional) (default='')
exclude	$exclude	An SQL IN-LIST string to exclude specified uids

[ Top ]

method getUserDynamicDataFields [line 267]

an getUserDynamicDataFields(
uid
$uid, [assocKey
$assocKey = 'uda_propid'], [standardFields
$standardFields = false])

Return a string list of user-ids for the specified group

Tags:

return:

array of user IDs

Parameters:

uid	$uid	The user ID for which we want the users
assocKey	$assocKey	The associate Key to use
standardFields	$standardFields	Whether or not to also marshall the standard user properties into the DUD array

[ Top ]

method getUsersForGroup [line 234]

an getUsersForGroup(
gid
$gid, [separator
$separator = ","])

Return a string list of user-ids for the specified group

Tags:

return:

array of user IDs

Parameters:

gid	$gid	The group ID for which we want the users
separator	$separator	The field separator to use (default=",") (optional)

[ Top ]

Docs For Class UserUtil

Class: UserUtil

Class Overview

Methods

Inherited Variables

Inherited Methods

Class Details

Class Methods

method getDynamicDataFields [line 251]

Tags:

method getGroupListForUser [line 200]

Tags:

Parameters:

method getGroupsForUser [line 176]

Tags:

Parameters:

method getPNGroup [line 84]

Tags:

Parameters:

method getPNGroupIdList [line 149]

Tags:

Parameters:

method getPNGroups [line 101]

Tags:

Parameters:

method getPNUser [line 29]

Tags:

Parameters:

method getPNUserField [line 53]

Tags:

Parameters:

method getPNUserIdList [line 116]

Tags:

Parameters:

method getPNUsers [line 71]

Tags:

Parameters:

method getSelectorData_PNGroup [line 300]

Tags:

Parameters:

method getSelectorData_PNUser [line 344]

Tags:

Parameters:

method getUserDynamicDataFields [line 267]

Tags:

Parameters:

method getUsersForGroup [line 234]

Tags:

Parameters:

Packages:

Files:

Classes: