AuthUser Class Reference
[Authentication Database Model Objects]

Model class for User entity. More...

Inheritance diagram for AuthUser:

[legend]

List of all members.

Public Member Functions
	__construct ($constraints=null, $multi=false)
	Constructs new AuthUser object.
	addConfirmEmail ($hash, $requestTime= '')
	Add new AuthConfirmEmail object connected to this object.
	addResetPassword ($hash, $requestTime= '')
	Add new AuthResetPassword object connected to this object.
	addUserConfig ($opt, $page, $value, $project= '*')
	Add new AuthUserConfig object connected to this object.
	addUserToGenGroup ($genGroup)
	Add new AuthUserToGenGroup object connected to this object.
	addUserToPermission ($permission)
	Add new AuthUserToPermission object connected to this object.
	addUserToProject ($project)
	Add new AuthUserToProject object connected to this object.
	getParentHashType ()
	Retrieves parent object of this object.
	getParentHashTypeMulti ($depth=1)
	Retrieves parent object of this object with foreign objects.
	listConfirmEmails ($constraints=array(), $limit=array(), $order=array(), $count=false)
	Retrieves list of children AuthConfirmEmail objects.
	listConfirmEmailsMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of children AuthConfirmEmail objects using joins.
	listResetPasswords ($constraints=array(), $limit=array(), $order=array(), $count=false)
	Retrieves list of children AuthResetPassword objects.
	listResetPasswordsMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of children AuthResetPassword objects using joins.
	listUserConfigs ($constraints=array(), $limit=array(), $order=array(), $count=false)
	Retrieves list of children AuthUserConfig objects.
	listUserConfigsMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of children AuthUserConfig objects using joins.
	listUserToGenGroups ($constraints=array(), $limit=array(), $order=array(), $count=false)
	Retrieves list of children AuthUserToGenGroup objects.
	listUserToGenGroupsMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of children AuthUserToGenGroup objects using joins.
	listUserToPermissions ($constraints=array(), $limit=array(), $order=array(), $count=false)
	Retrieves list of children AuthUserToPermission objects.
	listUserToPermissionsMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of children AuthUserToPermission objects using joins.
	listUserToProjects ($constraints=array(), $limit=array(), $order=array(), $count=false)
	Retrieves list of children AuthUserToProject objects.
	listUserToProjectsMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of children AuthUserToProject objects using joins.
Static Public Member Functions
static	exists ($constraints=array())
	Checks to see if object exists according to constraints.
static	existsMulti ($constraints=array())
	Checks to see if object-set exists according to constraints.
static	getAttributesStatic ()
	Retrieves attributes and information about them.
static	getList ($constraints=array(), $limit=array(), $order=array(), $count=false)
	Retrieves list of AuthUser objects.
static	getListMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of AuthUser objects using joins.
static	getTableNameStatic ()
	Retrieves name of table represented by this class.
static	retrieve ($constraints=array(), $checkOnly=false)
	Retrieves a single object of this type, given the constraints.
static	retrieveMulti ($constraints=array(), $checkOnly=false, $depth=1)
	Retrieves a single object of this type, given the constraints, grabbing foreign objects.
Static Public Attributes
static	$ATTRIBUTES
	Attributes for this entity and information about them.

---

Detailed Description

Model class for User entity.

INSERT DESCRIPTION HERE

---

Constructor & Destructor Documentation

AuthUser::__construct	(	$	constraints = null,
		$	multi = false
	)

Constructs new AuthUser object.

This method will only populate the object if a constraints array is passed in, to use for selecting the information for the object from the database (see Guide to Database Constraints).

Parameters:

	$constraints	[array]: constraints array for populating
	$multi	[boolean]: if true, use joins when populating

---

Member Function Documentation

AuthUser::addConfirmEmail	(	$	hash,
		$	requestTime = ''
	)

Add new AuthConfirmEmail object connected to this object.

This method creates a new AuthConfirmEmail and makes sure that relevant foreign keys in that object point to this object and any other necessary objects as passed in as parameters to this method. For parameters that request another model object, you may either pass in the model object itself, or the id value for that object, as would be used in the foreign key of the new AuthConfirmEmail object. For example, if the new object needs to point to both this object and, say, a user object, then you can either pass in a user object, or a user ID.

Parameters:

	$hash	[string]: INSERT DESCRIPTION HERE
	$requestTime	[time]: INSERT DESCRIPTION HERE

Returns:

[AuthConfirmEmail]: new object (already committed) or null on failure

AuthUser::addResetPassword	(	$	hash,
		$	requestTime = ''
	)

Add new AuthResetPassword object connected to this object.

This method creates a new AuthResetPassword and makes sure that relevant foreign keys in that object point to this object and any other necessary objects as passed in as parameters to this method. For parameters that request another model object, you may either pass in the model object itself, or the id value for that object, as would be used in the foreign key of the new AuthResetPassword object. For example, if the new object needs to point to both this object and, say, a user object, then you can either pass in a user object, or a user ID.

Parameters:

	$hash	[string]: INSERT DESCRIPTION HERE
	$requestTime	[time]: INSERT DESCRIPTION HERE

Returns:

[AuthResetPassword]: new object (already committed) or null on failure

AuthUser::addUserConfig	(	$	opt,
		$	page,
		$	value,
		$	project = '*'
	)

Add new AuthUserConfig object connected to this object.

This method creates a new AuthUserConfig and makes sure that relevant foreign keys in that object point to this object and any other necessary objects as passed in as parameters to this method. For parameters that request another model object, you may either pass in the model object itself, or the id value for that object, as would be used in the foreign key of the new AuthUserConfig object. For example, if the new object needs to point to both this object and, say, a user object, then you can either pass in a user object, or a user ID.

Parameters:

	$opt	[string]: INSERT DESCRIPTION HERE
	$page	[string]: INSERT DESCRIPTION HERE
	$value	[string]: INSERT DESCRIPTION HERE
	$project	[string]: INSERT DESCRIPTION HERE

Returns:

[AuthUserConfig]: new object (already committed) or null on failure

AuthUser::addUserToGenGroup

(

$

genGroup

)

Add new AuthUserToGenGroup object connected to this object.

This method creates a new AuthUserToGenGroup and makes sure that relevant foreign keys in that object point to this object and any other necessary objects as passed in as parameters to this method. For parameters that request another model object, you may either pass in the model object itself, or the id value for that object, as would be used in the foreign key of the new AuthUserToGenGroup object. For example, if the new object needs to point to both this object and, say, a user object, then you can either pass in a user object, or a user ID.

Parameters:

$genGroup

[AuthGenGroup]: Can also be foreign key value. INSERT DESCRIPTION HERE

Returns:

[AuthUserToGenGroup]: new object (already committed) or null on failure

AuthUser::addUserToPermission

(

$

permission

)

Add new AuthUserToPermission object connected to this object.

This method creates a new AuthUserToPermission and makes sure that relevant foreign keys in that object point to this object and any other necessary objects as passed in as parameters to this method. For parameters that request another model object, you may either pass in the model object itself, or the id value for that object, as would be used in the foreign key of the new AuthUserToPermission object. For example, if the new object needs to point to both this object and, say, a user object, then you can either pass in a user object, or a user ID.

Parameters:

$permission

[AuthPermission]: Can also be foreign key value. INSERT DESCRIPTION HERE

Returns:

[AuthUserToPermission]: new object (already committed) or null on failure

AuthUser::addUserToProject

(

$

project

)

Add new AuthUserToProject object connected to this object.

This method creates a new AuthUserToProject and makes sure that relevant foreign keys in that object point to this object and any other necessary objects as passed in as parameters to this method. For parameters that request another model object, you may either pass in the model object itself, or the id value for that object, as would be used in the foreign key of the new AuthUserToProject object. For example, if the new object needs to point to both this object and, say, a user object, then you can either pass in a user object, or a user ID.

Parameters:

$project

[AuthProject]: Can also be foreign key value. INSERT DESCRIPTION HERE

Returns:

[AuthUserToProject]: new object (already committed) or null on failure

static AuthUser::exists

(

$

constraints = array()

)

[static]

Checks to see if object exists according to constraints.

This is simply an alias for retrieve($constraints, true);

Parameters:

$constraints

[array]: constraints used to check for existence of object

Returns:

[boolean]: whether object exists in DB

static AuthUser::existsMulti

(

$

constraints = array()

)

[static]

Checks to see if object-set exists according to constraints.

This is simply an alias for retrieveMulti($constraints, true);

Parameters:

$constraints

[array]: constraints used to check for existence of object

Returns:

[boolean]: whether object exists in DB

static AuthUser::getAttributesStatic

(

)

[static]

Retrieves attributes and information about them.

This method is needed because there is no generic way to get at the $ATTRIBUTES static member variable without this kind of method. If you do not need to generically grab the attributes of a model class, just use ModelClass::$ATTRIBUTES or $obj->getAttributes().

Returns:

[array]: contents of static $ATTRIBUTES array

static AuthUser::getList	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false
	)			[static]

Retrieves list of AuthUser objects.

See Guide to Database Constraints for more on how to construct constraint and other arrays for this method.

Parameters:

	$constraints	[array]: limit results by criteria
	$limit	[array]: limit results by count
	$order	[array]: change ordering of results
	$count	[boolean]: if true, return the number of objects that would have been returned, rather than the objects themselves

Returns:

[array of AuthUser]: list of objects matching the criteria, if any, or null on error

static AuthUser::getListMulti	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false,
		$	depth = 1
	)			[static]

Retrieves list of AuthUser objects using joins.

See Guide to Database Constraints for more on how to construct constraint and other arrays for this method. This method differs from getList() in that it initializes the objects with joins, so that their child objects are included as well. Everything else is the same

Parameters:

	$constraints	[array]: limit results by criteria
	$limit	[array]: limit results by count
	$order	[array]: change ordering of results
	$count	[boolean]: if true, return the number of objects that would have been returned, rather than the objects themselves
	$depth	[int]: how deep to traverse dependencies when doing joins

Returns:

[array of AuthUser]: list of objects matching the criteria, if any, or null on error

AuthUser::getParentHashType

(

)

Retrieves parent object of this object.

The parent object of a AuthUser is a AuthHashType, related by the fact that AuthHashType's id has the same value as our hashTypeId field.

Returns:

[AuthHashType]: parent object, or null on error

AuthUser::getParentHashTypeMulti

(

$

depth = 1

)

Retrieves parent object of this object with foreign objects.

The parent object of a AuthUser is a AuthHashType, related by the fact that AuthHashType's id has the same value as our hashTypeId field.

Parameters:

$depth

[int]: how deep to traverse dependencies when doing joins

Returns:

[AuthHashType]: parent object, or null on error

static AuthUser::getTableNameStatic

(

)

[static]

Retrieves name of table represented by this class.

Returns:

[string]: table name

AuthUser::listConfirmEmails	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false
	)

Retrieves list of children AuthConfirmEmail objects.

This method retrieves objects of type AuthConfirmEmail which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves

Returns:

[AuthConfirmEmail]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listConfirmEmailsMulti	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false,
		$	depth = 1
	)

Retrieves list of children AuthConfirmEmail objects using joins.

This method retrieves objects of type AuthConfirmEmail which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2. Unlike listConfirmEmails(), this method joins the child objects with their parent objects.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves
	$depth	[int]: how deep to traverse dependencies when doing joins

Returns:

[AuthConfirmEmail]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listResetPasswords	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false
	)

Retrieves list of children AuthResetPassword objects.

This method retrieves objects of type AuthResetPassword which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves

Returns:

[AuthResetPassword]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listResetPasswordsMulti	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false,
		$	depth = 1
	)

Retrieves list of children AuthResetPassword objects using joins.

This method retrieves objects of type AuthResetPassword which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2. Unlike listResetPasswords(), this method joins the child objects with their parent objects.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves
	$depth	[int]: how deep to traverse dependencies when doing joins

Returns:

[AuthResetPassword]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listUserConfigs	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false
	)

Retrieves list of children AuthUserConfig objects.

This method retrieves objects of type AuthUserConfig which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves

Returns:

[AuthUserConfig]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listUserConfigsMulti	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false,
		$	depth = 1
	)

Retrieves list of children AuthUserConfig objects using joins.

This method retrieves objects of type AuthUserConfig which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2. Unlike listUserConfigs(), this method joins the child objects with their parent objects.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves
	$depth	[int]: how deep to traverse dependencies when doing joins

Returns:

[AuthUserConfig]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listUserToGenGroups	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false
	)

Retrieves list of children AuthUserToGenGroup objects.

This method retrieves objects of type AuthUserToGenGroup which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves

Returns:

[AuthUserToGenGroup]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listUserToGenGroupsMulti	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false,
		$	depth = 1
	)

Retrieves list of children AuthUserToGenGroup objects using joins.

This method retrieves objects of type AuthUserToGenGroup which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2. Unlike listUserToGenGroups(), this method joins the child objects with their parent objects.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves
	$depth	[int]: how deep to traverse dependencies when doing joins

Returns:

[AuthUserToGenGroup]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listUserToPermissions	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false
	)

Retrieves list of children AuthUserToPermission objects.

This method retrieves objects of type AuthUserToPermission which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves

Returns:

[AuthUserToPermission]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listUserToPermissionsMulti	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false,
		$	depth = 1
	)

Retrieves list of children AuthUserToPermission objects using joins.

This method retrieves objects of type AuthUserToPermission which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2. Unlike listUserToPermissions(), this method joins the child objects with their parent objects.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves
	$depth	[int]: how deep to traverse dependencies when doing joins

Returns:

[AuthUserToPermission]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listUserToProjects	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false
	)

Retrieves list of children AuthUserToProject objects.

This method retrieves objects of type AuthUserToProject which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves

Returns:

[AuthUserToProject]: array of child objects, or an integer if $count is true, or null on error

AuthUser::listUserToProjectsMulti	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false,
		$	depth = 1
	)

Retrieves list of children AuthUserToProject objects using joins.

This method retrieves objects of type AuthUserToProject which have their userId field equal to the value of this object's id field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2. Unlike listUserToProjects(), this method joins the child objects with their parent objects.

Parameters:

	$constraints	[array]: constraints array to further limit results
	$limit	[array]: limit array to control how many and which results are returned
	$order	[array]: order array to control the ordering of the returned results
	$count	[boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves
	$depth	[int]: how deep to traverse dependencies when doing joins

Returns:

[AuthUserToProject]: array of child objects, or an integer if $count is true, or null on error

static AuthUser::retrieve	(	$	constraints = array(),
		$	checkOnly = false
	)			[static]

Retrieves a single object of this type, given the constraints.

Use this method instead of the constructor since the constructor cannot return error conditions properly.

Parameters:

	$constraints	[array]: constraints to use when retrieving object
	$checkOnly	[boolean]: if true, just return whether the row exists in the DB

Returns:

[AuthUser]: retrieved object, or null on error or object does not exist (or true/false if $checkOnly is true, to indicate whether the row exists in the DB)

static AuthUser::retrieveMulti	(	$	constraints = array(),
		$	checkOnly = false,
		$	depth = 1
	)			[static]

Retrieves a single object of this type, given the constraints, grabbing foreign objects.

Use this method instead of the constructor since the constructor cannot return error conditions properly. This method uses getListMulti() instead of getList() to grab the object.

Parameters:

	$constraints	[array]: constraints to use when retrieving object
	$checkOnly	[boolean]: if true, just return whether the row exists in the DB
	$depth	[int]: how deep to traverse dependencies when doing joins

Returns:

[AuthUser]: retrieved object, or null on error or object does not exist (or true/false if $checkOnly is true, to indicate whether the row exists in the DB)

---

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

• SWAT/authDB/AuthUser.php5