SDRAdminLdapRole Class Reference
[SDR Model Objects]

Model class for SDRAdminLdapRole entity. More...

Inheritance diagram for SDRAdminLdapRole:

[legend]

List of all members.

Public Member Functions
	__construct ($constraints=null)
	Constructs new SDRAdminLdapRole object.
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 SDRAdminLdapRole 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 SDRAdminLdapRole entity.

INSERT DESCRIPTION HERE

---

Constructor & Destructor Documentation

SDRAdminLdapRole::__construct

(

$

constraints = null

)

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

---

Member Function Documentation

static SDRAdminLdapRole::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 SDRAdminLdapRole::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 SDRAdminLdapRole::getList	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false
	)			[static]

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

static SDRAdminLdapRole::getTableNameStatic

(

)

[static]

Retrieves name of table represented by this class.

Returns:

[string]: table name

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

[SDRAdminLdapRole]: 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:

• sdr/update/model/SDRAdminLdapRole.php5