AuthEmailTemplate Class Reference
[Authentication Database Model Objects]

Model class for EmailTemplate entity. More...

Inheritance diagram for AuthEmailTemplate:

[legend]

List of all members.

Public Member Functions
	__construct ($constraints=null)
	Constructs new AuthEmailTemplate object.
	addEmailHeader ($name= '', $value= '')
	Add new AuthEmailHeader object connected to this object.
	listEmailHeaders ($constraints=array(), $limit=array(), $order=array(), $count=false)
	Retrieves list of children AuthEmailHeader objects.
	listEmailHeadersMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of children AuthEmailHeader objects using joins.
Static Public Member Functions
static	exists ($constraints=array())
	Checks to see if object 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 AuthEmailTemplate objects.
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 Public Attributes
static	$ATTRIBUTES
	Attributes for this entity and information about them.

---

Detailed Description

Model class for EmailTemplate entity.

INSERT DESCRIPTION HERE

Definition at line 12 of file AuthEmailTemplate.php5.

---

Constructor & Destructor Documentation

AuthEmailTemplate::__construct

(

$

constraints = null

)

Constructs new AuthEmailTemplate 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

Definition at line 46 of file AuthEmailTemplate.php5.

References SDatabaseModel::populate(), SModel2::registerAttributes(), SDatabaseModel::registerPrimaryKey(), and SDatabaseModel::registerTableName().

---

Member Function Documentation

AuthEmailTemplate::addEmailHeader	(	$	name = '',
		$	value = ''
	)

Add new AuthEmailHeader object connected to this object.

This method creates a new AuthEmailHeader 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 AuthEmailHeader 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:

	$name	[string]: INSERT DESCRIPTION HERE
	$value	[string]: INSERT DESCRIPTION HERE

Returns:

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

Definition at line 191 of file AuthEmailTemplate.php5.

References SDatabaseModel::commit().

static AuthEmailTemplate::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

Definition at line 86 of file AuthEmailTemplate.php5.

static AuthEmailTemplate::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

Definition at line 116 of file AuthEmailTemplate.php5.

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

Retrieves list of AuthEmailTemplate 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 AuthEmailTemplate]: list of objects matching the criteria, if any, or null on error

Definition at line 103 of file AuthEmailTemplate.php5.

static AuthEmailTemplate::getTableNameStatic

(

)

[static]

Retrieves name of table represented by this class.

Returns:

[string]: table name

Definition at line 125 of file AuthEmailTemplate.php5.

AuthEmailTemplate::listEmailHeaders	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false
	)

Retrieves list of children AuthEmailHeader objects.

This method retrieves objects of type AuthEmailHeader which have their emailTemplateId 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:

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

Definition at line 146 of file AuthEmailTemplate.php5.

AuthEmailTemplate::listEmailHeadersMulti	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false,
		$	depth = 1
	)

Retrieves list of children AuthEmailHeader objects using joins.

This method retrieves objects of type AuthEmailHeader which have their emailTemplateId 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 listEmailHeaders(), 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:

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

Definition at line 170 of file AuthEmailTemplate.php5.

static AuthEmailTemplate::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:

[AuthEmailTemplate]: 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)

Definition at line 68 of file AuthEmailTemplate.php5.

Referenced by AuthEmailHeader::getParentEmailTemplate().

---

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

• SWAT/authDB/AuthEmailTemplate.php5