Skip to content

Commit

Permalink
Merge branch 'MDL-30453-exassessment-link' of git://github.com/mudrd8…
Browse files Browse the repository at this point in the history 
…mz/moodle
  • Loading branch information
Sam Hemelryk committed Nov 30, 2011
2 parents fa6765c + cdc8577 commit c9c7b8f
Show file tree
Hide file tree
Showing 5 changed files with 199 additions and 12 deletions.
8 changes: 3 additions & 5 deletions mod/workshop/exassessment.php
View file
Expand Up @@ -127,9 +127,8 @@
'showreviewer' => false,
'showauthor' => false,
'showform' => true,
'showweight' => false,
);
$assessment = $workshop->prepare_assessment($assessment, $mform, $options);
$assessment = $workshop->prepare_example_reference_assessment($assessment, $mform, $options);
$assessment->title = get_string('assessmentreference', 'workshop');
echo $output->render($assessment);

Expand All @@ -138,9 +137,8 @@
'showreviewer' => true,
'showauthor' => false,
'showform' => true,
'showweight' => false,
);
$assessment = $workshop->prepare_assessment($assessment, $mform, $options);
$assessment = $workshop->prepare_example_assessment($assessment, $mform, $options);
$assessment->title = get_string('assessmentbyyourself', 'workshop');
echo $output->render($assessment);

Expand All @@ -151,7 +149,7 @@
'showform' => true,
'showweight' => false,
);
$assessment = $workshop->prepare_assessment($assessment, $mform, $options);
$assessment = $workshop->prepare_example_assessment($assessment, $mform, $options);
echo $output->render($assessment);
}

Expand Down
12 changes: 6 additions & 6 deletions mod/workshop/excompare.php
View file
Expand Up @@ -84,10 +84,12 @@
'showreviewer' => false,
'showauthor' => false,
'showform' => true,
'showweight' => false,
);
$reference = $workshop->prepare_assessment($reference, $mformreference, $options);
$reference = $workshop->prepare_example_reference_assessment($reference, $mformreference, $options);
$reference->title = get_string('assessmentreference', 'workshop');
if ($canmanage) {
$reference->url = $workshop->exassess_url($reference->id);
}
echo $output->render($reference);
}

Expand All @@ -96,9 +98,8 @@
'showreviewer' => true,
'showauthor' => false,
'showform' => true,
'showweight' => false,
);
$assessment = $workshop->prepare_assessment($assessment, $mformassessment, $options);
$assessment = $workshop->prepare_example_assessment($assessment, $mformassessment, $options);
$assessment->title = get_string('assessmentbyyourself', 'workshop');
if ($workshop->assessing_examples_allowed()) {
$assessment->add_action(
Expand All @@ -113,9 +114,8 @@
'showreviewer' => true,
'showauthor' => false,
'showform' => true,
'showweight' => false,
);
$assessment = $workshop->prepare_assessment($assessment, $mformassessment, $options);
$assessment = $workshop->prepare_example_assessment($assessment, $mformassessment, $options);
echo $output->render($assessment);
}

Expand Down
119 changes: 119 additions & 0 deletions mod/workshop/locallib.php
View file
Expand Up @@ -713,6 +713,7 @@ public function prepare_example_summary(stdClass $example) {
* showauthor - should the author user info be available for the renderer
* showreviewer - should the reviewer user info be available for the renderer
* showform - show the assessment form if it is available
* showweight - should the assessment weight be available for the renderer
*
* @param stdClass $record as returned by eg {@link self::get_assessment_by_id()}
* @param workshop_assessment_form|null $form as returned by {@link workshop_strategy::get_assessment_form()}
Expand Down Expand Up @@ -744,6 +745,77 @@ public function prepare_assessment(stdClass $record, $form, array $options = arr
return $assessment;
}

/**
* Prepares renderable example submission's assessment component
*
* The $options array supports the following keys:
* showauthor - should the author user info be available for the renderer
* showreviewer - should the reviewer user info be available for the renderer
* showform - show the assessment form if it is available
*
* @param stdClass $record as returned by eg {@link self::get_assessment_by_id()}
* @param workshop_assessment_form|null $form as returned by {@link workshop_strategy::get_assessment_form()}
* @param array $options
* @return workshop_example_assessment
*/
public function prepare_example_assessment(stdClass $record, $form = null, array $options = array()) {

$assessment = new workshop_example_assessment($record, $options);
$assessment->url = $this->exassess_url($record->id);
$assessment->maxgrade = $this->real_grade(100);

if (!empty($options['showform']) and !($form instanceof workshop_assessment_form)) {
debugging('Not a valid instance of workshop_assessment_form supplied', DEBUG_DEVELOPER);
}

if (!empty($options['showform']) and ($form instanceof workshop_assessment_form)) {
$assessment->form = $form;
}

if (!is_null($record->grade)) {
$assessment->realgrade = $this->real_grade($record->grade);
}

$assessment->weight = null;

return $assessment;
}

/**
* Prepares renderable example submission's reference assessment component
*
* The $options array supports the following keys:
* showauthor - should the author user info be available for the renderer
* showreviewer - should the reviewer user info be available for the renderer
* showform - show the assessment form if it is available
*
* @param stdClass $record as returned by eg {@link self::get_assessment_by_id()}
* @param workshop_assessment_form|null $form as returned by {@link workshop_strategy::get_assessment_form()}
* @param array $options
* @return workshop_example_reference_assessment
*/
public function prepare_example_reference_assessment(stdClass $record, $form = null, array $options = array()) {

$assessment = new workshop_example_reference_assessment($record, $options);
$assessment->maxgrade = $this->real_grade(100);

if (!empty($options['showform']) and !($form instanceof workshop_assessment_form)) {
debugging('Not a valid instance of workshop_assessment_form supplied', DEBUG_DEVELOPER);
}

if (!empty($options['showform']) and ($form instanceof workshop_assessment_form)) {
$assessment->form = $form;
}

if (!is_null($record->grade)) {
$assessment->realgrade = $this->real_grade($record->grade);
}

$assessment->weight = null;

return $assessment;
}

/**
* Removes the submission and all relevant data
*
Expand Down Expand Up @@ -2713,6 +2785,8 @@ abstract class workshop_assessment_base {
*/
public function __construct(stdClass $record, array $options = array()) {

$this->validate_raw_record($record);

foreach ($this->fields as $field) {
if (!property_exists($record, $field)) {
throw new coding_exception('Assessment record must provide public property ' . $field);
Expand Down Expand Up @@ -2748,6 +2822,16 @@ public function add_action(moodle_url $url, $label, $method = 'get') {

$this->actions[] = $action;
}

/**
* Makes sure that we can cook the renderable component from the passed raw database record
*
* @param stdClass $assessment full assessment record
* @throws coding_exception if the caller passed unexpected data
*/
protected function validate_raw_record(stdClass $record) {
// nothing to do here
}
}


Expand Down Expand Up @@ -2785,6 +2869,41 @@ class workshop_assessment extends workshop_assessment_base implements renderable
'timemodified', 'grade', 'gradinggrade', 'gradinggradeover');
}


/**
* Represents a renderable training assessment of an example submission
*/
class workshop_example_assessment extends workshop_assessment implements renderable {

/**
* @see parent::validate_raw_record()
*/
protected function validate_raw_record(stdClass $record) {
if ($record->weight != 0) {
throw new coding_exception('Invalid weight of example submission assessment');
}
parent::validate_raw_record($record);
}
}


/**
* Represents a renderable reference assessment of an example submission
*/
class workshop_example_reference_assessment extends workshop_assessment implements renderable {

/**
* @see parent::validate_raw_record()
*/
protected function validate_raw_record(stdClass $record) {
if ($record->weight != 1) {
throw new coding_exception('Invalid weight of the reference example submission assessment');
}
parent::validate_raw_record($record);
}
}


/**
* Renderable message to be displayed to the user
*
Expand Down
22 changes: 21 additions & 1 deletion mod/workshop/renderer.php
View file
Expand Up @@ -565,7 +565,7 @@ protected function render_workshop_assessment(workshop_assessment $assessment) {
} else {
$title = get_string('assessment', 'workshop');
}
if ($this->page->url != $assessment->url) {
if (($assessment->url instanceof moodle_url) and ($this->page->url != $assessment->url)) {
$o .= $this->output->container(html_writer::link($assessment->url, $title), 'title');
} else {
$o .= $this->output->container($title, 'title');
Expand Down Expand Up @@ -629,6 +629,26 @@ protected function render_workshop_assessment(workshop_assessment $assessment) {
return $o;
}

/**
* Renders the assessment of an example submission
*
* @param workshop_example_assessment $assessment
* @return string HTML
*/
protected function render_workshop_example_assessment(workshop_example_assessment $assessment) {
return $this->render_workshop_assessment($assessment);
}

/**
* Renders the reference assessment of an example submission
*
* @param workshop_example_reference_assessment $assessment
* @return string HTML
*/
protected function render_workshop_example_reference_assessment(workshop_example_reference_assessment $assessment) {
return $this->render_workshop_assessment($assessment);
}

////////////////////////////////////////////////////////////////////////////
// Internal rendering helper methods
////////////////////////////////////////////////////////////////////////////
Expand Down
50 changes: 50 additions & 0 deletions mod/workshop/simpletest/testlocallib.php
View file
Expand Up @@ -374,4 +374,54 @@ public function test_lcm_array() {
// verify
$this->assertEqual($lcm, 15);
}

public function test_prepare_example_assessment() {
// fixture setup
$fakerawrecord = (object)array(
'id' => 42,
'submissionid' => 56,
'weight' => 0,
'timecreated' => time() - 10,
'timemodified' => time() - 5,
'grade' => null,
'gradinggrade' => null,
'gradinggradeover' => null,
);
// excersise SUT
$a = $this->workshop->prepare_example_assessment($fakerawrecord);
// verify
$this->assertTrue($a instanceof workshop_example_assessment);
$this->assertTrue($a->url instanceof moodle_url);

// modify setup
$fakerawrecord->weight = 1;
$this->expectException('coding_exception');
// excersise SUT
$a = $this->workshop->prepare_example_assessment($fakerawrecord);
}

public function test_prepare_example_reference_assessment() {
global $USER;
// fixture setup
$fakerawrecord = (object)array(
'id' => 38,
'submissionid' => 56,
'weight' => 1,
'timecreated' => time() - 100,
'timemodified' => time() - 50,
'grade' => 0.75000,
'gradinggrade' => 1.00000,
'gradinggradeover' => null,
);
// excersise SUT
$a = $this->workshop->prepare_example_reference_assessment($fakerawrecord);
// verify
$this->assertTrue($a instanceof workshop_example_reference_assessment);

// modify setup
$fakerawrecord->weight = 0;
$this->expectException('coding_exception');
// excersise SUT
$a = $this->workshop->prepare_example_reference_assessment($fakerawrecord);
}
}

0 comments on commit c9c7b8f

Please sign in to comment.