SnapContentInteractivateInstructor Class Reference
[Content Modules]

Provides support for Interactivate instructor pages. More...

Inheritance diagram for SnapContentInteractivateInstructor:

[legend]

List of all members.

Public Member Functions
	addPlacement ($obj)
	Add new placement to list of placements.
	addPreparation ($content)
	INSERT BRIEF DESCRIPTION HERE.
	checkMedia ()
	Checks whether on-disk media is available and correct.
	clearPlacements ()
	Resets the placements array.
	clearPreparations ()
	INSERT BRIEF DESCRIPTION HERE.
	getDescription ()
	INSERT BRIEF DESCRIPTION HERE.
	getLoadErrors ()
	INSERT BRIEF DESCRIPTION HERE.
	getPlacements ()
	INSERT BRIEF DESCRIPTION HERE.
	getPreparations ()
	INSERT BRIEF DESCRIPTION HERE.
	getXML ()
	Retrieve raw XML from content module.
	setDescription ($description)
	Sets the instructor page description.
Static Public Member Functions
static	initialValue ()
	Returns initial value for new versions of this type.
Protected Member Functions
	doGetHTML ($params)
	generateXML ()
	INSERT BRIEF DESCRIPTION HERE.
	prepareAndValidateXML ($content, $field, $pre= '', $post= '')
	Massages and validates a chunk of XML.
	validate ()

---

Detailed Description

Provides support for Interactivate instructor pages.

The instructor page is one of the four tabs available in an activity on Interactivate. This tab displays information useful to an instructor, namely, a sample lesson plan, standards/textbook alignments and other tidbits.

Definition at line 12 of file SnapContentInteractivateInstructor.php5.

---

Member Function Documentation

SnapContentInteractivateInstructor::addPlacement

(

$

obj

)

Add new placement to list of placements.

$obj [string]: string of XML for the placement

Returns:

[boolean]: false if XML is invalid

Definition at line 89 of file SnapContentInteractivateInstructor.php5.

References prepareAndValidateXML().

SnapContentInteractivateInstructor::addPreparation

(

$

content

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$content

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 120 of file SnapContentInteractivateInstructor.php5.

References prepareAndValidateXML().

SnapContentInteractivateInstructor::checkMedia

(

)

Checks whether on-disk media is available and correct.

For internal use only.

For non-media-based content, this method should always return true. Otherwise, it should check to make sure all files it is responsible for are on disk and readable by the webserver.

Returns:

[boolean]: whether on-disk media is correct

Reimplemented from SnapContent.

Definition at line 272 of file SnapContentInteractivateInstructor.php5.

SnapContentInteractivateInstructor::clearPlacements

(

)

Resets the placements array.

Call this method when modifying the list of placements, and then call addPlacement() to add new placements

Definition at line 79 of file SnapContentInteractivateInstructor.php5.

SnapContentInteractivateInstructor::clearPreparations

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 108 of file SnapContentInteractivateInstructor.php5.

SnapContentInteractivateInstructor::doGetHTML

(

$

params

)

[protected]

For internal use only.

Reimplemented from SnapContent.

Definition at line 268 of file SnapContentInteractivateInstructor.php5.

References SnapContent::getAll().

SnapContentInteractivateInstructor::generateXML

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 158 of file SnapContentInteractivateInstructor.php5.

References XmlFormatter::finalGenerateXML(), and prepareAndValidateXML().

Referenced by getXML().

SnapContentInteractivateInstructor::getDescription

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 223 of file SnapContentInteractivateInstructor.php5.

SnapContentInteractivateInstructor::getLoadErrors

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 258 of file SnapContentInteractivateInstructor.php5.

SnapContentInteractivateInstructor::getPlacements

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 234 of file SnapContentInteractivateInstructor.php5.

SnapContentInteractivateInstructor::getPreparations

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 246 of file SnapContentInteractivateInstructor.php5.

SnapContentInteractivateInstructor::getXML

(

)

Retrieve raw XML from content module.

Calling getHTML(), which is the normal method to extract content from a content module, will return translated XML => HTML. To get the raw XML, use this method.

Returns:

[string]: XML contained in this content module

Definition at line 137 of file SnapContentInteractivateInstructor.php5.

References generateXML(), and SObject::setError().

static SnapContentInteractivateInstructor::initialValue

(

)

[static]

Returns initial value for new versions of this type.

For internal use only.

Definition at line 284 of file SnapContentInteractivateInstructor.php5.

SnapContentInteractivateInstructor::prepareAndValidateXML	(	$	content,
		$	field,
		$	pre = '',
		$	post = ''
	)			[protected]

Massages and validates a chunk of XML.

For internal use only.

This method is used to format a chunk of XML and validate it before putting it in the database. It gathers useful error information, which can be passed back to the user. The error information is stored in the $loadErrors member array.

Parameters:

	$content	[string]: raw XML to be processed
	$field	[string]: name of field from which XML came (e.g., alternate outline)
	$pre	[string]: prepend this string to the XML before processing it
	$post	[string]: append this string to the XML before processing it

Returns:

[string]: formatted and validated XML, or false on error

Definition at line 32 of file SnapContentInteractivateInstructor.php5.

References SXMLHelper::formatXML(), and SXMLHelper::validateXML().

Referenced by addPlacement(), addPreparation(), generateXML(), and setDescription().

SnapContentInteractivateInstructor::setDescription

(

$

description

)

Sets the instructor page description.

The description is a snippet of XML and must be valid (plain text is valid)

Parameters:

$description

[string]: new description

Returns:

[boolean]: false if the XML is invalid

Definition at line 66 of file SnapContentInteractivateInstructor.php5.

References prepareAndValidateXML().

SnapContentInteractivateInstructor::validate

(

)

[protected]

For internal use only.

Reimplemented from SnapContent.

Definition at line 263 of file SnapContentInteractivateInstructor.php5.

---

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

• snap2/content/SnapContentInteractivateInstructor.php5