SnapContentInteractivateInstructor Class Reference
[Content Modules]

Provides support for Interactivate instructor pages. More...

Inheritance diagram for SnapContentInteractivateInstructor:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 addPlacement ($obj)
 Add new placement to list of placements.
 addPreparation ($content)
 INSERT BRIEF DESCRIPTION HERE.
 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.


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.


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

SnapContentInteractivateInstructor::addPreparation ( content  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:
$content [TYPE]: DESCRIPTION
Returns:
[TYPE]: RETURN DESCRIPTION

SnapContentInteractivateInstructor::clearPlacements (  ) 

Resets the placements array.

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

SnapContentInteractivateInstructor::clearPreparations (  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:
[TYPE]: RETURN DESCRIPTION

SnapContentInteractivateInstructor::getDescription (  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:
[TYPE]: RETURN DESCRIPTION

SnapContentInteractivateInstructor::getLoadErrors (  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:
[TYPE]: RETURN DESCRIPTION

SnapContentInteractivateInstructor::getPlacements (  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:
[TYPE]: RETURN DESCRIPTION

SnapContentInteractivateInstructor::getPreparations (  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:
[TYPE]: RETURN DESCRIPTION

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

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


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

Generated on Wed Nov 24 02:03:09 2010 for Common by  doxygen 1.5.6