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.
Protected Member Functions
	getQuestions ()
	INSERT BRIEF DESCRIPTION HERE.
	getRefOrder ()
	INSERT BRIEF DESCRIPTION HERE.
	getResponses ()
	INSERT BRIEF DESCRIPTION HERE.
	queryOrSetError ($query)
	INSERT BRIEF DESCRIPTION HERE.
	setSurveyId ($surveyId)
	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

Definition at line 33 of file SQuestionnaire.php5.

---

Constructor & Destructor Documentation

SQuestionnaire::__construct

(

$

id = ""

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$id

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 61 of file SQuestionnaire.php5.

References populate(), setDBI(), and setOption().

---

Member Function Documentation

SQuestionnaire::addQuestion

(

$

question

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$question

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 223 of file SQuestionnaire.php5.

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

Referenced by populate().

SQuestionnaire::addResponseForRef	(	$	ref,
		$	response
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

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

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 274 of file SQuestionnaire.php5.

References SObject::setError().

Referenced by populate(), and setXFormsModel().

SQuestionnaire::commit

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 337 of file SQuestionnaire.php5.

References SObject::getError(), getQuestions(), getResponses(), and SObject::setError().

SQuestionnaire::getDBI

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 95 of file SQuestionnaire.php5.

SQuestionnaire::getOption

(

$

key

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$key

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 120 of file SQuestionnaire.php5.

Referenced by populate(), and setXFormsModel().

SQuestionnaire::getQuestionByRef

(

$

ref

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$ref

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 257 of file SQuestionnaire.php5.

References SObject::setError().

Referenced by setXFormsModel().

SQuestionnaire::getQuestions

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 546 of file SQuestionnaire.php5.

Referenced by commit(), and getXFormsModel().

SQuestionnaire::getRefOrder

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 557 of file SQuestionnaire.php5.

Referenced by getXFormsModel().

SQuestionnaire::getResponseByRefAndId	(	$	ref,
		$	responseId
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

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

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 311 of file SQuestionnaire.php5.

References SObject::setError().

SQuestionnaire::getResponses

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 568 of file SQuestionnaire.php5.

Referenced by commit().

SQuestionnaire::getResponsesForRef

(

$

ref

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$ref

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 294 of file SQuestionnaire.php5.

References SObject::setError().

Referenced by getXFormsModel(), and setXFormsModel().

SQuestionnaire::getSurveyId

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 579 of file SQuestionnaire.php5.

Referenced by setXFormsModel().

SQuestionnaire::getXFormsModel

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 378 of file SQuestionnaire.php5.

References SObject::getError(), getQuestions(), getRefOrder(), getResponsesForRef(), and SObject::setError().

SQuestionnaire::populate

(

$

surveyId = ""

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$surveyId

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 135 of file SQuestionnaire.php5.

References addQuestion(), addResponseForRef(), SObject::getErrorFrom(), getOption(), SObject::hasError(), queryOrSetError(), SObject::setPrettyError(), and setSurveyId().

Referenced by __construct().

SQuestionnaire::queryOrSetError

(

$

query

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

$query

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 603 of file SQuestionnaire.php5.

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

Referenced by populate().

SQuestionnaire::setDBI

(

$

DBI

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$DBI

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 84 of file SQuestionnaire.php5.

Referenced by __construct().

SQuestionnaire::setOption	(	$	key,
		$	value
	)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

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

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 108 of file SQuestionnaire.php5.

Referenced by __construct().

SQuestionnaire::setSurveyId

(

$

surveyId

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

$surveyId

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 591 of file SQuestionnaire.php5.

Referenced by populate().

SQuestionnaire::setXFormsModel

(

$

xml

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$xml

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 446 of file SQuestionnaire.php5.

References addResponseForRef(), SObject::getError(), getOption(), getQuestionByRef(), getResponsesForRef(), getSurveyId(), SObject::parseXML(), and SObject::setError().

---

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

• SWAT/questionnaire/SQuestionnaire.php5