TSDStandardObjective Class Reference
[Standards Hierarchy Objects]

Represents objective in TSD standards hierarchy. More...

Inheritance diagram for TSDStandardObjective:

[legend]

List of all members.

Public Member Functions
	__construct ($id= '')
	Constructs new objective object.
	getIdentifier ()
	Returns string meant to be used when displaying the objective.
	getParent ()
	Retrieves parent category.
	isValid ()
	Returns whether objective is valid to be in the database.
	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 list of TSDStandardObjective objects according to constraints specified.

---

Detailed Description

Represents objective in TSD standards hierarchy.

Objectives are the leaf nodes of the TSD standards hierarchy. Objectives can be aligned to resources (see TSDStandard for more). Objectives have a description and belong to exactly one category. They obviously have no children.

Attributes:

• id [int]: ID of grade (-)
• description [string]: description of objective (effectively its name) (edit)
• categoryId [int]: ID of category this objective belongs to (-)

---

Constructor & Destructor Documentation

TSDStandardObjective::__construct

(

$

id = ''

)

Constructs new objective object.

Parameters:

$id

[int]: ID of existing objective if this object is to be populated from the database

---

Member Function Documentation

TSDStandardObjective::getIdentifier

(

)

Returns string meant to be used when displaying the objective.

This string is not guaranteed to be unique, but is considered to be a good enough display name. Currently, it is simply the value of the 'description' field. Note that since objectives are especially likely to have the same descriptions, this field should not be considered enough to identify an objective even for a user. Make sure to provide some other means of identifying the objective, such as ancestry information.

Returns:

[string]: display string

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

Retrieves list of TSDStandardObjective objects according to constraints specified.

See Guide to Database Constraints for more about how to constraint the resultset. You can also request that the number of results be returned, rather than the results themselves.

Parameters:

	$constraints	[array]: resultset constraints
	$limit	[array]: limit the number of results
	$order	[array]: how the results are ordered
	$cnt	[boolean]: if true, just returns a count of how many objects would be returned, otherwise, actually returns array of objects

Returns:

[array]: array of TSDStandardOBjective objects, or an integer if $cnt is true, or null if there was an error

TSDStandardObjective::getParent

(

)

Retrieves parent category.

Returns:

[TSDStandardCategory]: category that contains this objective, or null on error

TSDStandardObjective::isValid

(

)

Returns whether objective is valid to be in the database.

An objective is valid if it has an empty ID, or a >0 numeric ID. It must also have a non-empty string description an a >0 numeric category ID.

Returns:

[boolean]: whether objective is valid according to above criteria

TSDStandardObjective::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

TSDStandardObjective::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/TSDStandardObjective.php5