Inheritance diagram for QuestionnaireForm:

Public Member Functions
	QuestionnaireForm ($mgr, $readOnlyForm=false)

	makeSubordinate ($subordinate=true)

	getValidationEngine ()

	button ($text, $url, $confirm=null, $isScript=false)
	Adds a custom button to the form. More...

	drawButtons ()
	Draws any additional buttons specified in the calling script. More...

	getAnswer ($question)

	writeScript ()

	writeHTML ()

	writeOneQuestion ($question)

	fromPOST ()
	Put any updated or new answers in the $_POST array into the array of answers that are indexed by question id so that when we draw the form, the answers are shown, even if page is not reloaded. More...

	drawForm ()

	drawSubmitButtons ($submitLabel)

	drawReadOnly ()

	drawView ()

	getIndexedAnswers ()

	validate ()

	save ()

Static Public Member Functions
static	incrementArray ($array)

Public Attributes
	$mgr

	$questions

	$answers

	$submitLabel = "Save"

	$validators = array()

	$requiredText = "<b>You must answer all required questions.</b><br/>"

	$msg

	$onSaveComplete = null
	Callback event handler that is fired after the AutoForm has finished saving data to the database. More...

	$readOnlyForm
	Specifies whether the entire form is read-only. More...

	$id

	$labelCSS = ""
	CSS Class to use for label cells. More...

	$valueCSS = ""
	CSS Class to use for field/value cells. More...

	$buttonCSS = "button"
	CSS Class to use for buttons. More...

	$inputCSS = ""
	CSS Class to use for input fields. More...

	$checkboxCSS = ""
	CSS Class to use for checkbox fields. More...

	$markRequiredFields = false
	Set to true to add an asterisk after required field labels. More...

	$onFormatLabel = null
	Label Processing hook. More...

	$buttons_at_top = false

	$requiredFieldsText = "* indicates required question"

	$subordinate = false

	$buttons = array()
	The custom buttons collection. More...

	$allowIncompleteSave = true
	Allows users to save partially completed forms. More...

Detailed Description

Definition at line 74 of file questionnaire_form.inc.

Member Function Documentation

◆ button()

QuestionnaireForm::button	(	$text,
		$url,
		$confirm = `null`,
		$isScript = `false`
	)

Adds a custom button to the form.

Parameters

string	$text	the button label text
string	$url	the URL to handle the button press
string	$confirm	optional confirmation message
boolean	$isScript	true if the url is javascript code to execute, false if it is a URL to redirect to

Definition at line 161 of file questionnaire_form.inc.

      {
           $this->buttons[] = array('text' => $text, 'url' => $url, 'confirm' => $confirm, 'isScript' => $isScript);
      }

◆ drawButtons()

QuestionnaireForm::drawButtons ( )

Draws any additional buttons specified in the calling script.

Definition at line 170 of file questionnaire_form.inc.

      {
           foreach($this->buttons as $button)
           {
                $url = ($button['isScript']) ? $button['url'] : "go('{$button['url']}');";
                
                if ($button['confirm'])
                {
                     $link = "if (confirm('".jsSafe($button['confirm'])."')) $url; return false;";
                }
                else
                {
                     $link = "$url; return false;";
                }
  
                echo "&nbsp;&nbsp;&nbsp;&nbsp;<input type='button' class='{$this->buttonCSS}' onclick=\"$link\" value=\"{$button['text']}\"/>";
           }
  
      }

◆ drawForm()

QuestionnaireForm::drawForm ( )

Definition at line 365 of file questionnaire_form.inc.

      {
           if ($this->readOnlyForm) return $this->drawReadOnly();
           
           echo "<div class='questionnaire_form'>";
  
           $submitLabel = $this->submitLabel;
           
           $id = ($this->id) ? $this->id : "Questionnaire_form";
           
           if (!$this->subordinate)
           {
                echo "<form id=\"{$id}\" method=\"POST\" action=\"\" ";
                echo "enctype='multipart/form-data' onsubmit='return onSubmitQuestionnaire_form(this);'>";
           }
           
           if ($this->buttons_at_top && !$this->subordinate)
           {
                $this->drawSubmitButtons($submitLabel);
                $this->drawButtons();
                echo "<br/><br/>";
           }
           
           $this->writeHTML();
  
           if (!$this->subordinate)
           {
                echo "<br/>";
                $this->drawSubmitButtons($submitLabel); 
                $this->drawButtons();
                echo "<br/>";
                echo "</form>";
           }
  
           echo "</div>";
      }

◆ drawReadOnly()

QuestionnaireForm::drawReadOnly ( )

Definition at line 407 of file questionnaire_form.inc.

      {
           $this->writeHTML();
      }

◆ drawSubmitButtons()

QuestionnaireForm::drawSubmitButtons ( $submitLabel )

Definition at line 402 of file questionnaire_form.inc.

      {
           echo "<input type=\"submit\" style=\"float: left\" name=\"save\" class=\"{$this->buttonCSS}\" value=\"&nbsp;&nbsp;{$submitLabel}&nbsp;&nbsp;\"/>";
      }

◆ drawView()

QuestionnaireForm::drawView ( )

Definition at line 413 of file questionnaire_form.inc.

      {
           $this->writeHTML();
      }

◆ fromPOST()

QuestionnaireForm::fromPOST ( )

Put any updated or new answers in the $_POST array into the array of answers that are indexed by question id so that when we draw the form, the answers are shown, even if page is not reloaded.

Also called from function save.

Definition at line 294 of file questionnaire_form.inc.

      {
           global $_POST;
  
           $pk = $this->mgr->item->getPrimaryKey();
           $qPk = $this->mgr->getQuestionKey();
           $aPk = $this->mgr->getAnswerKey();
           $answerClass = $this->mgr->getAnswerClass();
           
           foreach($_POST as $name => $value)
           {              
                if (!strncmp("question_", $name, 9))
                {
                     // convert array of checks to comma delimated string
                     $valueAnswer = (is_array($value)) ? implode(",",  array_values($value)) : $value;
           
                     $question_id = substr($name, 9);
                     
                     if(array_key_exists($question_id, $this->answers))
                     {
                          $this->answers[$question_id]->value = $valueAnswer;
                     }
                     else
                     {
                          $answer = new $answerClass();
                          // e.g., response_id
                          $answer->$pk = $this->mgr->item->$pk;
                          $answer->$qPk = $question_id;
                          $answer->value = $valueAnswer;
                          $this->answers[$question_id] = $answer;
                     }
                }
           }
      
           // Need to handle deleted checkbox answers which don't appear in $_POST
           $questions = $this->mgr->getQuestions();
  
           if(count($questions) > 0)
           {
                $indexed = regroupList($questions, "question_type_id");
                $checkListQuestions = array();
                // CheckListView
                if(array_key_exists(5, $indexed))
                {
                     $checkListQuestions = $indexed[5];
                     if(!is_array($checkListQuestions))
                     {
                          $checkListQuestions = array($checkListQuestions);
                     }
                }
                
                if(count($checkListQuestions) > 0)
                {
                     foreach($checkListQuestions as $question)
                     {
                          $answer = $this->answers[$question->$qPk];
                          if($answer && $answer->value)
                          {
                               $postAnswer = $_POST["question_{$question->$qPk}"];
                               
                               if(!$postAnswer && !is_array($postAnswer))
                               {
                                    $answer->value = "";
                               }
                          }
                     }
                }
           }
                
      }

◆ getAnswer()

QuestionnaireForm::getAnswer ( $question )

Definition at line 189 of file questionnaire_form.inc.

      {
           $qPk = $this->mgr->getQuestionKey();
           $answer = $this->answers[$question->$qPk];
           return ($answer) ? $answer->value : "";
      }

◆ getIndexedAnswers()

QuestionnaireForm::getIndexedAnswers ( )

Definition at line 418 of file questionnaire_form.inc.

      {
           $answers = $this->mgr->getAnswers();
  
           if(count($answers) > 0)
                $answers = reindexList($answers, $this->mgr->getQuestionKey());
                
           return $answers;
      }

◆ getValidationEngine()

QuestionnaireForm::getValidationEngine ( )

Definition at line 147 of file questionnaire_form.inc.

      {
           return $this;
      }

◆ incrementArray()

static QuestionnaireForm::incrementArray ( $array )

static

Definition at line 481 of file questionnaire_form.inc.

      {
           if(count($array) > 0)
           {
                $idx = 0;
                while($idx < (count($array)))
                {
                     $newArray[$idx+1] = $array[$idx];
                     $idx++;
                }
           }
           return $newArray;
      }

◆ makeSubordinate()

QuestionnaireForm::makeSubordinate ( $subordinate = true )

Definition at line 142 of file questionnaire_form.inc.

      {
           $this->subordinate = $subordinate;
      }

◆ QuestionnaireForm()

QuestionnaireForm::QuestionnaireForm	(	$mgr,
		$readOnlyForm = `false`
	)

Definition at line 101 of file questionnaire_form.inc.

      {
           global $auto_form_defaults;
  
           $this->mgr = $mgr;
           $this->readOnlyForm = $readOnlyForm;
  
           foreach($auto_form_defaults as $field => $value)
           {
                $this->$field = $value;
           }
           $this->requiredFieldsText = preg_replace("/field/i", "question", $this->requiredFieldsText);
  
           $questions = $this->mgr->getQuestions();
                
           if(count($questions) > 0)
           {
                $this->answers = $this->getIndexedAnswers();
  
                foreach($questions as $question)
                {
                     $this->questions[] = QuestionField::create($this, $question);
                }
                     
                $num = 1;
                
                foreach($this->questions as $question)
                {
                     if (!$question->skipNumbering)
                     {
                          $question->question->question_number = $num++;
                     }
                     
                     if($question->question->required)
                     {
                          array_push($this->validators, $question->getRequiredValidator());
                     }
                }
           }
      }

◆ save()

QuestionnaireForm::save ( )

Definition at line 444 of file questionnaire_form.inc.

      {
           $this->fromPOST();
           $aPk = $this->mgr->getAnswerKey();
           $qPk = $this->mgr->getQuestionKey();
           
           foreach($this->answers as $question_id => $answer)
           {
                // If saved answer, just update value
                if($answer->$aPk)
                {
                     $answer->filter = new InclusionFilter("value");
                }
                // new answer - save all fields
                $answer->save();
           }
           
           // Even if invalid, we still want to save their answers
           $this->msg = $this->validate();
           if ($this->msg != "")
           {
                return false;
           }
  
           // onComplete event is fired once all processing has been completed
           if ($this->onSaveComplete)
           {
                $onComplete = $this->onSaveComplete;
                $onComplete($this);
           }
  
           return true;
  
      }

◆ validate()

QuestionnaireForm::validate ( )

Definition at line 429 of file questionnaire_form.inc.

      {
           foreach($this->validators as $validator)
           {
                $msg = $validator->validate();
                if ($msg)
                {
                     $result .= $msg."<br>";
                }
           }
           $this->msg = $msg;
           return $result;
      }

◆ writeHTML()

QuestionnaireForm::writeHTML ( )

Reimplemented in QuizForm.

Definition at line 235 of file questionnaire_form.inc.

      {
           if(count($this->questions) == 0)
           {
                echo "There are no questions.<br/>";
                return;
           }
  
           if($this->requiredText)
           {
                if ($this->msg)
                {
                     echo "<tr>\n <td colspan='2'><span class='error'>{$this->msg}</span</td></tr>\n";
                     $this->msg = "";
                     echo "</span>\n";
                }
                echo $this->requiredText;
           }
  
           echo "<b>{$this->requiredFieldsText}</b><br/><br/>";
  
           echo "<dl>\n";
           
           foreach($this->questions as $question)
           {
                $this->writeOneQuestion($question);
           }
  
           echo "</dl>\n";
      }

◆ writeOneQuestion()

QuestionnaireForm::writeOneQuestion ( $question )

Reimplemented in QuizForm, QuestionnaireResponseView, and QuestionnairePreview.

Definition at line 266 of file questionnaire_form.inc.

      {
           $required = $question->getRequired();
           $qPk = $question->getID();
           $num = ($question->question->question_number) ? $question->question->question_number : $this->mgr->getQuestionNumber();
  
           echo " <dt><label for='question_{$qPk}'>";
           
           if (!$question->skipNumbering)
           {
                echo "<b>{$num}.</b> ";
           }
           
           echo "{$question->question->question}{$required}</label></dt>\n";
  
           echo " <dd>";
  
           $question->writeHTML();
      
           echo " <br/></dd>";
      }

◆ writeScript()

QuestionnaireForm::writeScript ( )

Reimplemented in QuestionnairePreview.

Definition at line 196 of file questionnaire_form.inc.

      {
           $script = "";
  
           if(count($this->questions) == 0)
                return;
                
           foreach($this->questions as $question)
           {
                $script .= $question->writeScript();
           }
  
  
           $script .= "function validate_Questionnaire_form(form)\n";
           $script .= "{";
  
           foreach($this->validators as $validator)
           {
                $script .= $validator->writeClient();
           }
           
           $script .= "\n\n return true;\n}";
           $script .= "\n\n";
           $script .= "function onSubmitQuestionnaire_form(form)\n{\n";
  
           if ($this->allowIncompleteSave)
           {
                // return true because we need to save their answers, even if they
                // didn't answer all questions (invalid form)
                $script .= "\t validate_Questionnaire_form(form); return true\n}";
           }
           else
           {
                $script .= "\t return validate_Questionnaire_form(form);\n}";
           }
           if ($script) $script = "<script type='text/javascript'>\n$script\n</script>";
           return $script;
      }

Member Data Documentation

◆ $allowIncompleteSave

QuestionnaireForm::$allowIncompleteSave = true

Allows users to save partially completed forms.

Definition at line 99 of file questionnaire_form.inc.

◆ $answers

QuestionnaireForm::$answers

Definition at line 78 of file questionnaire_form.inc.

◆ $buttonCSS

QuestionnaireForm::$buttonCSS = "button"

CSS Class to use for buttons.

Definition at line 90 of file questionnaire_form.inc.

◆ $buttons

QuestionnaireForm::$buttons = array()

The custom buttons collection.

Definition at line 98 of file questionnaire_form.inc.

◆ $buttons_at_top

QuestionnaireForm::$buttons_at_top = false

Definition at line 95 of file questionnaire_form.inc.

◆ $checkboxCSS

QuestionnaireForm::$checkboxCSS = ""

CSS Class to use for checkbox fields.

Definition at line 92 of file questionnaire_form.inc.

◆ $id

QuestionnaireForm::$id

Definition at line 85 of file questionnaire_form.inc.

◆ $inputCSS

QuestionnaireForm::$inputCSS = ""

CSS Class to use for input fields.

Definition at line 91 of file questionnaire_form.inc.

◆ $labelCSS

QuestionnaireForm::$labelCSS = ""

CSS Class to use for label cells.

Definition at line 88 of file questionnaire_form.inc.

◆ $markRequiredFields

QuestionnaireForm::$markRequiredFields = false

Set to true to add an asterisk after required field labels.

Definition at line 93 of file questionnaire_form.inc.

◆ $mgr

QuestionnaireForm::$mgr

Definition at line 76 of file questionnaire_form.inc.

◆ $msg

QuestionnaireForm::$msg

Definition at line 82 of file questionnaire_form.inc.

◆ $onFormatLabel

QuestionnaireForm::$onFormatLabel = null

Label Processing hook.

Definition at line 94 of file questionnaire_form.inc.

◆ $onSaveComplete

QuestionnaireForm::$onSaveComplete = null

Callback event handler that is fired after the AutoForm has finished saving data to the database.

Definition at line 83 of file questionnaire_form.inc.

◆ $questions

QuestionnaireForm::$questions

Definition at line 77 of file questionnaire_form.inc.

◆ $readOnlyForm

QuestionnaireForm::$readOnlyForm

Specifies whether the entire form is read-only.

Definition at line 84 of file questionnaire_form.inc.

◆ $requiredFieldsText

QuestionnaireForm::$requiredFieldsText = "* indicates required question"

Definition at line 96 of file questionnaire_form.inc.

◆ $requiredText

QuestionnaireForm::$requiredText = "<b>You must answer all required questions.</b><br/>"

Definition at line 81 of file questionnaire_form.inc.

◆ $submitLabel

QuestionnaireForm::$submitLabel = "Save"

Definition at line 79 of file questionnaire_form.inc.

◆ $subordinate

QuestionnaireForm::$subordinate = false

Definition at line 97 of file questionnaire_form.inc.

◆ $validators

QuestionnaireForm::$validators = array()

Definition at line 80 of file questionnaire_form.inc.

◆ $valueCSS

QuestionnaireForm::$valueCSS = ""

CSS Class to use for field/value cells.

Definition at line 89 of file questionnaire_form.inc.

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

C:/code/cms.sonjara.com/cms/components/questionnaire/questionnaire_form.inc

Public Member Functions

Static Public Member Functions

Public Attributes