SnapContentInteractivateLesson Class Reference
[Content Modules]

Content Module for Interactivate Lesson Plans. More...

Inheritance diagram for SnapContentInteractivateLesson:

List of all members.

Public Member Functions

addFollowUp ($content)

adds a follow up activity

addKeyTerm ($term)

Adds a key term for this lesson.

addObjective ($obj)

Adds an objective for what should be accomplished in the lesson.

addPrerequisite ($cat, $pre)

Adds a prerequisite If the given prerequisite category is not yet set this funciton will set it.

addPrerequisiteCategory ($cat)

Adds a new categy for Prerequisites Prerequisites are grouped into categories (eg: math, geometry, technology, etc...). The prerequisites themselves must then be added to these categories.

addSection ($name, $content)

Adds another section to the class This is a kind of pseudo-XML, allowing the writer to add any kind of other content they want.

checkMedia ()

INSERT BRIEF DESCRIPTION HERE.

clearFollowUps ()

clears the currently set follow ups

clearKeyTerms ()

Clears out the current key terms.

clearObjectives ()

Clears the currently set objectives.

clearPrerequisites ()

Clears the currently set Prerequisites.

clearSections ()

Clears out all the currently set Sections.

getAbstract ()

INSERT BRIEF DESCRIPTION HERE.

getAlternate ()

INSERT BRIEF DESCRIPTION HERE.

getFollowUpIntro ()

INSERT BRIEF DESCRIPTION HERE.

getFollowUps ()

INSERT BRIEF DESCRIPTION HERE.

getKeyTerms ()

INSERT BRIEF DESCRIPTION HERE.

getLoadErrors ()

INSERT BRIEF DESCRIPTION HERE.

getObjectives ()

INSERT BRIEF DESCRIPTION HERE.

getPreparations ()

INSERT BRIEF DESCRIPTION HERE.

getPrerequisites ()

INSERT BRIEF DESCRIPTION HERE.

getSections ()

INSERT BRIEF DESCRIPTION HERE.

getTitle ()

INSERT BRIEF DESCRIPTION HERE.

getXML ()

Retrieve raw XML from content module.

loadFromXML ($content)

INSERT BRIEF DESCRIPTION HERE.

setAbstract ($abstract)

Sets the lesson abstract, which briefly explains what the lesson involves.

setAlternate ($content)

Sets an alternate lesson outline.

setFollowUpIntro ($content)

sets the intro into the follow up.

setPreparations ($content)

Sets the various preparations necessary to teach this class.

setTitle ($title)

Sets the Title of the lesson that the user will see.

updateFileList ()

INSERT BRIEF DESCRIPTION HERE.

Detailed Description

Content Module for Interactivate Lesson Plans.

This content module contains support for lesson-plans for Interactivate, which is very different from standard lesson-plan XML (the two are not compatible). This generates HTML for the Interactivate Lesson Pages. (Note, however, that the information stored in the database is NOT Standard XML or HTML but rather the values of a number of attributes, from which HTML is generated when getHTML is called.) There were a number of fields in the old Interactivate database that made up the lesson plans. These have been replaced with fairly comparable fields in this ContentModule.

Member Function Documentation

SnapContentInteractivateLesson::addFollowUp ( $ content )

adds a follow up activity

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::addKeyTerm ( $ term )

Adds a key term for this lesson.

Parameters:

$term

[string]: The term to be associated.

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::addObjective ( $ obj )

Adds an objective for what should be accomplished in the lesson.

Parameters:

$obj

[string]: The new objective

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::addPrerequisite	(	$	cat,
		$	pre
	)

Adds a prerequisite If the given prerequisite category is not yet set this funciton will set it.

Parameters:

	$cat	[string]: The category to add this prerequisite to.
	$pre	[string]: The prerequisite that must be completed.

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::addPrerequisiteCategory ( $ cat )

Adds a new categy for Prerequisites Prerequisites are grouped into categories (eg: math, geometry, technology, etc...). The prerequisites themselves must then be added to these categories.

Parameters:

$cat

[string]: The new category

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::addSection	(	$	name,
		$	content
	)

Adds another section to the class This is a kind of pseudo-XML, allowing the writer to add any kind of other content they want.

Parameters:

	$name	[string]: The name of the section
	$content	[string]: What you want this section to say.

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::checkMedia ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

SnapContentInteractivateLesson::getAbstract ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::getAlternate ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::getFollowUpIntro ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::getFollowUps ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::getKeyTerms ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::getLoadErrors ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::getObjectives ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::getPreparations ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::getPrerequisites ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::getSections ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::getTitle ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

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

SnapContentInteractivateLesson::loadFromXML ( $ content )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$content

[TYPE]: DESCRIPTION

Returns:: [TYPE]: RETURN DESCRIPTION

SnapContentInteractivateLesson::setAbstract ( $ abstract )

Sets the lesson abstract, which briefly explains what the lesson involves.

Parameters:

$abstract

[string]: the new abstract

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::setAlternate ( $ content )

Sets an alternate lesson outline.

Parameters:

$content

[string]: the alternate outline

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::setFollowUpIntro ( $ content )

sets the intro into the follow up.

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::setPreparations ( $ content )

Sets the various preparations necessary to teach this class.

Parameters:

$content

[string]: the preparations.

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::setTitle ( $ title )

Sets the Title of the lesson that the user will see.

Parameters:

$title

[string]: the new title

Returns:: [boolean]: success or failure.

SnapContentInteractivateLesson::updateFileList ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

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

snap2/content/SnapContentInteractivateLesson.php5


Public Member Functions
	addFollowUp ($content)
	adds a follow up activity
	addKeyTerm ($term)
	Adds a key term for this lesson.
	addObjective ($obj)
	Adds an objective for what should be accomplished in the lesson.
	addPrerequisite ($cat, $pre)
	Adds a prerequisite If the given prerequisite category is not yet set this funciton will set it.
	addPrerequisiteCategory ($cat)
	Adds a new categy for Prerequisites Prerequisites are grouped into categories (eg: math, geometry, technology, etc...). The prerequisites themselves must then be added to these categories.
	addSection ($name, $content)
	Adds another section to the class This is a kind of pseudo-XML, allowing the writer to add any kind of other content they want.
	checkMedia ()
	INSERT BRIEF DESCRIPTION HERE.
	clearFollowUps ()
	clears the currently set follow ups
	clearKeyTerms ()
	Clears out the current key terms.
	clearObjectives ()
	Clears the currently set objectives.
	clearPrerequisites ()
	Clears the currently set Prerequisites.
	clearSections ()
	Clears out all the currently set Sections.
	getAbstract ()
	INSERT BRIEF DESCRIPTION HERE.
	getAlternate ()
	INSERT BRIEF DESCRIPTION HERE.
	getFollowUpIntro ()
	INSERT BRIEF DESCRIPTION HERE.
	getFollowUps ()
	INSERT BRIEF DESCRIPTION HERE.
	getKeyTerms ()
	INSERT BRIEF DESCRIPTION HERE.
	getLoadErrors ()
	INSERT BRIEF DESCRIPTION HERE.
	getObjectives ()
	INSERT BRIEF DESCRIPTION HERE.
	getPreparations ()
	INSERT BRIEF DESCRIPTION HERE.
	getPrerequisites ()
	INSERT BRIEF DESCRIPTION HERE.
	getSections ()
	INSERT BRIEF DESCRIPTION HERE.
	getTitle ()
	INSERT BRIEF DESCRIPTION HERE.
	getXML ()
	Retrieve raw XML from content module.
	loadFromXML ($content)
	INSERT BRIEF DESCRIPTION HERE.
	setAbstract ($abstract)
	Sets the lesson abstract, which briefly explains what the lesson involves.
	setAlternate ($content)
	Sets an alternate lesson outline.
	setFollowUpIntro ($content)
	sets the intro into the follow up.
	setPreparations ($content)
	Sets the various preparations necessary to teach this class.
	setTitle ($title)
	Sets the Title of the lesson that the user will see.
	updateFileList ()
	INSERT BRIEF DESCRIPTION HERE.

SnapContentInteractivateLesson Class Reference [Content Modules]

Public Member Functions

Detailed Description

Member Function Documentation

SnapContentInteractivateLesson Class Reference
[Content Modules]