SurveyResponse Class Reference

Inheritance diagram for SurveyResponse:

Collaboration diagram for SurveyResponse:

Public Member Functions
	Questions ()
	Survey ()
	Answers ($constraint="")
	Questionnaire ()
	isSubmitted ()
	isEditable ()
	setStatus ($status)
	Set the response status and save. More...
	setDefaults ()
	getEditUrl ()
	getIntroUrl ()
	isTester ()
	excludeResponse ($include_in_results=false)
	reset ()
	reinitialize token for a test user. More...
	SurveyResponse ()
Public Member Functions inherited from AbstractQuestionnaireResponse
	AbstractQuestionnaireResponse ()
	Answers ()
	If key field is not null, retrieve the answers linked to this respondent. More...

Static Public Member Functions
static	findResponseByToken ($survey_id, $token)

Public Attributes
	$fields
	$fieldAliases
	$relations
	$statusTypes

Detailed Description

Definition at line 41 of file survey_response.inc.

Member Function Documentation

Answers()

SurveyResponse::Answers

(

$constraint = ""

)

Definition at line 84 of file survey_response.inc.

     {
          $answers = array();
          $questions = $this->Questions();
          foreach($questions as $question)
          {
               $answer = querySingle(SurveyAnswer, "WHERE response_id = {$this->response_id} AND survey_question_id = $question->survey_question_id");
               if($answer)
                    array_push($answers, $answer);
          }
 
          return $answers;
     }

excludeResponse()

SurveyResponse::excludeResponse

(

$include_in_results = false

)

Definition at line 168 of file survey_response.inc.

     {
          $this->include_in_results = false;
          $this->filter = new InclusionFilter("include_in_results");
          $this->save();
     }

findResponseByToken()

static SurveyResponse::findResponseByToken (   $survey_id,   $token  )

static

Definition at line 122 of file survey_response.inc.

     {
          $responses = Query::create(SurveyResponse, "WHERE survey_id=:survey_id AND token=:token")
          ->bind(":survey_id", $survey_id, ":token", $token)
          ->execute();
               
          return (count($responses) > 0) ? $responses[0] : null;
     }

getEditUrl()

SurveyResponse::getEditUrl

(

)

Definition at line 146 of file survey_response.inc.

     {
          $mgr = new SurveyResponseManager($this);          
          return $mgr->getEditUrl($this->Survey());
     }

getIntroUrl()

SurveyResponse::getIntroUrl

(

)

 Called by merge code and response tester block

Returns

string

Definition at line 157 of file survey_response.inc.

     {
          $mgr = new SurveyResponseManager($this);          
          return $mgr->getIntroUrl($this->Survey());
     }

isEditable()

SurveyResponse::isEditable

(

)

Reimplemented from AbstractQuestionnaireResponse.

Definition at line 108 of file survey_response.inc.

     {
          return ($this->status != "submitted") ? true : false;
     }

isSubmitted()

SurveyResponse::isSubmitted

(

)

Reimplemented from AbstractQuestionnaireResponse.

Definition at line 103 of file survey_response.inc.

     {
          return ($this->status != "submitted") ? false : true;
     }

isTester()

SurveyResponse::isTester

(

)

Definition at line 163 of file survey_response.inc.

     {
          return ($this->include_in_results) ? false : true;
     }

Questionnaire()

SurveyResponse::Questionnaire

(

)

Definition at line 98 of file survey_response.inc.

     {
          return $this->Survey()->Questionnaire();
     }

Questions()

SurveyResponse::Questions

(

)

Reimplemented from AbstractQuestionnaireResponse.

Definition at line 69 of file survey_response.inc.

     {
          $survey = $this->Survey();
 
          if($survey)
               $questions = $survey->Questions();
               
          return $questions;
     }

reset()

SurveyResponse::reset

(

)

reinitialize token for a test user.

Definition at line 179 of file survey_response.inc.

     {
          if(!$this->response_id) return;
          if(!$this->isTester()) return;
     
          $this->setStatus("not_started");
          $answer = new SurveyAnswer();
          $answer->delete("WHERE response_id={$this->response_id}");
     }

setDefaults()

SurveyResponse::setDefaults

(

)

Reimplemented from AbstractQuestionnaireResponse.

Definition at line 132 of file survey_response.inc.

     {
          $this->status = "not_started";
          $this->include_in_results = true;
     }

setStatus()

SurveyResponse::setStatus

(

$status

)

Set the response status and save.

Reimplemented from AbstractQuestionnaireResponse.

Definition at line 114 of file survey_response.inc.

     {
          $this->last_modified = date('Y-m-d');
          $this->filter = new InclusionFilter("status", "last_modified");
          $this->status = $status;
          $rtn = $this->save();
     }

Survey()

SurveyResponse::Survey

(

)

Definition at line 79 of file survey_response.inc.

     {
          return $this->getRelated(Survey);
     }

SurveyResponse()

SurveyResponse::SurveyResponse

(

)

Definition at line 190 of file survey_response.inc.

     {
          $this->table = "survey_response";
          $this->primary_key = "response_id";
          $this->answer_class = SurveyAnswer;
 
          $this->DataItem(func_get_args());
     }

Member Data Documentation

$fieldAliases

SurveyResponse::$fieldAliases

Initial value:

= array(
               "include_in_results"     =>   "Include in Reslts",
     )

Definition at line 53 of file survey_response.inc.

$fields

SurveyResponse::$fields

Initial value:

= array (
                    "response_id"            =>   Number,
                    "survey_id"                   =>   Number,
                    "token"                       =>   String,
                    "email"                       =>   String,
                    "last_modified"               =>   Date,
                    "status"                 =>   String,
                    "include_in_results"     =>   Boolean,
     )

Definition at line 43 of file survey_response.inc.

$relations

SurveyResponse::$relations

Initial value:

= array (
                    "Questions"                   =>   Questions,
                    "Answers"                =>   SurveyAnswer,
                    "Survey"                 =>   Survey,
     )

Definition at line 57 of file survey_response.inc.

$statusTypes

SurveyResponse::$statusTypes

Initial value:

= array(
          "not_started"  =>   "Not Started",
          "in_progress"  =>   "In Progress",
          "submitted"         =>   "Submitted",
     )

Definition at line 63 of file survey_response.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/survey/datamodel/survey_response.inc