SDRVersionCache Class Reference
[SDR Model Objects]

Model class for SDRVersionCache entity. More...

Inheritance diagram for SDRVersionCache:

[legend]

List of all members.

Public Member Functions
	__construct ($constraints=null, $multi=false)
	Constructs new SDRVersionCache object.
	addSDRResourceCache ($cserdId, $Url, $AverageReviewRating=null, $ShodorProject=null, $Hierarchy=null, $releaseFlag= '0', $created= '')
	Add new SDRResourceCache object connected to this object.
	getParentCserd ()
	Retrieves parent object of this object.
	getParentCserdMulti ($depth=1)
	Retrieves parent object of this object with foreign objects.
	getParentVersion ()
	Retrieves parent object of this object.
	getParentVersionMulti ($depth=1)
	Retrieves parent object of this object with foreign objects.
	listSDRResourceCaches ($constraints=array(), $limit=array(), $order=array(), $count=false)
	Retrieves list of children SDRResourceCache objects.
	listSDRResourceCachesMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of children SDRResourceCache 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 SDRVersionCache objects.
static	getListMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1)
	Retrieves list of SDRVersionCache 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 SDRVersionCache entity.

INSERT DESCRIPTION HERE

---

Constructor & Destructor Documentation

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

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

SDRVersionCache::addSDRResourceCache	(	$	cserdId,
		$	Url,
		$	AverageReviewRating = null,
		$	ShodorProject = null,
		$	Hierarchy = null,
		$	releaseFlag = '0',
		$	created = ''
	)

Add new SDRResourceCache object connected to this object.

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

	$cserdId	[int]: INSERT DESCRIPTION HERE
	$Url	[string]: INSERT DESCRIPTION HERE
	$AverageReviewRating	[float]: INSERT DESCRIPTION HERE
	$ShodorProject	[string]: INSERT DESCRIPTION HERE
	$Hierarchy	[int]: INSERT DESCRIPTION HERE
	$releaseFlag	[int]: INSERT DESCRIPTION HERE
	$created	[time]: INSERT DESCRIPTION HERE

Returns:

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

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

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

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

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

SDRVersionCache::getParentCserd

(

)

Retrieves parent object of this object.

The parent object of a SDRVersionCache is a SDRResource, related by the fact that SDRResource's cserdId has the same value as our cserdId field.

Returns:

[SDRResource]: parent object, or null on error

SDRVersionCache::getParentCserdMulti

(

$

depth = 1

)

Retrieves parent object of this object with foreign objects.

The parent object of a SDRVersionCache is a SDRResource, related by the fact that SDRResource's cserdId has the same value as our cserdId field.

Parameters:

$depth

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

Returns:

[SDRResource]: parent object, or null on error

SDRVersionCache::getParentVersion

(

)

Retrieves parent object of this object.

The parent object of a SDRVersionCache is a SDRVersion, related by the fact that SDRVersion's id has the same value as our versionId field.

Returns:

[SDRVersion]: parent object, or null on error

SDRVersionCache::getParentVersionMulti

(

$

depth = 1

)

Retrieves parent object of this object with foreign objects.

The parent object of a SDRVersionCache is a SDRVersion, related by the fact that SDRVersion's id has the same value as our versionId field.

Parameters:

$depth

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

Returns:

[SDRVersion]: parent object, or null on error

static SDRVersionCache::getTableNameStatic

(

)

[static]

Retrieves name of table represented by this class.

Returns:

[string]: table name

SDRVersionCache::listSDRResourceCaches	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false
	)

Retrieves list of children SDRResourceCache objects.

This method retrieves objects of type SDRResourceCache which have their pendingVersionId field equal to the value of this object's versionId 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:

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

SDRVersionCache::listSDRResourceCachesMulti	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	count = false,
		$	depth = 1
	)

Retrieves list of children SDRResourceCache objects using joins.

This method retrieves objects of type SDRResourceCache which have their pendingVersionId field equal to the value of this object's versionId 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 listSDRResourceCaches(), 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:

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

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

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

[SDRVersionCache]: 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/SDRVersionCache.php5