Arena  1.0
A content management system
 All Classes Files Functions Variables Pages
Plugins.User.GroupedUsers.AGroupedUser Class Reference

This class represents a user that belongs to one or more groups. More...

+ Inheritance diagram for Plugins.User.GroupedUsers.AGroupedUser:

Public Member Functions

def __init__
 Construct a new grouped user instance. More...
 
def init
 Initializer.
 
def __del__
 Destructor.
 
def fetch
 Fetch the user from the data source. More...
 
def groupCategory
 Retrieve the name of the category used to search for group information. More...
 
- Public Member Functions inherited from Plugins.User.Users.AUser
def __init__
 Construct a new user instance. More...
 
def init
 Initializer.
 
def flush
 Flush changes made to the user record back to the data source. More...
 
def fetch
 Fetch the user record from the data source. More...
 
def meta
 Retrieve or set the dictionary of channel metadata, or a single item from the metadata.
 
def name
 Return the name of the user.
 

Detailed Description

This class represents a user that belongs to one or more groups.

Constructor & Destructor Documentation

def Plugins.User.GroupedUsers.AGroupedUser.__init__ (   Self,
  fieldsValues = None,
  params 
)

Construct a new grouped user instance.

In addition to the parameters expected by AUser.__init__(), this routine expects that params will contain the following items:

  • groupCategory – The name of the category (or table) within the data source that is used to store group affiliations for users.

Member Function Documentation

def Plugins.User.GroupedUsers.AGroupedUser.fetch (   Self,
  userName 
)

Fetch the user from the data source.

def Plugins.User.GroupedUsers.AGroupedUser.groupCategory (   Self)

Retrieve the name of the category used to search for group information.


The documentation for this class was generated from the following file: