SQuestionnaire Class Reference

Inheritance diagram for SQuestionnaire:

[legend]

List of all members.

Public Member Functions
	__construct ($id="")
	INSERT BRIEF DESCRIPTION HERE.
	addQuestion ($question)
	INSERT BRIEF DESCRIPTION HERE.
	addResponseForRef ($ref, $response)
	INSERT BRIEF DESCRIPTION HERE.
	commit ()
	INSERT BRIEF DESCRIPTION HERE.
	getDBI ()
	INSERT BRIEF DESCRIPTION HERE.
	getOption ($key)
	INSERT BRIEF DESCRIPTION HERE.
	getQuestionByRef ($ref)
	INSERT BRIEF DESCRIPTION HERE.
	getResponseByRefAndId ($ref, $responseId)
	INSERT BRIEF DESCRIPTION HERE.
	getResponsesForRef ($ref)
	INSERT BRIEF DESCRIPTION HERE.
	getSurveyId ()
	INSERT BRIEF DESCRIPTION HERE.
	getXFormsModel ()
	INSERT BRIEF DESCRIPTION HERE.
	populate ($surveyId="")
	INSERT BRIEF DESCRIPTION HERE.
	setDBI ($DBI)
	INSERT BRIEF DESCRIPTION HERE.
	setOption ($key, $value)
	INSERT BRIEF DESCRIPTION HERE.
	setXFormsModel ($xml)
	INSERT BRIEF DESCRIPTION HERE.

---

Detailed Description

SQuestionnaire Object Last Updated: 11/30/07 Created: Mar 2007 - jwsm@shodor.org

You must use objects that support the following specifications:

# survey object that extends SSurvey

# question object that extends SQuestion and supports:

• get/setRef
• get/setType
• get/setRequired
• get/setActive

# response object that extends SResponse and supports:

• get/setQuestionId
• get/setSurveyId
• get/setResponse

For join query, database tables must support:

for Question:

• ref
• active

for Response:

• questionId

---

Constructor & Destructor Documentation

SQuestionnaire::__construct

(

$

id = ""

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$id

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

---

Member Function Documentation

SQuestionnaire::addQuestion

(

$

question

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$question

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::addResponseForRef	(	$	ref,
		$	response
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$ref	[TYPE]: DESCRIPTION
	$response	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::commit

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::getDBI

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::getOption

(

$

key

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$key

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::getQuestionByRef

(

$

ref

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$ref

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::getResponseByRefAndId	(	$	ref,
		$	responseId
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$ref	[TYPE]: DESCRIPTION
	$responseId	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::getResponsesForRef

(

$

ref

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$ref

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::getSurveyId

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::getXFormsModel

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::populate

(

$

surveyId = ""

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$surveyId

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::setDBI

(

$

DBI

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$DBI

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::setOption	(	$	key,
		$	value
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

	$key	[TYPE]: DESCRIPTION
	$value	[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

SQuestionnaire::setXFormsModel

(

$

xml

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$xml

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

---

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

• SWAT/questionnaire/SQuestionnaire.php5