[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/question/engine/tests/ -> helpers.php (summary)

This file contains helper classes for testing the question engine.

Copyright: 2009 The Open University
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 1244 lines (47 kb)
Included or required: 35 times
Referenced: 39 times
Includes or requires: 1 file
 question/engine/lib.php

Defines 12 classes

testable_question_attempt:: (4 methods):
  add_step()
  set_min_fraction()
  set_max_fraction()
  set_behaviour()

testable_question_engine_unit_of_work:: (9 methods):
  get_modified()
  get_attempts_added()
  get_attempts_modified()
  get_steps_added()
  get_steps_modified()
  get_steps_deleted()
  get_metadata_added()
  get_metadata_modified()
  get_question_editing_form()

test_question_maker:: (17 methods):
  get_a_qa()
  initialise_a_question()
  initialise_question_data()
  get_test_helper()
  call_question_helper_method()
  make_question()
  get_question_data()
  get_question_form_data()
  make_a_multichoice_single_question()
  make_a_multichoice_multi_question()
  make_a_matching_question()
  make_an_essay_question()
  set_standard_combined_feedback_fields()
  set_standard_combined_feedback_form_data()
  build_db_records()
  build_db_records()
  assert()

question_contains_tag_with_contents:: (1 method):
  __construct()

question_check_specified_fields_expectation:: (1 method):
  __construct()

question_contains_select_expectation:: (1 method):
  __construct()

question_does_not_contain_tag_with_attributes:: (1 method):
  __construct()

question_contains_tag_with_attribute:: (1 method):
  __construct()

question_contains_tag_with_attributes:: (1 method):
  __construct()

question_pattern_expectation:: (1 method):
  __construct()

question_no_pattern_expectation:: (66 methods):
  __construct()
  setUp()
  tearDown()
  start_attempt_at_question()
  response_data_to_post()
  process_submission()
  process_autosave()
  finish()
  manual_grade()
  save_quba()
  load_quba()
  delete_quba()
  check_current_state()
  check_current_mark()
  render()
  check_output_contains_text_input()
  check_output_contains_text_input_with_class()
  check_output_does_not_contain_text_input_with_class()
  check_output_contains_hidden_input()
  check_output_contains()
  check_output_does_not_contain()
  check_output_contains_lang_string()
  get_tag_matcher()
  check_current_output()
  get_question_attempt()
  get_step_count()
  check_step_count()
  get_step()
  get_contains_question_text_expectation()
  get_contains_general_feedback_expectation()
  get_does_not_contain_correctness_expectation()
  get_contains_correct_expectation()
  get_contains_partcorrect_expectation()
  get_contains_incorrect_expectation()
  get_contains_standard_correct_combined_feedback_expectation()
  get_contains_standard_partiallycorrect_combined_feedback_expectation()
  get_contains_standard_incorrect_combined_feedback_expectation()
  get_does_not_contain_feedback_expectation()
  get_does_not_contain_num_parts_correct()
  get_contains_num_parts_correct()
  get_does_not_contain_specific_feedback_expectation()
  get_contains_validation_error_expectation()
  get_does_not_contain_validation_error_expectation()
  get_contains_mark_summary()
  get_contains_marked_out_of_summary()
  get_does_not_contain_mark_summary()
  get_contains_checkbox_expectation()
  get_contains_mc_checkbox_expectation()
  get_contains_radio_expectation()
  get_contains_mc_radio_expectation()
  get_contains_hidden_expectation()
  get_does_not_contain_hidden_expectation()
  get_contains_tf_true_radio_expectation()
  get_contains_tf_false_radio_expectation()
  get_contains_cbm_radio_expectation()
  get_contains_button_expectation()
  get_contains_submit_button_expectation()
  get_does_not_contain_submit_button_expectation()
  get_tries_remaining_expectation()
  get_invalid_answer_expectation()
  get_contains_try_again_button_expectation()
  get_does_not_contain_try_again_button_expectation()
  get_contains_select_expectation()
  get_mc_right_answer_index()
  get_no_hint_visible_expectation()
  get_contains_hint_expectation()

question_test_recordset:: (7 methods):
  __construct()
  __destruct()
  current()
  key()
  next()
  valid()
  close()


Class: testable_question_attempt  - X-Ref

Makes some protected methods of question_attempt public to facilitate testing.

add_step(question_attempt_step $step)   X-Ref
No description

set_min_fraction($fraction)   X-Ref
No description

set_max_fraction($fraction)   X-Ref
No description

set_behaviour(question_behaviour $behaviour)   X-Ref
No description

Class: testable_question_engine_unit_of_work  - X-Ref

Test subclass to allow access to some protected data so that the correct
behaviour can be verified.

get_modified()   X-Ref
No description

get_attempts_added()   X-Ref
No description

get_attempts_modified()   X-Ref
No description

get_steps_added()   X-Ref
No description

get_steps_modified()   X-Ref
No description

get_steps_deleted()   X-Ref
No description

get_metadata_added()   X-Ref
No description

get_metadata_modified()   X-Ref
No description

get_question_editing_form($cat, $questiondata)   X-Ref
Set up a form to create a question in $cat. This method also sets cat and contextid on $questiondata object.

param: object $cat the category
param: object $questiondata form initialisation requires question data.
return: moodleform

Class: test_question_maker  - X-Ref

This class creates questions of various types, which can then be used when
testing.

get_a_qa($question, $maxmark = 3)   X-Ref
Just make a question_attempt at a question. Useful for unit tests that
need to pass a $qa to methods that call format_text. Probably not safe
to use for anything beyond that.

param: question_definition $question a question.
param: number $maxmark the max mark to set.
return: question_attempt the question attempt.

initialise_a_question($q)   X-Ref
Initialise the common fields of a question of any type.


initialise_question_data($qdata)   X-Ref
No description

get_test_helper($qtype)   X-Ref
Get the test helper class for a particular question type.

param: $qtype the question type name, e.g. 'multichoice'.
return: question_test_helper the test helper class.

call_question_helper_method($methodtemplate, $qtype, $which = null)   X-Ref
Call a method on a qtype_{$qtype}_test_helper class and return the result.

param: string $methodtemplate e.g. 'make_{qtype}_question_{which}';
param: string $qtype the question type to get a test question for.
param: string $which one of the names returned by the get_test_questions
param: unknown_type $which

make_question($qtype, $which = null)   X-Ref
Question types can provide a number of test question defintions.
They do this by creating a qtype_{$qtype}_test_helper class that extends
question_test_helper. The get_test_questions method returns the list of
test questions available for this question type.

param: string $qtype the question type to get a test question for.
param: string $which one of the names returned by the get_test_questions
return: question_definition the requested question object.

get_question_data($qtype, $which = null)   X-Ref
Like {@link make_question()} but returns the datastructure from
get_question_options instead of the question_definition object.

param: string $qtype the question type to get a test question for.
param: string $which one of the names returned by the get_test_questions
return: stdClass the requested question object.

get_question_form_data($qtype, $which = null)   X-Ref
Like {@link make_question()} but returns the data what would be saved from
the question editing form instead of the question_definition object.

param: string $qtype the question type to get a test question for.
param: string $which one of the names returned by the get_test_questions
return: stdClass the requested question object.

make_a_multichoice_single_question()   X-Ref
Makes a multichoice question with choices 'A', 'B' and 'C' shuffled. 'A'
is correct, defaultmark 1.

return: qtype_multichoice_single_question

make_a_multichoice_multi_question()   X-Ref
Makes a multichoice question with choices 'A', 'B', 'C' and 'D' shuffled.
'A' and 'C' is correct, defaultmark 1.

return: qtype_multichoice_multi_question

make_a_matching_question()   X-Ref
Makes a matching question to classify 'Dog', 'Frog', 'Toad' and 'Cat' as
'Mammal', 'Amphibian' or 'Insect'.
defaultmark 1. Stems are shuffled by default.

return: qtype_match_question

make_an_essay_question()   X-Ref
Makes a truefalse question with correct ansewer true, defaultmark 1.

return: qtype_essay_question

set_standard_combined_feedback_fields($q)   X-Ref
Add some standard overall feedback to a question. You need to use these
specific feedback strings for the corresponding contains_..._feedback
methods in {@link qbehaviour_walkthrough_test_base} to works.

param: question_definition $q the question to add the feedback to.

set_standard_combined_feedback_form_data($form)   X-Ref
Add some standard overall feedback to a question's form data.


build_db_records(array $table)   X-Ref
Helper for tests that need to simulate records loaded from the database.


build_db_records(array $table)   X-Ref
Helper base class for tests that need to simulate records loaded from the
database.


assert($expectation, $compare, $notused = '')   X-Ref
No description

Class: question_contains_tag_with_contents  - X-Ref

__construct($tag, $content, $message = '')   X-Ref
No description

Class: question_check_specified_fields_expectation  - X-Ref

__construct($expected, $message = '')   X-Ref
No description

Class: question_contains_select_expectation  - X-Ref

__construct($name, $choices, $selected = null, $enabled = null, $message = '')   X-Ref
No description

Class: question_does_not_contain_tag_with_attributes  - X-Ref

__construct($tag, $attributes, $message = '')   X-Ref
No description

Class: question_contains_tag_with_attribute  - X-Ref

__construct($tag, $attribute, $value, $message = '')   X-Ref
No description

Class: question_contains_tag_with_attributes  - X-Ref

__construct($tag, $expectedvalues, $forbiddenvalues=array()   X-Ref
No description

Class: question_pattern_expectation  - X-Ref

__construct($pattern, $message = '')   X-Ref
No description

Class: question_no_pattern_expectation  - X-Ref

__construct($pattern, $message = '')   X-Ref
No description

setUp()   X-Ref


tearDown()   X-Ref
No description

start_attempt_at_question($question, $preferredbehaviour,$maxmark = null, $variant = 1)   X-Ref
No description

response_data_to_post($data)   X-Ref
Convert an array of data destined for one question to the equivalent POST data.

param: array $data the data for the quetsion.
return: array the complete post data.

process_submission($data)   X-Ref
No description

process_autosave($data)   X-Ref
No description

finish()   X-Ref
No description

manual_grade($comment, $mark, $commentformat = null)   X-Ref
No description

save_quba(moodle_database $db = null)   X-Ref
No description

load_quba(moodle_database $db = null)   X-Ref
No description

delete_quba()   X-Ref
No description

check_current_state($state)   X-Ref
No description

check_current_mark($mark)   X-Ref
No description

render()   X-Ref
Generate the HTML rendering of the question in its current state in
$this->currentoutput so that it can be verified.


check_output_contains_text_input($name, $value = null, $enabled = true)   X-Ref
No description

check_output_contains_text_input_with_class($name, $class = null)   X-Ref
No description

check_output_does_not_contain_text_input_with_class($name, $class = null)   X-Ref
No description

check_output_contains_hidden_input($name, $value)   X-Ref
No description

check_output_contains($string)   X-Ref
No description

check_output_does_not_contain($string)   X-Ref
No description

check_output_contains_lang_string($identifier, $component = '', $a = null)   X-Ref
No description

get_tag_matcher($tag, $attributes)   X-Ref
No description

check_current_output()   X-Ref

param: $condition one or more Expectations. (users varargs).

get_question_attempt()   X-Ref
No description

get_step_count()   X-Ref
No description

check_step_count($expectednumsteps)   X-Ref
No description

get_step($stepnum)   X-Ref
No description

get_contains_question_text_expectation($question)   X-Ref
No description

get_contains_general_feedback_expectation($question)   X-Ref
No description

get_does_not_contain_correctness_expectation()   X-Ref
No description

get_contains_correct_expectation()   X-Ref
No description

get_contains_partcorrect_expectation()   X-Ref
No description

get_contains_incorrect_expectation()   X-Ref
No description

get_contains_standard_correct_combined_feedback_expectation()   X-Ref
No description

get_contains_standard_partiallycorrect_combined_feedback_expectation()   X-Ref
No description

get_contains_standard_incorrect_combined_feedback_expectation()   X-Ref
No description

get_does_not_contain_feedback_expectation()   X-Ref
No description

get_does_not_contain_num_parts_correct()   X-Ref
No description

get_contains_num_parts_correct($num)   X-Ref
No description

get_does_not_contain_specific_feedback_expectation()   X-Ref
No description

get_contains_validation_error_expectation()   X-Ref
No description

get_does_not_contain_validation_error_expectation()   X-Ref
No description

get_contains_mark_summary($mark)   X-Ref
No description

get_contains_marked_out_of_summary()   X-Ref
No description

get_does_not_contain_mark_summary()   X-Ref
No description

get_contains_checkbox_expectation($baseattr, $enabled, $checked)   X-Ref
No description

get_contains_mc_checkbox_expectation($index, $enabled = null,$checked = null)   X-Ref
No description

get_contains_radio_expectation($baseattr, $enabled, $checked)   X-Ref
No description

get_contains_mc_radio_expectation($index, $enabled = null, $checked = null)   X-Ref
No description

get_contains_hidden_expectation($name, $value = null)   X-Ref
No description

get_does_not_contain_hidden_expectation($name, $value = null)   X-Ref
No description

get_contains_tf_true_radio_expectation($enabled = null, $checked = null)   X-Ref
No description

get_contains_tf_false_radio_expectation($enabled = null, $checked = null)   X-Ref
No description

get_contains_cbm_radio_expectation($certainty, $enabled = null,$checked = null)   X-Ref
No description

get_contains_button_expectation($name, $value = null, $enabled = null)   X-Ref
No description

get_contains_submit_button_expectation($enabled = null)   X-Ref
Returns an epectation that a string contains the HTML of a button with
name {question-attempt prefix}-submit, and eiter enabled or not.

param: bool $enabled if not null, check the enabled/disabled state of the button. True = enabled.
return: question_contains_tag_with_attributes an expectation for use with check_current_output.

get_does_not_contain_submit_button_expectation()   X-Ref
Returns an epectation that a string does not contain the HTML of a button with
name {question-attempt prefix}-submit.

return: question_contains_tag_with_attributes an expectation for use with check_current_output.

get_tries_remaining_expectation($n)   X-Ref
No description

get_invalid_answer_expectation()   X-Ref
No description

get_contains_try_again_button_expectation($enabled = null)   X-Ref
No description

get_does_not_contain_try_again_button_expectation()   X-Ref
No description

get_contains_select_expectation($name, $choices,$selected = null, $enabled = null)   X-Ref
No description

get_mc_right_answer_index($mc)   X-Ref
No description

get_no_hint_visible_expectation()   X-Ref
No description

get_contains_hint_expectation($hinttext)   X-Ref
No description

Class: question_test_recordset  - X-Ref

Simple class that implements the {@link moodle_recordset} API based on an
array of test data.

See the {@link question_attempt_step_db_test} class in
question/engine/tests/testquestionattemptstep.php for an example of how
this is used.

__construct(array $table)   X-Ref
Constructor

param: $table as for {@link testing_db_record_builder::build_db_records()}

__destruct()   X-Ref
No description

current()   X-Ref
No description

key()   X-Ref
No description

next()   X-Ref
No description

valid()   X-Ref
No description

close()   X-Ref
No description



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1