AuthEmailHeader Class Reference
[Authentication Database Model Objects]

Model class for EmailHeader entity. More...

Inheritance diagram for AuthEmailHeader:

[legend]

List of all members.

Public Member Functions
	__construct ($constraints=null, $multi=false)
	Constructs new AuthEmailHeader object.
	getParentEmailTemplate ()
	Retrieves parent object of this object.
	getParentEmailTemplateMulti ($depth=1)
	Retrieves parent object of this object with foreign objects.
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 AuthEmailHeader objects.
static	getListMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of AuthEmailHeader 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 EmailHeader entity.

INSERT DESCRIPTION HERE

Definition at line 12 of file AuthEmailHeader.php5.

---

Constructor & Destructor Documentation

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

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

Definition at line 47 of file AuthEmailHeader.php5.

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

---

Member Function Documentation

static AuthEmailHeader::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 109 of file AuthEmailHeader.php5.

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

Definition at line 143 of file AuthEmailHeader.php5.

static AuthEmailHeader::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 67 of file AuthEmailHeader.php5.

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

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

Definition at line 160 of file AuthEmailHeader.php5.

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

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

Definition at line 179 of file AuthEmailHeader.php5.

AuthEmailHeader::getParentEmailTemplate

(

)

Retrieves parent object of this object.

The parent object of a AuthEmailHeader is a AuthEmailTemplate, related by the fact that AuthEmailTemplate's id has the same value as our emailTemplateId field.

Returns:

[AuthEmailTemplate]: parent object, or null on error

Definition at line 193 of file AuthEmailHeader.php5.

References AuthEmailTemplate::retrieve().

AuthEmailHeader::getParentEmailTemplateMulti

(

$

depth = 1

)

Retrieves parent object of this object with foreign objects.

The parent object of a AuthEmailHeader is a AuthEmailTemplate, related by the fact that AuthEmailTemplate's id has the same value as our emailTemplateId field.

Parameters:

$depth

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

Returns:

[AuthEmailTemplate]: parent object, or null on error

Definition at line 206 of file AuthEmailHeader.php5.

static AuthEmailHeader::getTableNameStatic

(

)

[static]

Retrieves name of table represented by this class.

Returns:

[string]: table name

Definition at line 76 of file AuthEmailHeader.php5.

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

[AuthEmailHeader]: 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 91 of file AuthEmailHeader.php5.

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

[AuthEmailHeader]: 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 125 of file AuthEmailHeader.php5.

---

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

• SWAT/authDB/AuthEmailHeader.php5