TSDStandard Class Reference
[Standards Hierarchy Objects]

Represents a join across the entire standards hierarchy. More...

Inheritance diagram for TSDStandard:

[legend]

List of all members.

Public Member Functions
	__construct ($id= '')
	Creates a new TSDStandard.
	commit ()
	INSERT BRIEF DESCRIPTION HERE.
	getIdentifier ()
	INSERT BRIEF DESCRIPTION HERE.
	getParent ()
	INSERT BRIEF DESCRIPTION HERE.
	isValid ()
	INSERT BRIEF DESCRIPTION HERE.
	listChildren ($constraints=array(), $limit=array(), $order=array(), $cnt=false)
	INSERT BRIEF DESCRIPTION HERE.
	listValidChildren ($constraints=array(), $limit=array(), $order=array(), $cnt=false)
	INSERT BRIEF DESCRIPTION HERE.
Static Public Member Functions
static	getList ($constraints=array(), $limit=array(), $order=array(), $cnt=false)
	Retrieves arbitrary list of TSDStandard objects.
static	getResourceAlignments ($urlOrId, $mode=TSD::MODE_LIVE)
	Retrieves list of TSDStandard objects, one for each alignment with a given resource.

---

Detailed Description

Represents a join across the entire standards hierarchy.

This class has a twofold purpose:

• It represents an objective and its ancestry in a single object (equivalent to a join across all the tables in the standards hierarchy)
• It provides an interface for making alignments with standards

Per the second bullet, this class can be used to represent a particular alignment, in which case it will also contain information about the alignment and the resource involved. See the constructor documentation for more about how to use this class as an alignment.

This class has the combined attributes of the other classes in the TSD standards hierarchy. They are prefixed with the object type. So, for example, the standard's organization ID is organization_id and its objective description is objective_description.

Attributes:

• organization_name [string]: name of organization that contains this standard (-)
• organization_id [int]: ID of organization (-)
• grade_name [string]: name of grade that contains this standard (-)
• grade_id [int]: ID of grade (-)
• category_name [string]: name of category that contains this standard (-)
• category_id [int]: ID of category (-)
• objective_description [string]: description of this standard's objective (-)
• objective_id [int]: ID of objective (-)
• resourceId [int]: when this object represents an alignment, this contains the resource ID of the resource to which the standard is aligned (-)
• reason [string]: reason for alignment (when object represents alignment) (-)
• version [string]: version of alignment: DEV or LIVE (when object represents alignment) (-)
• status [string]: status of alignment: NEW, CHANGED, DELETED, APPROVED (when object represents alignment) (-)

---

Constructor & Destructor Documentation

TSDStandard::__construct

(

$

id = ''

)

Creates a new TSDStandard.

You can populate by the ID of an objective, or you can provide an array of other TSDStandard* objects, which will be used to fill in the data. So you can do either of the following:

 // will populate from objective 47 and its ancestry
 $std = new TSDStandard(47);

 // OR

 $org = new TSDStandardOrganization(2);
 $grade = new TSDStandardGrade(52);
 $cat = new TSDStandardCategory(89);
 $obj = new TSDStandardObjective(115);

 // will build from the given objects
 $std = new TSDStandard(array($org, $grade, $cat, $obj));
 

Make sure to include all four objects in the array or this function will fail to construct properly. If no parameter is given, then an empty standard is created, but this is generally useless.

Parameters:

$id

[mixed]: objective ID or array (as described above)

---

Member Function Documentation

TSDStandard::commit

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

TSDStandard::getIdentifier

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

static TSDStandard::getList	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	cnt = false
	)			[static]

Retrieves arbitrary list of TSDStandard objects.

See Guide to Database Constraints for more on the first three parameters, which control which and how many results are retrieved.

Parameters:

	$constraints	[array]: constrain the resultset
	$limit	[array]: control how many results are returned
	$order	[array]: control the ordering of the results
	$cnt	[boolean]: if true, return the number of results that would be returned, rather then returning them

Returns:

[mixed]: array of results, or an int with the number of results if $cnt is true, or null on error

TSDStandard::getParent

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

static TSDStandard::getResourceAlignments	(	$	urlOrId,
		$	mode = TSD::MODE_LIVE
	)			[static]

Retrieves list of TSDStandard objects, one for each alignment with a given resource.

This method requires a URL or a CSERD ID which is used to identify a CSERD resource. It then returns a list of TSDStandard objects, one for each standards alignment with the resource. You can control which types of alignments are returned with the second parameter, which uses the TSD::MODE_* constants.

Parameters:

	$urlOrId	[mixed]: CSERD ID or URL to resource
	$mode	[int]: one of the TSD modes (as described above); defaults to TSD::MODE_LIVE

Returns:

[array]: array of TSDStandard objects, one for each alignment with the given resource, or null on error

TSDStandard::isValid

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

TSDStandard::listChildren	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	cnt = false
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$constraints	[TYPE]: DESCRIPTION
	$limit	[TYPE]: DESCRIPTION
	$order	[TYPE]: DESCRIPTION
	$cnt	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

TSDStandard::listValidChildren	(	$	constraints = array(),
		$	limit = array(),
		$	order = array(),
		$	cnt = false
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$constraints	[TYPE]: DESCRIPTION
	$limit	[TYPE]: DESCRIPTION
	$order	[TYPE]: DESCRIPTION
	$cnt	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

---

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

• tsd/TSDStandard.php5