' .
+ if (!$renderforajax) {
+
+ $output .= '
+
' .
$this->pix_icon('i/loading', get_string('loading', 'admin'), 'moodle',
- array('class' => 'loading-icon')) . '
+ ['class' => 'loading-icon']) . '
';
}
// Finish step.
$url = new moodle_url('/blocks/workflow/finishstep.php',
- array('stateid' => $state->id));
+ ['stateid' => $state->id]);
$finishbutton = new single_button($url, get_string('finishstep', 'block_workflow'), 'get');
$finishbutton->class = 'singlebutton block_workflow_finishstepbutton';
@@ -175,8 +161,8 @@ public function block_display(block_workflow_step_state $state, $ajax = false) {
* @return string HTML of the button.
*/
public function workflow_overview_button($contextid, $workflowid) {
- $url = new moodle_url('/blocks/workflow/overview.php', array(
- 'contextid' => $contextid, 'workflowid' => $workflowid));
+ $url = new moodle_url('/blocks/workflow/overview.php', [
+ 'contextid' => $contextid, 'workflowid' => $workflowid]);
$overviewbutton = new single_button($url,
get_string('workflowoverview', 'block_workflow'), 'get');
return html_writer::tag('div', $this->output->render($overviewbutton));
@@ -192,7 +178,7 @@ public function workflow_overview_button($contextid, $workflowid) {
*/
public function block_display_todo_item($todo, $stateid, $editable) {
global $CFG;
- $todoattribs = array();
+ $todoattribs = [];
// The contents of the list item.
$text = format_string($todo->task);
@@ -206,9 +192,9 @@ public function block_display_todo_item($todo, $stateid, $editable) {
// Generate the URL and Link.
$returnurl = str_replace($CFG->wwwroot, '', $this->page->url->out(false));
$url = new moodle_url('/blocks/workflow/toggletaskdone.php',
- array('sesskey' => sesskey(), 'stateid' => $stateid, 'todoid' => $todo->id, 'returnurl' => $returnurl));
+ ['sesskey' => sesskey(), 'stateid' => $stateid, 'todoid' => $todo->id, 'returnurl' => $returnurl]);
$li = html_writer::tag('li', html_writer::link($url, $text,
- array('class' => 'block-workflow-todotask', 'id' => 'block-workflow-todoid-' . $todo->id)),
+ ['class' => 'block-workflow-todotask', 'id' => 'block-workflow-todoid-' . $todo->id]),
$todoattribs);
} else {
$li = html_writer::tag('li', $text, $todoattribs);
@@ -227,7 +213,7 @@ public function block_display_todo_item($todo, $stateid, $editable) {
* @return string the HTML to output.
*/
public function block_display_no_more_steps($parentcontextid,
- $canadd, array $addableworkflows, array $previous = null) {
+ $canadd, array $addableworkflows, ?array $previous = null) {
$output = '';
if ($previous) {
@@ -247,9 +233,9 @@ public function block_display_no_more_steps($parentcontextid,
if ($addableworkflows) {
$url = new moodle_url('/blocks/workflow/addworkflow.php',
- array('sesskey' => sesskey(), 'contextid' => $parentcontextid));
+ ['sesskey' => sesskey(), 'contextid' => $parentcontextid]);
- $addoptions = array();
+ $addoptions = [];
foreach ($addableworkflows as $wf) {
$addoptions[$wf->id] = $wf->name;
}
@@ -314,9 +300,9 @@ protected function list_workflows($workflows) {
// Display the current workflows.
$table = new html_table();
$table->attributes['class'] = '';
- $table->head = array();
- $table->colclasses = array();
- $table->data = array();
+ $table->head = [];
+ $table->colclasses = [];
+ $table->data = [];
$table->head[] = get_string('shortname', 'block_workflow');
$table->head[] = get_string('name', 'block_workflow');
$table->head[] = get_string('appliesto', 'block_workflow');
@@ -331,25 +317,29 @@ protected function list_workflows($workflows) {
// Create a new workflow.
$emptycell = new html_table_cell();
$emptycell->colspan = 3;
- $actions = array();
- $add = html_writer::empty_tag('img', array('src' => $this->output->image_url('t/add'),
- 'class' => 'iconsmall',
- 'title' => get_string('createworkflow', 'block_workflow'),
- 'alt' => get_string('createworkflow', 'block_workflow')
- ));
+ $actions = [];
+ $add = html_writer::empty_tag('img',
+ [
+ 'src' => $this->output->image_url('t/add'),
+ 'class' => 'iconsmall icon',
+ 'title' => get_string('createworkflow', 'block_workflow'),
+ 'alt' => get_string('createworkflow', 'block_workflow'),
+ ]);
$url = new moodle_url('/blocks/workflow/editsettings.php');
$actions[] = html_writer::link($url, $add);
- $add = html_writer::empty_tag('img', array('src' => $this->output->image_url('t/restore'),
- 'class' => 'iconsmall',
- 'title' => get_string('importworkflow', 'block_workflow'),
- 'alt' => get_string('importworkflow', 'block_workflow')
- ));
+ $add = html_writer::empty_tag('img',
+ [
+ 'src' => $this->output->image_url('t/restore'),
+ 'class' => 'iconsmall icon',
+ 'title' => get_string('importworkflow', 'block_workflow'),
+ 'alt' => get_string('importworkflow', 'block_workflow'),
+ ]);
$url = new moodle_url('/blocks/workflow/import.php');
$actions[] = html_writer::link($url, $add);
$addimportcell = new html_table_cell(implode(' ', $actions));
$addimportcell->attributes['class'] = 'mdl-align';
- $row = new html_table_row(array($emptycell, $addimportcell));
+ $row = new html_table_row([$emptycell, $addimportcell]);
$table->data[] = $row;
$output .= html_writer::table($table);
return $output;
@@ -382,71 +372,71 @@ protected function workflow_row(stdClass $workflow) {
$row->cells[] = $cell;
// View/Edit steps.
- $url = new moodle_url('/blocks/workflow/editsteps.php', array('workflowid' => $workflow->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ $url = new moodle_url('/blocks/workflow/editsteps.php', ['workflowid' => $workflow->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/edit'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('vieweditworkflow', 'block_workflow'),
- 'alt' => get_string('vieweditworkflow', 'block_workflow')
- )));
+ 'alt' => get_string('vieweditworkflow', 'block_workflow'),
+ ]));
// Export workflow.
- $url = new moodle_url('/blocks/workflow/export.php', array('sesskey' => sesskey(), 'workflowid' => $workflow->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ $url = new moodle_url('/blocks/workflow/export.php', ['sesskey' => sesskey(), 'workflowid' => $workflow->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/backup'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('exportworkflow', 'block_workflow'),
- 'alt' => get_string('exportworkflow', 'block_workflow')
- )));
+ 'alt' => get_string('exportworkflow', 'block_workflow'),
+ ]));
// Clone workflow.
- $url = new moodle_url('/blocks/workflow/clone.php', array('workflowid' => $workflow->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ $url = new moodle_url('/blocks/workflow/clone.php', ['workflowid' => $workflow->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/copy'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('cloneworkflow', 'block_workflow'),
- 'alt' => get_string('cloneworkflow', 'block_workflow')
- )));
+ 'alt' => get_string('cloneworkflow', 'block_workflow'),
+ ]));
// Disable/Enable workflow.
$cell = new html_table_cell();
if ($workflow->obsolete == BLOCK_WORKFLOW_ENABLED) {
$url = new moodle_url('/blocks/workflow/toggleworkflowobsolete.php',
- array('sesskey' => sesskey(), 'workflowid' => $workflow->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ ['sesskey' => sesskey(), 'workflowid' => $workflow->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/hide'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('disableworkflow', 'block_workflow'),
- 'alt' => get_string('disableworkflow', 'block_workflow')
- )));
+ 'alt' => get_string('disableworkflow', 'block_workflow'),
+ ]));
} else {
$url = new moodle_url('/blocks/workflow/toggleworkflowobsolete.php',
- array('sesskey' => sesskey(), 'workflowid' => $workflow->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ ['sesskey' => sesskey(), 'workflowid' => $workflow->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/show'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('enableworkflow', 'block_workflow'),
- 'alt' => get_string('enableworkflow', 'block_workflow')
- )));
+ 'alt' => get_string('enableworkflow', 'block_workflow'),
+ ]));
}
// Remove workflow.
if ($workflow->is_deletable) {
- $url = new moodle_url('/blocks/workflow/delete.php', array('workflowid' => $workflow->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ $url = new moodle_url('/blocks/workflow/delete.php', ['workflowid' => $workflow->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/delete'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('removeworkflow', 'block_workflow'),
- 'alt' => get_string('removeworkflow', 'block_workflow')
- )));
+ 'alt' => get_string('removeworkflow', 'block_workflow'),
+ ]));
} else {
$a = block_workflow_workflow::in_use_by($workflow->id);
- $actions[] = html_writer::empty_tag('img', array(
+ $actions[] = html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/delete'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('cannotdeleteworkflowinuseby', 'block_workflow', $a),
- 'alt' => get_string('removeworkflow', 'block_workflow')
- ));
+ 'alt' => get_string('removeworkflow', 'block_workflow'),
+ ]);
}
$cell = new html_table_cell(implode(' ', $actions));
@@ -480,15 +470,17 @@ protected function list_emails(array $emails) {
// Create a new email.
$emptycell = new html_table_cell();
$emptycell->colspan = 2;
- $add = html_writer::empty_tag('img', array('src' => $this->output->image_url('t/add'),
- 'class' => 'iconsmall',
- 'title' => get_string('addemail', 'block_workflow'),
- 'alt' => get_string('addemail', 'block_workflow')
- ));
+ $add = html_writer::empty_tag('img',
+ [
+ 'src' => $this->output->image_url('t/add'),
+ 'class' => 'iconsmall icon',
+ 'title' => get_string('addemail', 'block_workflow'),
+ 'alt' => get_string('addemail', 'block_workflow'),
+ ]);
$url = new moodle_url('/blocks/workflow/editemail.php');
$addnewcell = new html_table_cell(html_writer::link($url, $add));
$addnewcell->attributes['class'] = 'mdl-align';
- $row = new html_table_row(array($emptycell, $addnewcell));
+ $row = new html_table_row([$emptycell, $addnewcell]);
$table->data[] = $row;
$output .= html_writer::table($table);
@@ -516,30 +508,30 @@ protected function email_row(stdClass $email) {
$row->cells[] = $cell;
// View/Edit steps.
- $url = new moodle_url('/blocks/workflow/editemail.php', array('emailid' => $email->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ $url = new moodle_url('/blocks/workflow/editemail.php', ['emailid' => $email->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/edit'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('vieweditemail', 'block_workflow'),
'alt' => get_string('vieweditemail', 'block_workflow'),
- )));
+ ]));
// Remove email.
if ($email->activecount || $email->completecount) {
- $actions[] = html_writer::empty_tag('img', array(
+ $actions[] = html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/delete'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('cannotremoveemailinuse', 'block_workflow'),
'alt' => get_string('deleteemail', 'block_workflow'),
- ));
+ ]);
} else {
- $url = new moodle_url('/blocks/workflow/deleteemail.php', array('emailid' => $email->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ $url = new moodle_url('/blocks/workflow/deleteemail.php', ['emailid' => $email->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/delete'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('deleteemail', 'block_workflow'),
'alt' => get_string('deleteemail', 'block_workflow'),
- )));
+ ]));
}
// Add the steps.
@@ -581,19 +573,21 @@ public function list_steps($workflow) {
$info->appliesto = $workflow->appliesto;
// The image to add a new step.
- $add = html_writer::empty_tag('img', array('src' => $this->output->image_url('t/add'),
- 'class' => 'iconsmall',
- 'title' => get_string('addstep', 'block_workflow'),
- 'alt' => get_string('addstep', 'block_workflow')
- ));
+ $add = html_writer::empty_tag('img',
+ [
+ 'src' => $this->output->image_url('t/add'),
+ 'class' => 'iconsmall icon',
+ 'title' => get_string('addstep', 'block_workflow'),
+ 'alt' => get_string('addstep', 'block_workflow'),
+ ]);
// Add a step to the beginning.
$addempty = new html_table_cell();
$addempty->colspan = 5;
$addcell = new html_table_cell(html_writer::link(new moodle_url('/blocks/workflow/editstep.php',
- array('workflowid' => $workflow->id, 'beforeafter' => -1)), $add));
+ ['workflowid' => $workflow->id, 'beforeafter' => -1]), $add));
$addcell->attributes['class'] = 'mdl-align';
- $addrow = new html_table_row(array($addempty, $addcell));
+ $addrow = new html_table_row([$addempty, $addcell]);
$table->data[] = $addrow;
// Process the other steps.
@@ -609,11 +603,11 @@ public function list_steps($workflow) {
$infocell->colspan = 5;
$infocell->attributes['class'] = 'mdl-align';
- $url = new moodle_url('/blocks/workflow/editstep.php', array('workflowid' => $workflow->id));
+ $url = new moodle_url('/blocks/workflow/editstep.php', ['workflowid' => $workflow->id]);
$addnewcell = new html_table_cell(html_writer::link($url, $add));
$addnewcell->attributes['class'] = 'mdl-align';
- $row = new html_table_row(array($infocell, $addnewcell));
+ $row = new html_table_row([$infocell, $addnewcell]);
$table->data[] = $row;
// Display the table.
@@ -622,6 +616,13 @@ public function list_steps($workflow) {
return $output;
}
+ /**
+ * Renders a single workflow step.
+ *
+ * @param object $step The workflow step object containing step details.
+ * @param object $info Additional information related to the workflow step.
+ * @return html_table_row The rendered HTML output for the workflow step.
+ */
protected function workflow_step($step, $info) {
$row = new html_table_row();
@@ -647,57 +648,60 @@ protected function workflow_step($step, $info) {
$row->cells[] = $cell;
// Modification.
- $actions = array();
- $url = new moodle_url('/blocks/workflow/editstep.php', array('stepid' => $step->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array('src' => $this->output->image_url('t/edit'),
- 'class' => 'iconsmall',
- 'title' => get_string('editstep', 'block_workflow'),
- 'alt' => get_string('editstep', 'block_workflow')
- )));
+ $actions = [];
+ $url = new moodle_url('/blocks/workflow/editstep.php', ['stepid' => $step->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img',
+ [
+ 'src' => $this->output->image_url('t/edit'),
+ 'class' => 'iconsmall icon',
+ 'title' => get_string('editstep', 'block_workflow'),
+ 'alt' => get_string('editstep', 'block_workflow'),
+ ]
+ ));
// Add step after this one.
$url = new moodle_url('/blocks/workflow/editstep.php',
- array('workflowid' => $info->workflowid, 'beforeafter' => $step->stepno));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ ['workflowid' => $info->workflowid, 'beforeafter' => $step->stepno]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/add'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('addstepafter', 'block_workflow'),
- 'alt' => get_string('addstepafter', 'block_workflow')
- )));
+ 'alt' => get_string('addstepafter', 'block_workflow'),
+ ]));
// Can't be removed if this is the only step or in use.
if ($info->stepcount != 1 && !block_workflow_step::is_step_in_use($step->id)) {
- $url = new moodle_url('/blocks/workflow/deletestep.php', array('stepid' => $step->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ $url = new moodle_url('/blocks/workflow/deletestep.php', ['stepid' => $step->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/delete'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('removestep', 'block_workflow'),
- 'alt' => get_string('removestep', 'block_workflow')
- )));
+ 'alt' => get_string('removestep', 'block_workflow'),
+ ]));
}
// Move up if this is not the first step.
if ($step->stepno != 1) {
$url = new moodle_url('/blocks/workflow/movestep.php',
- array('sesskey' => sesskey(), 'id' => $step->id, 'direction' => 'up'));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ ['sesskey' => sesskey(), 'id' => $step->id, 'direction' => 'up']);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/up'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('moveup', 'block_workflow'),
- 'alt' => get_string('moveup', 'block_workflow')
- )));
+ 'alt' => get_string('moveup', 'block_workflow'),
+ ]));
}
// Move down if this is not the final step.
if (!isset($step->finalstep)) {
$url = new moodle_url('/blocks/workflow/movestep.php',
- array('sesskey' => sesskey(), 'id' => $step->id, 'direction' => 'down'));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array(
+ ['sesskey' => sesskey(), 'id' => $step->id, 'direction' => 'down']);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/down'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('movedown', 'block_workflow'),
- 'alt' => get_string('movedown', 'block_workflow')
- )));
+ 'alt' => get_string('movedown', 'block_workflow'),
+ ]));
}
$cell = new html_table_cell(implode(' ', $actions));
@@ -755,13 +759,19 @@ protected function workflow_step_auto_finish($step, $appliesto) {
*/
protected function workflow_step_doers($stepdata) {
$step = block_workflow_step::make($stepdata);
- $doernames = array();
+ $doernames = [];
foreach ($step->roles() as $doer) {
$doernames[] = $doer->localname;
}
return implode(', ', $doernames);
}
+ /**
+ * Displays detailed information about the given workflow.
+ *
+ * @param object $workflow The workflow object containing workflow details to be displayed.
+ * @return string The rendered HTML output for the workflow information.
+ */
protected function workflow_information($workflow) {
$output = '';
@@ -770,29 +780,29 @@ protected function workflow_information($workflow) {
$table = $this->setup_table();
// Workflow name and shortname.
- $row = new html_table_row(array(get_string('name', 'block_workflow')));
+ $row = new html_table_row([get_string('name', 'block_workflow')]);
$cell = new html_table_cell();
- $data = array('name' => format_string($workflow->name), 'shortname' => s($workflow->shortname));
+ $data = ['name' => format_string($workflow->name), 'shortname' => s($workflow->shortname)];
$cell->text = get_string('nameshortname', 'block_workflow', $data);
$row->cells[] = $cell;
$table->data[] = $row;
// Description.
- $row = new html_table_row(array(get_string('description', 'block_workflow')));
+ $row = new html_table_row([get_string('description', 'block_workflow')]);
$cell = new html_table_cell();
$cell->text = format_text($workflow->description, $workflow->descriptionformat);
$row->cells[] = $cell;
$table->data[] = $row;
// What contexts does this block apply to.
- $row = new html_table_row(array(get_string('appliesto', 'block_workflow')));
+ $row = new html_table_row([get_string('appliesto', 'block_workflow')]);
$cell = new html_table_cell();
$cell->text = $workflow->appliesto;
$row->cells[] = $cell;
$table->data[] = $row;
// Status information.
- $row = new html_table_row(array(get_string('status', 'block_workflow')));
+ $row = new html_table_row([get_string('status', 'block_workflow')]);
$cell = new html_table_cell();
if ($workflow->obsolete == BLOCK_WORKFLOW_OBSOLETE) {
$cell->text = get_string('obsoleteworkflow', 'block_workflow');
@@ -803,7 +813,7 @@ protected function workflow_information($workflow) {
$table->data[] = $row;
// Other info.
- $row = new html_table_row(array(get_string('inuseby', 'block_workflow')));
+ $row = new html_table_row([get_string('inuseby', 'block_workflow')]);
$cell = new html_table_cell('This workflow is active in x contexts');
$row->cells[] = $cell;
$table->data[] = $row;
@@ -829,36 +839,36 @@ public function display_workflow($workflow) {
$table->attributes['class'] = '';
// Shortname.
- $row = new html_table_row(array(
+ $row = new html_table_row([
get_string('shortname', 'block_workflow'),
s($workflow->shortname),
- ));
+ ]);
$table->data[] = $row;
// Name.
- $row = new html_table_row(array(
+ $row = new html_table_row([
get_string('name', 'block_workflow'),
format_string($workflow->name),
- ));
+ ]);
$table->data[] = $row;
// Description.
- $row = new html_table_row(array(
+ $row = new html_table_row([
get_string('description', 'block_workflow'),
format_text($workflow->description, $workflow->descriptionformat),
- ));
+ ]);
$table->data[] = $row;
// Applies to.
- $row = new html_table_row(array(
+ $row = new html_table_row([
get_string('thisworkflowappliesto', 'block_workflow'),
block_workflow_appliesto($workflow->appliesto),
- ));
+ ]);
$table->data[] = $row;
// Current status.
$togglelink = new moodle_url('/blocks/workflow/toggleworkflowobsolete.php',
- array('workflowid' => $workflow->id, 'returnto' => 'editsteps', 'sesskey' => sesskey()));
+ ['workflowid' => $workflow->id, 'returnto' => 'editsteps', 'sesskey' => sesskey()]);
if ($workflow->obsolete) {
$status = get_string('workflowobsolete', 'block_workflow', $togglelink->out());
} else {
@@ -871,10 +881,10 @@ public function display_workflow($workflow) {
$status .= get_string('notcurrentlyinuse', 'block_workflow');
}
- $row = new html_table_row(array(
+ $row = new html_table_row([
get_string('workflowstatus', 'block_workflow'),
- $status
- ));
+ $status,
+ ]);
$table->data[] = $row;
// Workflow actions.
@@ -883,23 +893,23 @@ public function display_workflow($workflow) {
$cell->colspan = 2;
$cell->attributes['class'] = 'mdl-align';
- $actions = array();
+ $actions = [];
// Edit the workflow.
- $url = new moodle_url('/blocks/workflow/editsettings.php', array('workflowid' => $workflow->id));
+ $url = new moodle_url('/blocks/workflow/editsettings.php', ['workflowid' => $workflow->id]);
$actions[] = html_writer::link($url, get_string('edit', 'block_workflow'));
// Clone the workflow.
- $url = new moodle_url('/blocks/workflow/clone.php', array('workflowid' => $workflow->id));
+ $url = new moodle_url('/blocks/workflow/clone.php', ['workflowid' => $workflow->id]);
$actions[] = html_writer::link($url, get_string('clone', 'block_workflow'));
// Export the workflow.
- $url = new moodle_url('/blocks/workflow/export.php', array('sesskey' => sesskey(), 'workflowid' => $workflow->id));
+ $url = new moodle_url('/blocks/workflow/export.php', ['sesskey' => sesskey(), 'workflowid' => $workflow->id]);
$actions[] = html_writer::link($url, get_string('export', 'block_workflow'));
if (block_workflow_workflow::is_workflow_deletable($workflow->id)) {
// Delete the workflow.
- $url = new moodle_url('/blocks/workflow/delete.php', array('workflowid' => $workflow->id));
+ $url = new moodle_url('/blocks/workflow/delete.php', ['workflowid' => $workflow->id]);
$actions[] = html_writer::link($url, get_string('delete', 'block_workflow'));
}
@@ -914,6 +924,13 @@ public function display_workflow($workflow) {
return $output;
}
+ /**
+ * Renders the to-do list for a given workflow step.
+ *
+ * @param array $todos An array of to-do items associated with the workflow step.
+ * @param object $step The workflow step object for which the to-do list is being rendered.
+ * @return string The HTML output for the to-do list.
+ */
public function step_todolist($todos, $step) {
$output = '';
@@ -932,15 +949,16 @@ public function step_todolist($todos, $step) {
// Add option to add a new task.
$emptycell = new html_table_cell();
- $add = html_writer::empty_tag('img', array('src' => $this->output->image_url('t/add'),
- 'class' => 'iconsmall',
- 'title' => get_string('addtask', 'block_workflow'),
- 'alt' => get_string('addtask', 'block_workflow')
- ));
- $url = new moodle_url('/blocks/workflow/edittask.php', array('stepid' => $step->id));
+ $add = html_writer::empty_tag('img', [
+ 'src' => $this->output->image_url('t/add'),
+ 'class' => 'iconsmall icon',
+ 'title' => get_string('addtask', 'block_workflow'),
+ 'alt' => get_string('addtask', 'block_workflow'),
+ ]);
+ $url = new moodle_url('/blocks/workflow/edittask.php', ['stepid' => $step->id]);
$addnewcell = new html_table_cell(html_writer::link($url, $add));
- $row = new html_table_row(array($emptycell, $addnewcell));
+ $row = new html_table_row([$emptycell, $addnewcell]);
$table->data[] = $row;
// Display the table.
@@ -948,52 +966,71 @@ public function step_todolist($todos, $step) {
return $output;
}
+
+ /**
+ * Renders a to-do list item for a workflow step.
+ *
+ * @param stdClass $task The task object containing information about the workflow step.
+ * @return string The HTML output for the to-do list item.
+ */
protected function step_todolist_item(stdClass $task) {
$row = new html_table_row();
$name = new html_table_cell(format_string($task->task));
- $actions = array();
+ $actions = [];
- $url = new moodle_url('/blocks/workflow/edittask.php', array('id' => $task->id));
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array('src' => $this->output->image_url('t/edit'),
- 'class' => 'iconsmall',
- 'title' => get_string('edittask', 'block_workflow'),
- 'alt' => get_string('edittask', 'block_workflow')
- )));
+ $url = new moodle_url('/blocks/workflow/edittask.php', ['id' => $task->id]);
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
+ 'src' => $this->output->image_url('t/edit'),
+ 'class' => 'iconsmall icon',
+ 'title' => get_string('edittask', 'block_workflow'),
+ 'alt' => get_string('edittask', 'block_workflow'),
+ ]));
// Obsolete task.
- $url = new moodle_url('/blocks/workflow/toggletaskobsolete.php', array('sesskey' => sesskey(), 'taskid' => $task->id));
+ $url = new moodle_url('/blocks/workflow/toggletaskobsolete.php', ['sesskey' => sesskey(), 'taskid' => $task->id]);
if ($task->obsolete == BLOCK_WORKFLOW_ENABLED) {
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array('src' => $this->output->image_url('t/hide'),
- 'class' => 'iconsmall',
- 'title' => get_string('hidetask', 'block_workflow'),
- 'alt' => get_string('hidetask', 'block_workflow')
- )));
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
+ 'src' => $this->output->image_url('t/hide'),
+ 'class' => 'iconsmall icon',
+ 'title' => get_string('hidetask', 'block_workflow'),
+ 'alt' => get_string('hidetask', 'block_workflow'),
+ ]));
} else {
- $actions[] = html_writer::link($url, html_writer::empty_tag('img', array('src' => $this->output->image_url('t/show'),
- 'class' => 'iconsmall',
- 'title' => get_string('showtask', 'block_workflow'),
- 'alt' => get_string('showtask', 'block_workflow')
- )));
+ $actions[] = html_writer::link($url, html_writer::empty_tag('img', [
+ 'src' => $this->output->image_url('t/show'),
+ 'class' => 'iconsmall icon',
+ 'title' => get_string('showtask', 'block_workflow'),
+ 'alt' => get_string('showtask', 'block_workflow'),
+ ]));
}
// Delete task.
if ($task->isremovable) {
- $url = new moodle_url('/blocks/workflow/deletetask.php', array('id' => $task->id));
+ $url = new moodle_url('/blocks/workflow/deletetask.php', ['id' => $task->id]);
$actions[] = html_writer::link($url,
- html_writer::empty_tag('img', array('src' => $this->output->image_url('t/delete'),
- 'class' => 'iconsmall',
- 'title' => get_string('removetask', 'block_workflow'),
- 'alt' => get_string('removetask', 'block_workflow')
- )));
+ html_writer::empty_tag('img', [
+ 'src' => $this->output->image_url('t/delete'),
+ 'class' => 'iconsmall icon',
+ 'title' => get_string('removetask', 'block_workflow'),
+ 'alt' => get_string('removetask', 'block_workflow'),
+ ]));
}
$actions = new html_table_cell(implode(' ', $actions));
// Put it all together into a row and return the data.
- $row = new html_table_row(array($name, $actions));
+ $row = new html_table_row([$name, $actions]);
return $row;
}
+ /**
+ * Generates the step doers.
+ *
+ * @param array $roles Array of role objects or IDs relevant to the workflow step.
+ * @param array $doers Array of user objects or IDs who are assigned as doers for the step.
+ * @param int $stepid The unique identifier of the workflow step.
+ * @return string HTML output displaying the doers for the specified step.
+ */
public function step_doers($roles, $doers, $stepid) {
$output = '';
@@ -1023,30 +1060,38 @@ public function step_doers($roles, $doers, $stepid) {
return $output;
}
+
+ /**
+ * Returns the user or entity responsible for performing a specific workflow step.
+ *
+ * @param object $role The role or identifier of the doer.
+ * @param int $stepid The ID of the workflow step.
+ * @return string The doer of the specified workflow step.
+ */
protected function step_doer($role, $stepid) {
$row = new html_table_row();
$name = new html_table_cell($role->localname);
$url = new moodle_url('/blocks/workflow/togglerole.php',
- array('sesskey' => sesskey(), 'roleid' => $role->id, 'stepid' => $stepid));
+ ['sesskey' => sesskey(), 'roleid' => $role->id, 'stepid' => $stepid]);
if ($role->doer) {
- $actions = html_writer::link($url, html_writer::empty_tag('img', array(
+ $actions = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/delete'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('removerolefromstep', 'block_workflow'),
- 'alt' => get_string('removerolefromstep', 'block_workflow')
- )));
+ 'alt' => get_string('removerolefromstep', 'block_workflow'),
+ ]));
} else {
- $actions = html_writer::link($url, html_writer::empty_tag('img', array(
+ $actions = html_writer::link($url, html_writer::empty_tag('img', [
'src' => $this->output->image_url('t/add'),
- 'class' => 'iconsmall',
+ 'class' => 'iconsmall icon',
'title' => get_string('addroletostep', 'block_workflow'),
- 'alt' => get_string('addroletostep', 'block_workflow')
- )));
+ 'alt' => get_string('addroletostep', 'block_workflow'),
+ ]));
}
// Put it all together into a row and return the data.
- $row = new html_table_row(array($name, $actions));
+ $row = new html_table_row([$name, $actions]);
return $row;
}
@@ -1129,9 +1174,9 @@ public function create_step_instructions(block_workflow_workflow $workflow) {
*/
protected function setup_table() {
$table = new html_table();
- $table->head = array();
- $table->colclasses = array();
- $table->data = array();
+ $table->head = [];
+ $table->colclasses = [];
+ $table->data = [];
return $table;
}
@@ -1144,6 +1189,14 @@ protected function get_box_start_css_classes() {
return 'generalbox boxwidthwide boxaligncenter';
}
+ /**
+ * Renders the overview of a workflow.
+ *
+ * @param object $workflow The workflow object containing workflow details.
+ * @param array $states An array of workflow states.
+ * @param object $context The context in which the workflow is being rendered.
+ * @return string The rendered HTML output for the workflow overview.
+ */
public function workflow_overview($workflow, array $states, $context) {
$output = '';
@@ -1165,24 +1218,31 @@ public function workflow_overview($workflow, array $states, $context) {
foreach ($states as $state) {
$table->data[] = $this->workflow_overview_step($state, $context);
}
- $this->page->requires->yui_module('moodle-block_workflow-userinfo', 'M.block_workflow.userinfo.init');
+ $this->page->requires->js_call_amd('block_workflow/userinfo', 'init');
// Put everything together and return.
$output .= html_writer::table($table);
// Put text and button after the table.
- $output .= html_writer::tag('div', $this->atendgobackto($workflow), array('id' => 'text-after-table'));
+ $output .= html_writer::tag('div', $this->atendgobackto($workflow), ['id' => 'text-after-table']);
if (has_capability('block/workflow:manage', $context)) {
$url = new moodle_url('/blocks/workflow/removeworkflow.php',
- array('contextid' => $context->id, 'workflowid' => $workflow->id));
+ ['contextid' => $context->id, 'workflowid' => $workflow->id]);
$output .= $this->output->render(new single_button($url, get_string('removeworkflow', 'block_workflow')));
}
$output .= $this->box_end();
return $output;
}
+ /**
+ * Renders the overview for a specific workflow step.
+ *
+ * @param stdClass $stepstate The current state of the workflow step.
+ * @param object $context The context in which the workflow is being rendered.
+ * @return string The rendered HTML output for the workflow step overview.
+ */
private function workflow_overview_step($stepstate, $context) {
$row = new html_table_row();
- $classes = array('step');
+ $classes = ['step'];
// Add some CSS classes to help colour-code the states.
if ($stepstate->state == BLOCK_WORKFLOW_STATE_ACTIVE) {
@@ -1202,7 +1262,7 @@ private function workflow_overview_step($stepstate, $context) {
$complete = html_writer::tag('span',
get_string('percentcomplete', 'block_workflow',
format_float($stepstate->complete, 0)),
- array('class' => 'completeinfo'));
+ ['class' => 'completeinfo']);
} else {
$complete = '';
}
@@ -1233,7 +1293,7 @@ private function workflow_overview_step($stepstate, $context) {
// Comments.
$cell = new html_table_cell();
- $cell->text = format_text($stepstate->comment, $stepstate->commentformat, array('context' => $context));
+ $cell->text = format_text($stepstate->comment, $stepstate->commentformat, ['context' => $context]);
if (!$cell->text) {
$cell->text = get_string('nocomment', 'block_workflow');
}
@@ -1253,7 +1313,7 @@ private function workflow_overview_step($stepstate, $context) {
$cell = new html_table_cell();
if ($stepstate->timemodified) {
$cell->text = $stepstate->modifieduser . html_writer::tag('span',
- userdate($stepstate->timemodified), array('class' => 'dateinfo'));
+ userdate($stepstate->timemodified), ['class' => 'dateinfo']);
}
$cell->attributes['class'] = 'mdl-align';
$row->cells[] = $cell;
@@ -1282,10 +1342,16 @@ private function workflow_overview_step($stepstate, $context) {
return $row;
}
+ /**
+ * Generates the step history overview for a given workflow state.
+ *
+ * @param int $stateid The ID of the workflow state to retrieve the step history for.
+ * @return string The rendered HTML output of the step history overview.
+ */
private function workflow_overview_step_history($stateid) {
- $history = array();
+ $history = [];
foreach (block_workflow_step_state::state_changes($stateid) as $change) {
- $a = array();
+ $a = [];
$a['newstate'] = get_string('state_history_' . $change->newstate, 'block_workflow');
$a['time'] = userdate($change->timestamp);
$a['user'] = $change->username;
@@ -1302,7 +1368,7 @@ private function workflow_overview_step_history($stateid) {
*/
protected function atendgobackto($workflow) {
// At end go back to ...
- $a = array();
+ $a = [];
// ... count the steps.
$a['stepcount'] = count($workflow->steps());
@@ -1321,7 +1387,7 @@ protected function atendgobackto($workflow) {
* @return String The rendered button to take the user to the finishstep form
*/
protected function finish_step($stateid) {
- $url = new moodle_url('/blocks/workflow/finishstep.php', array('stateid' => $stateid));
+ $url = new moodle_url('/blocks/workflow/finishstep.php', ['stateid' => $stateid]);
return $this->output->render(new single_button($url, get_string('finishstep', 'block_workflow'), 'get'));
}
@@ -1332,7 +1398,7 @@ protected function finish_step($stateid) {
* @return String The rendered button to take the user to the jumptostep form
*/
protected function jump_to_step($stepid, $contextid) {
- $url = new moodle_url('/blocks/workflow/jumptostep.php', array('stepid' => $stepid, 'contextid' => $contextid));
+ $url = new moodle_url('/blocks/workflow/jumptostep.php', ['stepid' => $stepid, 'contextid' => $contextid]);
return $this->output->render(new single_button($url, get_string('jumptostep', 'block_workflow'), 'get'));
}
@@ -1380,16 +1446,16 @@ protected function get_popup_table($users, $stepno) {
// Get extra user information from the user policies settings.
$extrafields = \core_user\fields::get_identity_fields($this->page->context, true);
// Set up the table header.
- $tableheader = array();
+ $tableheader = [];
$tableheader[] = get_string('name');
foreach ($extrafields as $field) {
$tableheader[] = \core_user\fields::get_display_name($field);
}
$tableheader[] = get_string('roles');
- $data = array();
+ $data = [];
foreach ($users as $key => $user) {
- $row = array();
+ $row = [];
$row[0] = html_writer::tag('b', fullname($user));
$extraindex = 1;
if ($extrafields) {
@@ -1419,7 +1485,7 @@ protected function get_popup_table($users, $stepno) {
$popupheader .= " (Step $stepno)";
}
// Return header and body of the popup.
- return array($popupheader, html_writer::table($table));
+ return [$popupheader, html_writer::table($table)];
}
/**
@@ -1433,7 +1499,7 @@ protected function get_popup_button($roles, $context, $stepno = 0) {
$users = $steptate->get_all_users_and_their_roles($roles, $context);
$numberofusers = $users === null ? 0 : count($users);
list ($header, $body) = $this->get_popup_table($users, $stepno);
- $options = array('class' => 'userinfoclass', 'header' => $header, 'body' => $body, 'stepno' => $stepno);
+ $options = ['class' => 'userinfoclass', 'header' => $header, 'body' => $body, 'stepno' => $stepno];
if (!$roles) {
return null;
diff --git a/styles.css b/styles.css
index 23fd842..c0d75de 100644
--- a/styles.css
+++ b/styles.css
@@ -69,11 +69,6 @@
display: block;
font-size: 0.8em;
}
-body.ie7 .moodle-dialogue-base .moodle-dialogue-hd .closebutton {
- float: none;
- position: absolute;
- right: 5px;
-}
#page-admin-blocks-workflow-manage #manage td.c2 {
font-size: 0.8em;
}
diff --git a/tests/autostepfinisher_test.php b/tests/autostepfinisher_test.php
index c5e0995..2b23894 100644
--- a/tests/autostepfinisher_test.php
+++ b/tests/autostepfinisher_test.php
@@ -32,9 +32,17 @@
require_once($CFG->dirroot . '/blocks/workflow/locallib.php');
require_once($CFG->dirroot . '/blocks/workflow/tests/lib.php');
-class autostepfinisher_test extends \block_workflow_testlib {
-
- public function test_automatic_step_finisher() {
+/**
+ * Unit tests for the autostepfinisher functionality in the block_workflow plugin.
+ */
+final class autostepfinisher_test extends \block_workflow_testlib {
+
+ /**
+ * Tests the block_workflow_autofinish_steps method.
+ *
+ * @covers ::block_workflow_autofinish_steps
+ */
+ public function test_automatic_step_finisher(): void {
global $CFG, $DB;
$now = time();
$after5days = $this->get_days(5);
@@ -47,11 +55,11 @@ public function test_automatic_step_finisher() {
$generator = $this->getDataGenerator();
// Create a course object.
- $course1 = $generator->create_course(array('shortname' => 'M123-12J', 'startdate' => $timestamp1));
+ $course1 = $generator->create_course(['shortname' => 'M123-12J', 'startdate' => $timestamp1]);
$coursecontext1 = \context_course::instance($course1->id);
// Create another course object.
- $course2 = $generator->create_course(array('shortname' => 'K123-12J', 'startdate' => $timestamp2));
+ $course2 = $generator->create_course(['shortname' => 'K123-12J', 'startdate' => $timestamp2]);
$coursecontext2 = \context_course::instance($course2->id);
// Generate a vl_v_crs_version_pres table.
@@ -65,14 +73,14 @@ public function test_automatic_step_finisher() {
$courseondataloadtable = $DB->get_record_sql(
'SELECT * FROM vl_v_crs_version_pres ' .
- 'WHERE vle_course_short_name = ?', array($courseshortname), MUST_EXIST);
+ 'WHERE vle_course_short_name = ?', [$courseshortname], MUST_EXIST);
// Create a new workflow object which applies to course.
- $stepoptions = array('autofinish' => 'course;startdate', 'autofinishoffset' => $before5days);
+ $stepoptions = ['autofinish' => 'course;startdate', 'autofinishoffset' => $before5days];
list($courseworkflow, $step1) = $this->create_a_workflow_with_one_step($stepoptions);
// Required DB tables are not populated and therefore following methods return empty arrays.
- $stepoptions = array('autofinish', 'autofinishoffset', null);
+ $stepoptions = ['autofinish', 'autofinishoffset', null];
$activesteps = block_workflow_get_active_steps_with_fields_not_null($stepoptions);
$this->assertEmpty($activesteps);
@@ -104,7 +112,7 @@ public function test_automatic_step_finisher() {
$this->assertEquals($expectedactivesteps, $activesteps);
// Check relevant fields in 'block_workflow_step_states' table before finishing automatically.
- $statebeforefinish = $DB->get_record('block_workflow_step_states', array('id' => $state1->id));
+ $statebeforefinish = $DB->get_record('block_workflow_step_states', ['id' => $state1->id]);
$this->assertEquals(BLOCK_WORKFLOW_STATE_ACTIVE, $statebeforefinish->state);
$this->assertEmpty($statebeforefinish->comment);
@@ -112,7 +120,7 @@ public function test_automatic_step_finisher() {
block_workflow_autofinish_steps();
// Check relevant fields in 'block_workflow_step_states' table after finishing automatically.
- $stateafterfinish = $DB->get_record('block_workflow_step_states', array('id' => $state1->id));
+ $stateafterfinish = $DB->get_record('block_workflow_step_states', ['id' => $state1->id]);
$this->assertEquals(BLOCK_WORKFLOW_STATE_COMPLETED, $stateafterfinish->state);
$this->assertNotEmpty($stateafterfinish->comment);
}
diff --git a/tests/behat/behat_block_workflow.php b/tests/behat/behat_block_workflow.php
index 9bb6942..755a28f 100644
--- a/tests/behat/behat_block_workflow.php
+++ b/tests/behat/behat_block_workflow.php
@@ -100,10 +100,11 @@ public function quiz_workflow_is_at_step($quizname, $stepname) {
*/
public function test_course_visibility(string $coursefullname, string $isvisible): void {
global $DB;
- $course = $DB->get_record("course", array("fullname" => $coursefullname), 'visible', MUST_EXIST);
+ $course = $DB->get_record("course", ["fullname" => $coursefullname], 'visible', MUST_EXIST);
$expectedvisibility = $isvisible == 'visible';
if ($course->visible != $expectedvisibility) {
- throw new ExpectationException('"' . $coursefullname . '" should be ' . $isvisible . ' but isn\'t.', $this->getSession());
+ throw new ExpectationException('"' . $coursefullname . '" should be ' . $isvisible . ' but isn\'t.',
+ $this->getSession());
}
}
}
diff --git a/tests/behat/use_workflow_tinymce.feature b/tests/behat/use_workflow_tinymce.feature
index 6584ac4..afcf6fc 100644
--- a/tests/behat/use_workflow_tinymce.feature
+++ b/tests/behat/use_workflow_tinymce.feature
@@ -35,7 +35,7 @@ Feature: Workflow block - follow a workflow using TinyMCE
And I upload "blocks/workflow/tests/fixtures/testworkflow.workflow.xml" file to "File" filemanager
And I press "Import workflow"
And I navigate to "Plugins > Text editors > Manage editors" in site administration
- And I click on "Disable" "link" in the "Atto HTML editor" "table_row"
+ And I click on "Disable" "checkbox" in the "TinyMCE editor" "table_row"
And I log out
When I log in as "manager1"
@@ -126,3 +126,23 @@ Feature: Workflow block - follow a workflow using TinyMCE
And I click on "Workflow overview" "button" in the "Workflow" "block"
And I should see "Complete" in the "Configure basic site" "table_row"
And I should see "Complete" in the "Prepare your web site" "table_row"
+
+ @javascript @_file_upload
+ Scenario: Add a workflow to a course and edit comment.
+ Given I log in as "admin"
+ When I navigate to "Plugins > Blocks > Workflows" in site administration
+ And I follow "Import workflow"
+ And I upload "blocks/workflow/tests/fixtures/testworkflow.workflow.xml" file to "File" filemanager
+ And I press "Import workflow"
+ And I am on "Course 1" course homepage
+ And I turn editing mode on
+ And I add the "Workflows" block
+ And I set the field "workflow" to "Test course workflow"
+ And I press "Edit comments"
+ And I set the field "Update workflow comment" to "This is a comment"
+ And I click on "Save changes" "button" in the "Edit comments" "dialogue"
+ And I press "Finish step"
+ And I should see "This is a comment"
+ And I click on "Finish step" "button" in the "Finish step" "dialogue"
+ And I press "Edit comments"
+ Then I should not see "This is a comment"
diff --git a/tests/command_test.php b/tests/command_test.php
index eae738b..5a95129 100644
--- a/tests/command_test.php
+++ b/tests/command_test.php
@@ -33,19 +33,25 @@
require_once(dirname(__FILE__) . '/../locallib.php');
require_once(dirname(__FILE__) . '/lib.php');
-class command_test extends \block_workflow_testlib {
+/**
+ * Unit test class for the block_workflow command functionality.
+ */
+final class command_test extends \block_workflow_testlib {
/**
* Test the role_exists function
* - Positive test for a known good role
* - Negative test for a known bad role (check for exception)
+ *
+ * @covers \block_workflow_command::role_exists
+ * @covers \block_workflow_command::require_role_exists
*/
- public function test_role_exists() {
+ public function test_role_exists(): void {
// First test that a known good role works.
$result = block_workflow_command::role_exists('manager');
$this->assertInstanceOf('stdClass', $result);
- $errors = array();
+ $errors = [];
$result = block_workflow_command::require_role_exists('manager', $errors);
$this->assertInstanceOf('stdClass', $result);
$this->assertEquals(count($errors), 0);
@@ -54,7 +60,7 @@ public function test_role_exists() {
$result = block_workflow_command::role_exists('invalidrole');
$this->assertFalse($result);
- $errors = array();
+ $errors = [];
$result = block_workflow_command::require_role_exists('invalidrole', $errors);
$this->assertEquals(count($errors), 1);
}
@@ -63,8 +69,10 @@ public function test_role_exists() {
* Test the type of workflow
* - Positive test for an activity (activity == true)
* - Negative test for an activity (activity == false)
+ *
+ * @covers \block_workflow_command::is_activity
*/
- public function test_is_activity() {
+ public function test_is_activity(): void {
$this->resetAfterTest(true);
diff --git a/tests/commandassignrole_test.php b/tests/commandassignrole_test.php
index 6b85482..06f93c0 100644
--- a/tests/commandassignrole_test.php
+++ b/tests/commandassignrole_test.php
@@ -34,14 +34,30 @@
global $CFG;
require_once(dirname(__FILE__) . '/lib.php');
-class commandassignrole_test extends \block_workflow_testlib {
-
- public function test_assignrole() {
+/**
+ * Unit tests for the commandassignrole functionality in the block_workflow plugin.
+ *
+ * This test class extends the block_workflow_testlib base class to provide
+ * test cases for assigning roles via workflow commands.
+ */
+final class commandassignrole_test extends \block_workflow_testlib {
+
+ /**
+ * Tests the assignrole method.
+ *
+ * @covers \block_workflow_command_assignrole
+ */
+ public function test_assignrole(): void {
$command = new block_workflow_command_assignrole();
$this->assertInstanceOf('block_workflow_command', $command);
}
- public function test_parse_no_state() {
+ /**
+ * Tests the parse method for no state.
+ *
+ * @covers \block_workflow_command_assignrole::parse
+ */
+ public function test_parse_no_state(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -79,7 +95,12 @@ public function test_parse_no_state() {
$this->assertEquals(count($result->users), 0);
}
- public function test_parse_no_state_invalid_newrole() {
+ /**
+ * Tests the parse method for no state invalid new role.
+ *
+ * @covers \block_workflow_command_assignrole::parse
+ */
+ public function test_parse_no_state_invalid_newrole(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -117,7 +138,12 @@ public function test_parse_no_state_invalid_newrole() {
$this->assertEquals(count($result->users), 0);
}
- public function test_parse_no_state_invalid_targetrole() {
+ /**
+ * Tests the parse method for no state invalid targetrole.
+ *
+ * @covers \block_workflow_command_assignrole::parse
+ */
+ public function test_parse_no_state_invalid_targetrole(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -155,7 +181,12 @@ public function test_parse_no_state_invalid_targetrole() {
$this->assertEquals(count($result->users), 0);
}
- public function test_parse_with_state() {
+ /**
+ * Tests the parse method.
+ *
+ * @covers \block_workflow_command_assignrole::parse
+ */
+ public function test_parse_with_state(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -196,7 +227,12 @@ public function test_parse_with_state() {
$this->assertEquals(count($result->users), 2);
}
- public function test_parse_with_state_invalid_newrole() {
+ /**
+ * Tests the parse method.
+ *
+ * @covers \block_workflow_command_assignrole::parse
+ */
+ public function test_parse_with_state_invalid_newrole(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -237,7 +273,12 @@ public function test_parse_with_state_invalid_newrole() {
$this->assertEquals(count($result->users), 2);
}
- public function test_parse_with_state_invalid_targetrole() {
+ /**
+ * Tests the parse method.
+ *
+ * @covers \block_workflow_command_assignrole::parse
+ */
+ public function test_parse_with_state_invalid_targetrole(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -278,7 +319,12 @@ public function test_parse_with_state_invalid_targetrole() {
$this->assertEquals(count($result->users), 1);
}
- public function test_execute() {
+ /**
+ * Tests the execute method.
+ *
+ * @covers \block_workflow_command_assignrole::execute
+ */
+ public function test_execute(): void {
global $DB;
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -293,9 +339,9 @@ public function test_execute() {
// Check the current assignments.
foreach ($result->users as $user) {
- $assignments = $DB->get_records('role_assignments', array('roleid' => $result->newrole->id,
+ $assignments = $DB->get_records('role_assignments', ['roleid' => $result->newrole->id,
'contextid' => $result->context->id, 'userid' => $user->id, 'component' => 'block_workflow',
- 'itemid' => $state->id));
+ 'itemid' => $state->id]);
$this->assertEquals(count($assignments), 0);
}
@@ -305,9 +351,9 @@ public function test_execute() {
// Check the new assignments.
foreach ($result->users as $user) {
- $assignments = $DB->get_records('role_assignments', array('roleid' => $result->newrole->id,
+ $assignments = $DB->get_records('role_assignments', ['roleid' => $result->newrole->id,
'contextid' => $result->context->id, 'userid' => $user->id, 'component' => 'block_workflow',
- 'itemid' => $state->id));
+ 'itemid' => $state->id]);
$this->assertEquals(count($assignments), 1);
}
}
diff --git a/tests/commandsetactivitylinkedsetting_test.php b/tests/commandsetactivitylinkedsetting_test.php
index 02b32e8..96222cc 100644
--- a/tests/commandsetactivitylinkedsetting_test.php
+++ b/tests/commandsetactivitylinkedsetting_test.php
@@ -43,19 +43,40 @@
* @copyright 2012 the Open University.
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-class commandsetactivitylinkedsetting_test extends \block_workflow_testlib {
- public function test_setcoursevisibility() {
+final class commandsetactivitylinkedsetting_test extends \block_workflow_testlib {
+
+ /** @var object current workflow*/
+ private $workflow;
+ /** @var object current step*/
+ private $step;
+
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting
+ */
+ public function test_setcoursevisibility(): void {
$command = $this->make_command();
$this->assertInstanceOf('block_workflow_command', $command);
}
+ /**
+ * Creates and returns a command instance for testing purposes.
+ *
+ * @return object The command instance created for the test.
+ */
protected function make_command() {
$this->workflow = $this->create_activity_workflow('quiz', false);
$this->step = $this->create_step($this->workflow);
return block_workflow_command::create('block_workflow_command_setactivitylinkedsetting');
}
- public function test_parse_clear() {
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting::parse method.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting::parse
+ */
+ public function test_parse_clear(): void {
$command = $this->make_command();
$result = $command->parse('block_workflow_steps by workflowid clear', $this->step);
@@ -67,7 +88,12 @@ public function test_parse_clear() {
$this->assertEquals($result->action, block_workflow_command_setactivitylinkedsetting::CLEAR);
}
- public function test_parse_set() {
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting::parse method.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting::parse
+ */
+ public function test_parse_set(): void {
$command = $this->make_command();
$result = $command->parse('block_workflow_steps by workflowid set stepno 1 name Fred', $this->step);
@@ -77,10 +103,15 @@ public function test_parse_set() {
$this->assertEquals($result->table, 'block_workflow_steps');
$this->assertEquals($result->fkcolumn, 'workflowid');
$this->assertEquals($result->action, block_workflow_command_setactivitylinkedsetting::SET);
- $this->assertEquals($result->toset, array('stepno' => '1', 'name' => 'Fred'));
+ $this->assertEquals($result->toset, ['stepno' => '1', 'name' => 'Fred']);
}
- public function test_parse_missing_by() {
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting::parse method.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting::parse
+ */
+ public function test_parse_missing_by(): void {
$command = $this->make_command();
$result = $command->parse('block_workflow_steps workflowid clear', $this->step);
@@ -89,7 +120,12 @@ public function test_parse_missing_by() {
$this->assertEquals(count($result->errors), 1);
}
- public function test_parse_missing_clear() {
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting::parse method.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting::parse
+ */
+ public function test_parse_missing_clear(): void {
$command = $this->make_command();
$result = $command->parse('block_workflow_steps by workflowid', $this->step);
@@ -98,7 +134,12 @@ public function test_parse_missing_clear() {
$this->assertEquals(count($result->errors), 1);
}
- public function test_parse_missing_neither_clear_nor_set() {
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting::parse method.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting::parse
+ */
+ public function test_parse_missing_neither_clear_nor_set(): void {
$command = $this->make_command();
$result = $command->parse('block_workflow_steps by workflowid frog', $this->step);
@@ -107,7 +148,12 @@ public function test_parse_missing_neither_clear_nor_set() {
$this->assertEquals(count($result->errors), 1);
}
- public function test_parse_junk_after_clear() {
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting::parse method.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting::parse
+ */
+ public function test_parse_junk_after_clear(): void {
$command = $this->make_command();
$result = $command->parse('block_workflow_steps by workflowid clear junk', $this->step);
@@ -116,7 +162,12 @@ public function test_parse_junk_after_clear() {
$this->assertEquals(count($result->errors), 1);
}
- public function test_parse_cols_values_mismatched() {
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting::parse method.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting::parse
+ */
+ public function test_parse_cols_values_mismatched(): void {
$command = $this->make_command();
$result = $command->parse('block_workflow_steps by workflowid set name', $this->step);
@@ -125,7 +176,12 @@ public function test_parse_cols_values_mismatched() {
$this->assertEquals(count($result->errors), 1);
}
- public function test_parse_unknown_table() {
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting::parse method.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting::parse
+ */
+ public function test_parse_unknown_table(): void {
$command = $this->make_command();
$result = $command->parse('__unknown_db_table_name___ by workflowid clear', $this->step);
@@ -134,7 +190,12 @@ public function test_parse_unknown_table() {
$this->assertEquals(count($result->errors), 1);
}
- public function test_parse_unknown_fk_column() {
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting::parse method.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting::parse
+ */
+ public function test_parse_unknown_fk_column(): void {
$command = $this->make_command();
$result = $command->parse('block_workflow_steps by __unknown_column__ clear', $this->step);
@@ -143,7 +204,12 @@ public function test_parse_unknown_fk_column() {
$this->assertEquals(count($result->errors), 1);
}
- public function test_parse_unknown_set_column() {
+ /**
+ * Tests the block_workflow_command_setactivitylinkedsetting::parse method.
+ *
+ * @covers \block_workflow_command_setactivitylinkedsetting::parse
+ */
+ public function test_parse_unknown_set_column(): void {
$command = $this->make_command();
$result = $command->parse('block_workflow_steps by workflowid set name frog __unknown_column__ 1', $this->step);
diff --git a/tests/commandsetactivityvisibility_test.php b/tests/commandsetactivityvisibility_test.php
index b624a60..ab8214f 100644
--- a/tests/commandsetactivityvisibility_test.php
+++ b/tests/commandsetactivityvisibility_test.php
@@ -34,13 +34,29 @@
global $CFG;
require_once(dirname(__FILE__) . '/lib.php');
-class commandsetactivityvisibility_test extends \block_workflow_testlib {
- public function test_setactivityvisibility() {
+/**
+ * Unit tests for the commandsetactivityvisibility functionality in the block_workflow plugin.
+ *
+ * This class extends the block_workflow_testlib to provide test cases for verifying
+ * the correct behavior of activity visibility commands within the workflow block.
+ */
+final class commandsetactivityvisibility_test extends \block_workflow_testlib {
+ /**
+ * Tests setactivityvisibility.
+ *
+ * @covers \block_workflow_command_setactivityvisibility
+ */
+ public function test_setactivityvisibility(): void {
$command = new block_workflow_command_setactivityvisibility();
$this->assertInstanceOf('block_workflow_command', $command);
}
- public function test_parse_no_state_hidden() {
+ /**
+ * Tests the parse methods no state hidden.
+ *
+ * @covers \block_workflow_command_setactivityvisibility::parse
+ */
+ public function test_parse_no_state_hidden(): void {
$workflow = $this->create_activity_workflow('quiz', false);
$step = $this->create_step($workflow);
@@ -64,7 +80,12 @@ public function test_parse_no_state_hidden() {
$this->assertFalse(isset($result->id));
}
- public function test_parse_no_state_visible() {
+ /**
+ * Tests the parse methods no state visible.
+ *
+ * @covers \block_workflow_command_setactivityvisibility::parse
+ */
+ public function test_parse_no_state_visible(): void {
$workflow = $this->create_activity_workflow('quiz', false);
$step = $this->create_step($workflow);
@@ -88,7 +109,12 @@ public function test_parse_no_state_visible() {
$this->assertFalse(isset($result->id));
}
- public function test_parse_no_state_invalid_state() {
+ /**
+ * Tests the parse methods no state invalid state.
+ *
+ * @covers \block_workflow_command_setactivityvisibility::parse
+ */
+ public function test_parse_no_state_invalid_state(): void {
$workflow = $this->create_activity_workflow('quiz', false);
$step = $this->create_step($workflow);
@@ -112,7 +138,12 @@ public function test_parse_no_state_invalid_state() {
$this->assertFalse(isset($result->id));
}
- public function test_parse_no_state_appliestocourse() {
+ /**
+ * Tests the parse methods no state appliestocourse.
+ *
+ * @covers \block_workflow_command_setactivityvisibility::parse
+ */
+ public function test_parse_no_state_appliestocourse(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -133,7 +164,12 @@ public function test_parse_no_state_appliestocourse() {
$this->assertFalse(isset($result->id));
}
- public function test_parse_with_state_hidden() {
+ /**
+ * Tests the parse methods with state hidden.
+ *
+ * @covers \block_workflow_command_setactivityvisibility::parse
+ */
+ public function test_parse_with_state_hidden(): void {
$workflow = $this->create_activity_workflow('quiz', false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -161,7 +197,12 @@ public function test_parse_with_state_hidden() {
$this->assertNotNull($result->cm);
}
- public function test_parse_with_state_visible() {
+ /**
+ * Tests the parse methods with state visible.
+ *
+ * @covers \block_workflow_command_setactivityvisibility::parse
+ */
+ public function test_parse_with_state_visible(): void {
$workflow = $this->create_activity_workflow('quiz', false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -189,7 +230,12 @@ public function test_parse_with_state_visible() {
$this->assertNotNull($result->cm);
}
- public function test_parse_with_state_invalid_state() {
+ /**
+ * Tests the parse methods with state invalid state.
+ *
+ * @covers \block_workflow_command_setactivityvisibility::parse
+ */
+ public function test_parse_with_state_invalid_state(): void {
$workflow = $this->create_activity_workflow('quiz', false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -217,7 +263,12 @@ public function test_parse_with_state_invalid_state() {
$this->assertNotNull($result->cm);
}
- public function test_parse_with_state_appliestocourse() {
+ /**
+ * Tests the parse methods.
+ *
+ * @covers \block_workflow_command_setactivityvisibility::parse
+ */
+ public function test_parse_with_state_appliestocourse(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -236,7 +287,12 @@ public function test_parse_with_state_appliestocourse() {
$this->assertEquals(count($result->errors), 1);
}
- public function test_execute_hidden() {
+ /**
+ * Tests the execute methods.
+ *
+ * @covers \block_workflow_command_setactivityvisibility::execute
+ */
+ public function test_execute_hidden(): void {
global $DB;
$workflow = $this->create_activity_workflow('quiz', false);
$step = $this->create_step($workflow);
@@ -246,7 +302,7 @@ public function test_execute_hidden() {
$args = 'hidden';
// Check that the parent course is visible.
- $check = $DB->get_record('course', array('id' => $this->courseid));
+ $check = $DB->get_record('course', ['id' => $this->courseid]);
$this->assertEquals($check->visible, 1);
$module = $workflow->appliesto;
@@ -256,10 +312,10 @@ public function test_execute_hidden() {
INNER JOIN {context} c ON c.instanceid = cm.id
INNER JOIN {modules} md ON md.id = cm.module
WHERE md.name = ? AND cm.course = ? LIMIT 1";
- $instance = $DB->get_record_sql($sql, array($module, $this->courseid));
+ $instance = $DB->get_record_sql($sql, [$module, $this->courseid]);
// Check that the activity visibility is currently visible.
- $check = $DB->get_record('course_modules', array('id' => $instance->id));
+ $check = $DB->get_record('course_modules', ['id' => $instance->id]);
$this->assertEquals($check->visible, 1);
// Execute.
@@ -267,11 +323,11 @@ public function test_execute_hidden() {
$class->execute($args, $state);
// Check that the activity visibility is now hidden.
- $check = $DB->get_record('course_modules', array('id' => $instance->id));
+ $check = $DB->get_record('course_modules', ['id' => $instance->id]);
$this->assertEquals($check->visible, 0);
// This should not have affected the parent courses visibility.
- $check = $DB->get_record('course', array('id' => $this->courseid));
+ $check = $DB->get_record('course', ['id' => $this->courseid]);
$this->assertEquals($check->visible, 1);
}
}
diff --git a/tests/commandsetcoursevisibility_test.php b/tests/commandsetcoursevisibility_test.php
index 2576c2e..c6eab6f 100644
--- a/tests/commandsetcoursevisibility_test.php
+++ b/tests/commandsetcoursevisibility_test.php
@@ -34,13 +34,26 @@
global $CFG;
require_once(dirname(__FILE__) . '/lib.php');
-class commandsetcoursevisibility_test extends \block_workflow_testlib {
- public function test_setcoursevisibility() {
+/**
+ * Unit tests for the commandsetcoursevisibility class in the block_workflow plugin.
+ */
+final class commandsetcoursevisibility_test extends \block_workflow_testlib {
+ /**
+ * Tests the block_workflow_command_setcoursevisibility method.
+ *
+ * @covers \block_workflow_command_setcoursevisibility
+ */
+ public function test_setcoursevisibility(): void {
$command = new block_workflow_command_setcoursevisibility();
$this->assertInstanceOf('block_workflow_command', $command);
}
- public function test_parse_no_state_hidden() {
+ /**
+ * Tests the block_workflow_command_setcoursevisibility parse method no state hidden.
+ *
+ * @covers \block_workflow_command_setcoursevisibility::parse
+ */
+ public function test_parse_no_state_hidden(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -64,7 +77,12 @@ public function test_parse_no_state_hidden() {
$this->assertFalse((bool)isset($result->id));
}
- public function test_parse_no_state_visible() {
+ /**
+ * Tests the block_workflow_command_setcoursevisibility parse method no state visible.
+ *
+ * @covers \block_workflow_command_setcoursevisibility::parse
+ */
+ public function test_parse_no_state_visible(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -88,7 +106,12 @@ public function test_parse_no_state_visible() {
$this->assertFalse((bool)isset($result->id));
}
- public function test_parse_no_state_invalid_state() {
+ /**
+ * Tests the block_workflow_command_setcoursevisibility parse method no state invalid state.
+ *
+ * @covers \block_workflow_command_setcoursevisibility::parse
+ */
+ public function test_parse_no_state_invalid_state(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -112,7 +135,12 @@ public function test_parse_no_state_invalid_state() {
$this->assertFalse((bool)isset($result->id));
}
- public function test_parse_no_state_appliestoactivity() {
+ /**
+ * Tests the block_workflow_command_setcoursevisibility parse method no state appliestoactivity.
+ *
+ * @covers \block_workflow_command_setcoursevisibility::parse
+ */
+ public function test_parse_no_state_appliestoactivity(): void {
$workflow = $this->create_activity_workflow('quiz', false);
$step = $this->create_step($workflow);
@@ -133,7 +161,12 @@ public function test_parse_no_state_appliestoactivity() {
$this->assertFalse((bool)isset($result->id));
}
- public function test_parse_with_state_hidden() {
+ /**
+ * Tests the block_workflow_command_setcoursevisibility parse method with state hidden.
+ *
+ * @covers \block_workflow_command_setcoursevisibility::parse
+ */
+ public function test_parse_with_state_hidden(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -158,7 +191,12 @@ public function test_parse_with_state_hidden() {
$this->assertEquals($result->id, $this->courseid);
}
- public function test_parse_with_state_visible() {
+ /**
+ * Tests the block_workflow_command_setcoursevisibility parse method with state visible.
+ *
+ * @covers \block_workflow_command_setcoursevisibility::parse
+ */
+ public function test_parse_with_state_visible(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -183,7 +221,12 @@ public function test_parse_with_state_visible() {
$this->assertEquals($result->id, $this->courseid);
}
- public function test_parse_with_state_invalid_state() {
+ /**
+ * Tests the block_workflow_command_setcoursevisibility parse method with state invalid state.
+ *
+ * @covers \block_workflow_command_setcoursevisibility::parse
+ */
+ public function test_parse_with_state_invalid_state(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -208,7 +251,12 @@ public function test_parse_with_state_invalid_state() {
$this->assertEquals($result->id, $this->courseid);
}
- public function test_parse_with_state_appliestoactivity() {
+ /**
+ * Tests the block_workflow_command_setcoursevisibility parse method with state appliestoactivity.
+ *
+ * @covers \block_workflow_command_setcoursevisibility::parse
+ */
+ public function test_parse_with_state_appliestoactivity(): void {
$workflow = $this->create_activity_workflow('quiz', false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -227,7 +275,12 @@ public function test_parse_with_state_appliestoactivity() {
$this->assertEquals(count($result->errors), 1);
}
- public function test_execute_hidden() {
+ /**
+ * Tests the block_workflow_command_setcoursevisibility execute hidden method.
+ *
+ * @covers \block_workflow_command_setcoursevisibility::execute
+ */
+ public function test_execute_hidden(): void {
global $DB;
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -237,7 +290,7 @@ public function test_execute_hidden() {
$args = 'hidden';
// Check that the course visibility is currently visible.
- $check = $DB->get_record('course', array('id' => $this->courseid));
+ $check = $DB->get_record('course', ['id' => $this->courseid]);
$this->assertEquals($check->visible, 1);
// Try parsing without a context.
@@ -245,7 +298,7 @@ public function test_execute_hidden() {
$class->execute($args, $state);
// Check that the course visibility is now hidden.
- $check = $DB->get_record('course', array('id' => $this->courseid));
+ $check = $DB->get_record('course', ['id' => $this->courseid]);
$this->assertEquals($check->visible, 0);
}
}
diff --git a/tests/commandsetgradeitemvisibility_test.php b/tests/commandsetgradeitemvisibility_test.php
index 45c1054..df5ed96 100644
--- a/tests/commandsetgradeitemvisibility_test.php
+++ b/tests/commandsetgradeitemvisibility_test.php
@@ -35,22 +35,41 @@
require_once(dirname(__FILE__) . '/lib.php');
require_once($CFG->dirroot.'/lib/grade/grade_item.php');
-class commandsetgradeitemvisibility_test extends \block_workflow_testlib {
+/**
+ * Unit tests for the commandsetgradeitemvisibility class in the block_workflow plugin.
+ */
+final class commandsetgradeitemvisibility_test extends \block_workflow_testlib {
+ /**
+ * Generates a module instance of the specified type.
+ *
+ * @param string $modname The name of the module to generate.
+ * @return mixed The generated module instance.
+ */
private function generate_module($modname) {
global $CFG;
if (!is_readable($CFG->dirroot . '/mod/externalquiz/tests/generator/lib.php')) {
$this->markTestSkipped('This test requires mod_externalquiz to be installed.');
}
$generator = $this->getDataGenerator()->get_plugin_generator('mod_' . $modname);
- return $generator->create_instance(array('course' => $this->courseid));
+ return $generator->create_instance(['course' => $this->courseid]);
}
- public function test_setgradeitemvisibility() {
+ /**
+ * Tests the setgradeitemvisibility method.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility
+ */
+ public function test_setgradeitemvisibility(): void {
$command = new block_workflow_command_setgradeitemvisibility();
$this->assertInstanceOf('block_workflow_command', $command);
}
- public function test_parse_no_state_visible() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility parse no state visible.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::parse
+ */
+ public function test_parse_no_state_visible(): void {
$workflow = $this->create_activity_workflow('assign', false);
$step = $this->create_step($workflow);
@@ -74,7 +93,12 @@ public function test_parse_no_state_visible() {
$this->assertFalse(isset($result->id));
}
- public function test_parse_no_state_hidden() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility parse no state hidden.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::parse
+ */
+ public function test_parse_no_state_hidden(): void {
$workflow = $this->create_activity_workflow('assign', false);
$step = $this->create_step($workflow);
@@ -98,7 +122,12 @@ public function test_parse_no_state_hidden() {
$this->assertFalse(isset($result->id));
}
- public function test_parse_no_state_invalid_state() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility parse no state invalid state.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::parse
+ */
+ public function test_parse_no_state_invalid_state(): void {
$workflow = $this->create_activity_workflow('assign', false);
$step = $this->create_step($workflow);
@@ -114,8 +143,8 @@ public function test_parse_no_state_invalid_state() {
// There should be one error.
$this->assertEquals(count($result->errors), 1);
- $this->assertEquals($result->errors, array(
- get_string('invalidvisibilitysetting', 'block_workflow', $args)));
+ $this->assertEquals($result->errors, [
+ get_string('invalidvisibilitysetting', 'block_workflow', $args)]);
// Test: $result should have no visible.
$this->assertFalse(isset($result->visibility));
@@ -124,7 +153,12 @@ public function test_parse_no_state_invalid_state() {
$this->assertFalse(isset($result->id));
}
- public function test_parse_no_state_appliestocourse() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility parse no state appliestocourse.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::parse
+ */
+ public function test_parse_no_state_appliestocourse(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -140,14 +174,19 @@ public function test_parse_no_state_appliestocourse() {
// There should be one error.
$this->assertEquals(count($result->errors), 1);
- $this->assertEquals($result->errors, array(
- get_string('notanactivity', 'block_workflow', 'setgradeitemvisibility')));
+ $this->assertEquals($result->errors, [
+ get_string('notanactivity', 'block_workflow', 'setgradeitemvisibility')]);
// Test: $result should have no id.
$this->assertFalse(isset($result->id));
}
- public function test_parse_no_state_appliesto_a_activity_which_controls_gradeitemvisibility() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility parse no state applies.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::parse
+ */
+ public function test_parse_no_state_appliesto_a_activity_which_controls_gradeitemvisibility(): void {
$workflow = $this->create_activity_workflow('quiz', false);
$step = $this->create_step($workflow);
@@ -160,11 +199,16 @@ public function test_parse_no_state_appliesto_a_activity_which_controls_gradeite
// There should be one error.
$this->assertEquals(count($result->errors), 1);
- $this->assertEquals($result->errors, array(
- get_string('notcontrollablegradeitem', 'block_workflow', 'setgradeitemvisibility')));
+ $this->assertEquals($result->errors, [
+ get_string('notcontrollablegradeitem', 'block_workflow', 'setgradeitemvisibility')]);
}
- public function test_parse_with_state_visible() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility parse with state visible.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::parse
+ */
+ public function test_parse_with_state_visible(): void {
$this->generate_module('assign');
$workflow = $this->create_activity_workflow('assign', false);
$step = $this->create_step($workflow);
@@ -190,7 +234,12 @@ public function test_parse_with_state_visible() {
$this->assertEquals('assign', $result->cm->modname);
}
- public function test_parse_with_state_hidden() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility parse with state hidden.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::parse
+ */
+ public function test_parse_with_state_hidden(): void {
$this->generate_module('forum');
$workflow = $this->create_activity_workflow('forum', false);
$step = $this->create_step($workflow);
@@ -216,7 +265,12 @@ public function test_parse_with_state_hidden() {
$this->assertEquals('forum', $result->cm->modname);
}
- public function test_parse_with_state_invalid_state() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility parse with state invalid state.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::parse
+ */
+ public function test_parse_with_state_invalid_state(): void {
$this->generate_module('assign');
$workflow = $this->create_activity_workflow('assign', false);
$step = $this->create_step($workflow);
@@ -242,7 +296,12 @@ public function test_parse_with_state_invalid_state() {
$this->assertEquals('assign', $result->cm->modname);
}
- public function test_parse_with_state_appliestocourse() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility parse with state appliestocourse.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::parse
+ */
+ public function test_parse_with_state_appliestocourse(): void {
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -255,15 +314,21 @@ public function test_parse_with_state_appliestocourse() {
$result = $class->parse($args, $step, $state);
// Test: $result should have have the validation error.
- $this->assertEquals(array(get_string('notanactivity', 'block_workflow', 'setgradeitemvisibility')),
+ $this->assertEquals([get_string('notanactivity', 'block_workflow', 'setgradeitemvisibility')],
$result->errors);
// There should be one error.
$this->assertCount(1, $result->errors);
}
- public function test_parse_with_state_no_support_for_grade() {
- $workflow = $this->create_activity_workflow('chat', false);
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility parse methods with state no support for grade.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::parse
+ */
+ public function test_parse_with_state_no_support_for_grade(): void {
+ $this->generate_module('forum');
+ $workflow = $this->create_activity_workflow('forum', false);
$step = $this->create_step($workflow);
$state = $this->assign_workflow($workflow);
@@ -274,20 +339,25 @@ public function test_parse_with_state_no_support_for_grade() {
$result = $class->parse($args, $step, $state);
// Test: $result should have have the validation error.
- $this->assertEquals(array(get_string('notgradesupported', 'block_workflow', 'setgradeitemvisibility')),
+ $this->assertEquals([get_string('notgradesupported', 'block_workflow', 'setgradeitemvisibility')],
$result->errors);
$this->assertCount(1, $result->errors);
}
- public function test_execute_hidden() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility execute hidden methods.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::execute
+ */
+ public function test_execute_hidden(): void {
global $DB;
$assign = $this->generate_module('externalquiz');
// Check the value of the field hidden in grade_items table before executing setgradeitemvisibility command.
$hiddenfieldbefore = $DB->get_field('grade_items', 'hidden',
- array('courseid' => $this->courseid, 'itemtype' => 'mod',
- 'itemmodule' => 'externalquiz', 'iteminstance' => $assign->id));
+ ['courseid' => $this->courseid, 'itemtype' => 'mod',
+ 'itemmodule' => 'externalquiz', 'iteminstance' => $assign->id]);
$this->assertEquals($hiddenfieldbefore, 0);
// Create a workflow which applies to 'assign' module with one step.
@@ -298,23 +368,28 @@ public function test_execute_hidden() {
$wfc = block_workflow_command::create('block_workflow_command_setgradeitemvisibility');
$wfc->execute('hidden', $state);
$hiddenfieldafter = $DB->get_field('grade_items', 'hidden',
- array('courseid' => $this->courseid, 'itemtype' => 'mod',
- 'itemmodule' => 'externalquiz', 'iteminstance' => $assign->id));
+ ['courseid' => $this->courseid, 'itemtype' => 'mod',
+ 'itemmodule' => 'externalquiz', 'iteminstance' => $assign->id]);
$this->assertEquals($hiddenfieldafter, 1);
}
- public function test_execute_visible() {
+ /**
+ * Tests the block_workflow_command_setgradeitemvisibility execute methods.
+ *
+ * @covers \block_workflow_command_setgradeitemvisibility::execute
+ */
+ public function test_execute_visible(): void {
global $DB;
$assign = $this->generate_module('externalquiz');
$DB->set_field('grade_items', 'hidden', 1,
- array('courseid' => $this->courseid, 'itemtype' => 'mod',
- 'itemmodule' => 'externalquiz', 'iteminstance' => $assign->id));
+ ['courseid' => $this->courseid, 'itemtype' => 'mod',
+ 'itemmodule' => 'externalquiz', 'iteminstance' => $assign->id]);
// Check the value of the field hidden in grade_items table before executing setgradeitemvisibility command.
$hiddenfieldbefore = $DB->get_field('grade_items', 'hidden',
- array('courseid' => $this->courseid, 'itemtype' => 'mod',
- 'itemmodule' => 'externalquiz', 'iteminstance' => $assign->id));
+ ['courseid' => $this->courseid, 'itemtype' => 'mod',
+ 'itemmodule' => 'externalquiz', 'iteminstance' => $assign->id]);
$this->assertEquals($hiddenfieldbefore, 1);
// Create a workflow which applies to 'assign' module with one step.
@@ -325,8 +400,8 @@ public function test_execute_visible() {
$wfc = block_workflow_command::create('block_workflow_command_setgradeitemvisibility');
$wfc->execute('visible', $state);
$hiddenfieldafter = $DB->get_field('grade_items', 'hidden',
- array('courseid' => $this->courseid, 'itemtype' => 'mod',
- 'itemmodule' => 'externalquiz', 'iteminstance' => $assign->id));
+ ['courseid' => $this->courseid, 'itemtype' => 'mod',
+ 'itemmodule' => 'externalquiz', 'iteminstance' => $assign->id]);
$this->assertEquals($hiddenfieldafter, 0);
}
}
diff --git a/tests/emails_test.php b/tests/emails_test.php
index 189f6fb..2238c56 100644
--- a/tests/emails_test.php
+++ b/tests/emails_test.php
@@ -35,8 +35,16 @@
global $CFG;
require_once(dirname(__FILE__) . '/lib.php');
-class emails_test extends \block_workflow_testlib {
- public function test_email_validation() {
+/**
+ * Unit tests for email-related functionality in the block_workflow plugin.
+ */
+final class emails_test extends \block_workflow_testlib {
+ /**
+ * Tests the block_workflow_email::create method.
+ *
+ * @covers \block_workflow_email::create
+ */
+ public function test_email_validation(): void {
$data = new stdClass();
$email = new block_workflow_email();
@@ -68,7 +76,12 @@ public function test_email_validation() {
unset($data->badfield);
}
- public function test_email_create() {
+ /**
+ * Tests the block_workflow_email::create method.
+ *
+ * @covers \block_workflow_email::create
+ */
+ public function test_email_create(): void {
$data = new stdClass();
$data->shortname = 'shortname';
$data->subject = 'Example Subject';
@@ -80,7 +93,7 @@ public function test_email_create() {
$return = $email->create($data);
// The variable $email should match the entered data.
- $this->compare_email($data, $email, array('id'));
+ $this->compare_email($data, $email, ['id']);
// Check that the return value is also a block_workflow_email.
$this->assertInstanceOf('block_workflow_email', $return);
@@ -89,7 +102,7 @@ public function test_email_create() {
$this->assertInstanceOf('block_workflow_email', $email);
// And the two should match.
- $this->compare_email($data, $email, array());
+ $this->compare_email($data, $email, []);
// And trying to create another email with the same (valid) data should result in an
// exception because the shortname is already in use.
@@ -109,7 +122,12 @@ public function test_email_create() {
$data->shortname = 'newshortname';
}
- public function test_email_update() {
+ /**
+ * Tests the block_workflow_email::update method.
+ *
+ * @covers \block_workflow_email::update
+ */
+ public function test_email_update(): void {
$data = new stdClass();
$data->shortname = 'shortname';
$data->subject = 'Example Subject';
@@ -121,7 +139,7 @@ public function test_email_update() {
$return = $email->create($data);
// The variable $email should match the entered data.
- $this->compare_email($data, $email, array('id'));
+ $this->compare_email($data, $email, ['id']);
// Check that the return value is also a block_workflow_email.
$this->assertInstanceOf('block_workflow_email', $return);
@@ -130,7 +148,7 @@ public function test_email_update() {
$this->assertInstanceOf('block_workflow_email', $email);
// And the two should match.
- $this->compare_email($data, $email, array());
+ $this->compare_email($data, $email, []);
// Check validation on e-mail updates.
$data->shortname = 'newshortname';
@@ -143,7 +161,12 @@ public function test_email_update() {
$this->assertEquals($updated->shortname, 'shortname');
}
- public function test_email_update_validation_exception() {
+ /**
+ * Tests the block_workflow_email::update method.
+ *
+ * @covers \block_workflow_email::update
+ */
+ public function test_email_update_validation_exception(): void {
$email = $this->create_email();
$data = new stdClass();
@@ -154,7 +177,12 @@ public function test_email_update_validation_exception() {
unset($data->badfield);
}
- public function test_email_update_validation() {
+ /**
+ * Tests the block_workflow_email::update method.
+ *
+ * @covers \block_workflow_email::update
+ */
+ public function test_email_update_validation(): void {
$email = $this->create_email();
$data = new stdClass();
// And change the shortname.
@@ -163,7 +191,12 @@ public function test_email_update_validation() {
$this->compare_email($data, $email);
}
- public function test_email_duplicate_shortnames_exception() {
+ /**
+ * Tests the block_workflow_email::create method.
+ *
+ * @covers \block_workflow_email::create
+ */
+ public function test_email_duplicate_shortnames_exception(): void {
// Create an e-mail with shortname 'shortname'.
$this->create_email('shortname');
$email = new block_workflow_email();
@@ -178,7 +211,12 @@ public function test_email_duplicate_shortnames_exception() {
$email, 'create', $data);
}
- public function test_email_duplicate_shortnames() {
+ /**
+ * Tests the block_workflow_email::update method.
+ *
+ * @covers \block_workflow_email::update
+ */
+ public function test_email_duplicate_shortnames(): void {
// Create an e-mail with shortname 'shortname'.
$this->create_email('shortname');
$email = new block_workflow_email();
@@ -196,7 +234,12 @@ public function test_email_duplicate_shortnames() {
$email, 'update', $data);
}
- public function test_email_loading() {
+ /**
+ * Tests the block_workflow_email::load_email_shortname method.
+ *
+ * @covers \block_workflow_email::load_email_shortname
+ */
+ public function test_email_loading(): void {
// Create a new e-mail.
$email = $this->create_email('shortname');
@@ -229,7 +272,12 @@ public function test_email_loading() {
}
- public function test_email_listing() {
+ /**
+ * Tests the block_workflow_email::load_emails method.
+ *
+ * @covers \block_workflow_email::load_emails
+ */
+ public function test_email_listing(): void {
// Initially we should have no emails.
$list = block_workflow_email::load_emails();
$this->assertEquals(count($list), 0);
@@ -256,7 +304,12 @@ public function test_email_listing() {
$this->assertEquals(count($list), 1);
}
- public function test_email_not_used() {
+ /**
+ * Tests the block_workflow_command::is_deletable method.
+ *
+ * @covers \block_workflow_email::is_deletable
+ */
+ public function test_email_not_used(): void {
// Create a new e-mail.
$email = $this->create_email('shortname');
@@ -381,4 +434,50 @@ public function test_email_not_used() {
// And we shouldn't throw an exception when deleting.
$email->delete();
}
+
+ /**
+ * Tests the block_workflow_command::execute method.
+ *
+ * @covers \block_workflow_command::execute
+ */
+ public function test_email_send_failed(): void {
+ // The workflow system has some logic (which I think is no longer required)
+ // which stops it from sending messages if a transaction is in progress.
+ // We should probably untangle that one day, but for now.
+ $this->preventResetByRollback();
+
+ // Disable the send email feature so message_send function will always fail.
+ set_config('block_workflow_notification_disable', 1, 'message');
+
+ // Create a new template e-mail.
+ $this->create_email('shortname');
+
+ $workflow = $this->create_workflow(false);
+ $this->create_step($workflow);
+ $state = $this->assign_workflow($workflow);
+ $sink = $this->redirectEvents();
+
+ // This command should assign and send email template to student.
+ $command = 'shortname to student';
+ $emailcommand = \block_workflow_command::create('block_workflow_command_email');
+ // Check that we throw an exception with correct error message.
+ $emailcommand->execute($command, $state);
+ $events = $sink->get_events();
+ $event = reset($events);
+ // Check that the event data is valid.
+ $this->assertInstanceOf('\block_workflow\event\email_sent_status', $event);
+ $this->assertStringContainsString("Failed send email 'Example subject' to egstudent@localhost.com",
+ $event->other['error']);
+ $this->assertStringContainsString("The email to user with id", $event->get_description());
+
+ // Test send email successfully.
+ $sink = $this->redirectEvents();
+ set_config('block_workflow_notification_disable', 0, 'message');
+ $emailcommand->execute($command, $state);
+ $events = $sink->get_events();
+ // The first event is core\event\notification_sent.
+ // Check that the event data is valid.
+ $this->assertInstanceOf('\block_workflow\event\email_sent_status', $events[1]);
+ $this->assertStringContainsString("The email was successfully sent to user with id", $events[1]->get_description());
+ }
}
diff --git a/tests/external/external_api_base_lib.php b/tests/external/external_api_base_lib.php
new file mode 100644
index 0000000..4b24c08
--- /dev/null
+++ b/tests/external/external_api_base_lib.php
@@ -0,0 +1,119 @@
+.
+
+namespace block_workflow\external;
+use externallib_advanced_testcase;
+use block_workflow_workflow;
+use block_workflow_step;
+
+defined('MOODLE_INTERNAL') || die();
+global $CFG;
+require_once($CFG->dirroot . '/webservice/tests/helpers.php');
+
+/**
+ * Mocking data and common function for all the web service tests.
+ *
+ * @package block_workflow
+ * @copyright 2023 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class external_api_base_lib extends externallib_advanced_testcase {
+
+ /**
+ * @var int|null ID of the first workflow state, or null if not set.
+ */
+ protected $state1id = null;
+ /**
+ * @var mixed|null Step 1 variable, initialized as null.
+ */
+ protected $step1 = null;
+ /**
+ * @var mixed|null Stores the second step in the workflow, or null if not set.
+ */
+ protected $step2 = null;
+ /**
+ * Example student user object for testing purposes.
+ *
+ * @var mixed|null
+ */
+ protected $egstudent = null;
+ /**
+ * @var stdClass|null The course object associated with the test, or null if not set.
+ */
+ protected $course = null;
+ /**
+ * @var int|null The ID of the student role, or null if not set.
+ */
+ protected $studenroleid = null;
+
+ #[\Override]
+ public function setUp(): void {
+ $this->resetAfterTest();
+ $this->setAdminUser();
+ global $DB;
+
+ $generator = $this->getDataGenerator();
+ $this->course = $generator->create_course(['shortname' => 'X943-12K']);
+ $coursecontext = \context_course::instance($this->course->id);
+
+ $this->egstudent = $generator->create_user(['username' => 'egstudent']);
+
+ $roleids = $DB->get_records_menu('role', null, '', 'shortname,id');
+ $this->studenroleid = $roleids['student'];
+
+ $manualenrol = enrol_get_plugin('manual');
+ $manualenrol->add_default_instance($this->course);
+ $instance1 = $DB->get_record('enrol', ['enrol' => 'manual', 'courseid' => $this->course->id]);
+ $manualenrol->enrol_user($instance1, $this->egstudent->id, $roleids['student']);
+ // Create a new workflow object.
+ $workflow = new block_workflow_workflow();
+
+ // Create a new workflow.
+ $data = new \stdClass();
+ $data->shortname = 'courseworkflow';
+ $data->name = 'First course workflow';
+ $data->appliesto = 'course';
+ $data->obsolete = 0;
+ $data->description = 'This is a test workflow applying to a course for the unit test';
+ $data->descriptionformat = FORMAT_HTML;
+ // Create_workflow will return a completed workflow object.
+ $workflow->create_workflow($data);
+
+ // When creating a workflow, the initial step will have automatically been created.
+ // Retrieve the list of steps.
+ $steps = $workflow->steps();
+ $step = array_pop($steps);
+ $this->step1 = new block_workflow_step($step->id);
+ // Update the first step to have some scripts.
+ $step->onactivescript = 'assignrole teacher to student';
+ $this->step1->update_step($step);
+
+ // Create a new step in the workflow.
+ $nsdata = new \stdClass();
+ $nsdata->workflowid = $workflow->id;
+ $nsdata->name = 'Second step';
+ $nsdata->instructions = 'New instructions';
+ $nsdata->instructionsformat = FORMAT_HTML;
+ $nsdata->onactivescript = 'setcoursevisibility visible';
+ $nsdata->oncompletescript = 'setcoursevisibility hidden';
+
+ $newstep = new block_workflow_step();
+ $this->step2 = $newstep->create_step($nsdata);
+ $state = $workflow->add_to_context($coursecontext->id);
+ $state->update_comment('
Sample Comment
', FORMAT_HTML);
+ $this->state1id = $state->id;
+ }
+}
diff --git a/tests/external/finish_step_test.php b/tests/external/finish_step_test.php
new file mode 100644
index 0000000..b19c604
--- /dev/null
+++ b/tests/external/finish_step_test.php
@@ -0,0 +1,67 @@
+.
+
+namespace block_workflow\external;
+use block_workflow_step_state;
+
+defined('MOODLE_INTERNAL') || die();
+// Include api test library so that we can use the same mocking system for all tests.
+require_once(dirname(__FILE__) . '/external_api_base_lib.php');
+
+/**
+ * Unit tests for the finish_step web service.
+ *
+ * @package block_workflow
+ * @copyright 2023 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+final class finish_step_test extends external_api_base_lib {
+
+ /**
+ * Test finish step run successfully.
+ *
+ * @covers \finish_step::execute
+ */
+ public function test_finish_step(): void {
+ // Call the external service function.
+ $returnvalue = finish_step::execute($this->state1id, 'Finish comment', FORMAT_HTML);
+
+ // We need to execute the return values cleaning process to simulate
+ // the web service server.
+ $returnvalue = \core_external\external_api::clean_returnvalue(
+ finish_step::execute_returns(),
+ $returnvalue
+ );
+ // Load the updated data for two states.
+ $state1 = new block_workflow_step_state($this->state1id);
+ $state2 = new block_workflow_step_state($returnvalue['stateid']);
+
+ // Verify step 1 is complete.
+ $this->assertEquals($this->step1->id, $state1->stepid);
+ $this->assertEquals(BLOCK_WORKFLOW_STATE_COMPLETED, $state1->state);
+
+ // Verify step 2 is active.
+ $this->assertEquals($this->step2->id, $state2->stepid);
+ $this->assertEquals(BLOCK_WORKFLOW_STATE_ACTIVE, $state2->state);
+ // Finish step state 2.
+ $returnvalue = finish_step::execute($state2->id, 'Finish comment', FORMAT_HTML);
+ $state2 = new block_workflow_step_state($state2->id);
+ // Verify step 2 is complete.
+ $this->assertEquals(BLOCK_WORKFLOW_STATE_COMPLETED, $state2->state);
+ // We should return the listofworkflows.
+ $this->assertEquals(1, $returnvalue['listworkflows']);
+ }
+}
diff --git a/tests/external/get_step_state_comment_test.php b/tests/external/get_step_state_comment_test.php
new file mode 100644
index 0000000..be6ec03
--- /dev/null
+++ b/tests/external/get_step_state_comment_test.php
@@ -0,0 +1,67 @@
+.
+
+namespace block_workflow\external;
+
+defined('MOODLE_INTERNAL') || die();
+// Include api test library so that we can use the same mocking system for all tests.
+require_once(dirname(__FILE__) . '/external_api_base_lib.php');
+
+/**
+ * Unit tests for the get_step_state_comment webservice.
+ *
+ * @package block_workflow
+ * @copyright 2023 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+final class get_step_state_comment_test extends external_api_base_lib {
+
+ /**
+ * Test get step state comment successfully.
+ *
+ * @covers \get_step_state_comment::execute
+ */
+ public function test_get_step_state_comment(): void {
+ // Call the external service function.
+ $returnvalue = get_step_state_comment::execute($this->state1id);
+
+ // We need to execute the return values cleaning process to simulate
+ // the web service server.
+ $returnvalue = \core_external\external_api::clean_returnvalue(
+ get_step_state_comment::execute_returns(),
+ $returnvalue
+ );
+ $this->assertEquals('
Sample Comment
', $returnvalue['response']);
+ }
+
+ /**
+ * Test get step state comment without capability.
+ *
+ * @covers \get_step_state_comment::execute
+ * @runInSeparateProcess
+ */
+ public function test_get_step_state_comment_failed(): void {
+ $this->resetAfterTest();
+ $this->setUser($this->egstudent);
+
+ // Remove the required capabilities by the external function.
+ $context = \context_course::instance($this->course->id);
+ $this->unassignUserCapability('block/workflow:dostep', $context->id, $this->studenroleid, $this->course->id);
+ // User can't make change in block.
+ $this->expectExceptionMessage(get_string('notallowedtodothisstep', 'block_workflow'));
+ get_step_state_comment::execute($this->state1id);
+ }
+}
diff --git a/tests/external/update_step_state_comment_test.php b/tests/external/update_step_state_comment_test.php
new file mode 100644
index 0000000..fea6da8
--- /dev/null
+++ b/tests/external/update_step_state_comment_test.php
@@ -0,0 +1,50 @@
+.
+
+namespace block_workflow\external;
+
+defined('MOODLE_INTERNAL') || die();
+// Include api test library so that we can use the same mocking system for all tests.
+require_once(dirname(__FILE__) . '/external_api_base_lib.php');
+
+/**
+ * Unit tests for the update_step_state_comment webservice.
+ *
+ * @package block_workflow
+ * @copyright 2023 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+final class update_step_state_comment_test extends external_api_base_lib {
+
+ /**
+ * Test update step_state comment successfully.
+ *
+ * @covers \update_step_state_comment::execute
+ */
+ public function test_update_step_state_comment(): void {
+ // Call the external service function.
+ $returnvalue = update_step_state_comment::execute($this->state1id,
+ '
New comment', FORMAT_HTML);
+
+ // We need to execute the return values cleaning process to simulate
+ // the web service server.
+ $returnvalue = \core_external\external_api::clean_returnvalue(
+ update_step_state_comment::execute_returns(),
+ $returnvalue
+ );
+ $this->assertEquals('
New comment', $returnvalue['response']);
+ }
+}
diff --git a/tests/external/update_step_state_task_state_test.php b/tests/external/update_step_state_task_state_test.php
new file mode 100644
index 0000000..3e91aca
--- /dev/null
+++ b/tests/external/update_step_state_task_state_test.php
@@ -0,0 +1,56 @@
+.
+
+namespace block_workflow\external;
+
+defined('MOODLE_INTERNAL') || die();
+// Include api test library so that we can use the same mocking system for all tests.
+require_once(dirname(__FILE__) . '/external_api_base_lib.php');
+
+/**
+ * Unit tests for the update_step_state_task_state webservice.
+ *
+ * @package block_workflow
+ * @copyright 2023 The Open University
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+final class update_step_state_task_state_test extends external_api_base_lib {
+
+ /**
+ * Test update update_step_state_task_state successfully.
+ *
+ * @covers \update_step_state_task_state::execute
+ */
+ public function test_update_step_state_task_state(): void {
+ // Create a new to-do.
+ $todo = new \block_workflow_todo();
+ $data = new \stdClass();
+ $data->stepid = $this->step1->id;
+ $data->task = 'TASK ONE';
+ $todo->create_todo($data);
+
+ // Call the external service function.
+ $returnvalue = update_step_state_task_state::execute($this->state1id, $todo->id, true);
+
+ // We need to execute the return values cleaning process to simulate
+ // the web service server.
+ $returnvalue = \core_external\external_api::clean_returnvalue(
+ update_step_state_task_state::execute_returns(),
+ $returnvalue
+ );
+ $this->assertEquals(1, $returnvalue['response']);
+ }
+}
diff --git a/tests/extranotify_test.php b/tests/extranotify_test.php
index 9a893a2..e690ead 100644
--- a/tests/extranotify_test.php
+++ b/tests/extranotify_test.php
@@ -34,8 +34,20 @@
require_once($CFG->dirroot . '/blocks/workflow/locallib.php');
require_once($CFG->dirroot . '/blocks/workflow/tests/lib.php');
-class extranotify_test extends \block_workflow_testlib {
- public function test_extra_notify() {
+/**
+ * Unit tests for the extranotify functionality in the block_workflow plugin.
+ *
+ * This class extends the block_workflow_testlib to provide specific test cases
+ * for the extranotify feature, ensuring correct behavior and integration within
+ * the workflow block.
+ */
+final class extranotify_test extends \block_workflow_testlib {
+ /**
+ * Tests the block_workflow_send_extra_notification methods.
+ *
+ * @covers ::block_workflow_send_extra_notification
+ */
+ public function test_extra_notify(): void {
global $CFG, $DB;
$now = time();
$after5days = $this->get_days(5);
@@ -48,11 +60,11 @@ public function test_extra_notify() {
$generator = $this->getDataGenerator();
// Create a course object.
- $course1 = $generator->create_course(array('shortname' => 'M123-12J', 'startdate' => $timestamp1));
+ $course1 = $generator->create_course(['shortname' => 'M123-12J', 'startdate' => $timestamp1]);
$coursecontext1 = \context_course::instance($course1->id);
// Create another course object.
- $course2 = $generator->create_course(array('shortname' => 'K123-12J', 'startdate' => $timestamp2));
+ $course2 = $generator->create_course(['shortname' => 'K123-12J', 'startdate' => $timestamp2]);
$coursecontext2 = \context_course::instance($course2->id);
// Generate a vl_v_crs_version_pres table.
@@ -66,7 +78,7 @@ public function test_extra_notify() {
$courseondataloadtable = $DB->get_record_sql(
'SELECT * FROM vl_v_crs_version_pres ' .
- 'WHERE vle_course_short_name = ?', array($courseshortname), MUST_EXIST);
+ 'WHERE vle_course_short_name = ?', [$courseshortname], MUST_EXIST);
// Create an email template.
$data = new \stdClass();
@@ -78,12 +90,12 @@ public function test_extra_notify() {
$email->create($data);
// Create a new workflow object which applies to course.
- $stepoptions = array('extranotify' => 'course;startdate', 'extranotifyoffset' => $before5days,
- 'onextranotifyscript' => 'email testing to manager');
+ $stepoptions = ['extranotify' => 'course;startdate', 'extranotifyoffset' => $before5days,
+ 'onextranotifyscript' => 'email testing to manager'];
list($courseworkflow, $step1) = $this->create_a_workflow_with_one_step($stepoptions);
// Required DB tables are not populated and therefore following methods return empty arrays.
- $stepoptions = array('extranotify', 'extranotifyoffset', 'onextranotifyscript');
+ $stepoptions = ['extranotify', 'extranotifyoffset', 'onextranotifyscript'];
$activesteps = block_workflow_get_active_steps_with_fields_not_null($stepoptions);
$this->assertEmpty($activesteps);
@@ -115,18 +127,23 @@ public function test_extra_notify() {
$this->assertEquals($expectedactivesteps, $activesteps);
// Check relevant fields in 'block_workflow_step_states' table before sending extra notification.
- $state = $DB->get_record('block_workflow_step_states', array('id' => $state1->id));
+ $state = $DB->get_record('block_workflow_step_states', ['id' => $state1->id]);
$this->assertEquals(BLOCK_WORKFLOW_STATE_ACTIVE, $state->state);
// Get ready active steps and finish them automatically.
block_workflow_send_extra_notification();
// Check relevant fields in 'block_workflow_step_states' table after finishing automatically.
- $stateafterfinish = $DB->get_record('block_workflow_step_states', array('id' => $state1->id));
+ $stateafterfinish = $DB->get_record('block_workflow_step_states', ['id' => $state1->id]);
$this->assertEquals(BLOCK_WORKFLOW_STATE_ACTIVE, $stateafterfinish->state);
}
- public function test_block_workflow_get_offset_time_relative_to_course() {
+ /**
+ * Tests the block_workflow_get_offset_time methods relative to course.
+ *
+ * @covers ::block_workflow_get_offset_time
+ */
+ public function test_block_workflow_get_offset_time_relative_to_course(): void {
$this->resetAfterTest();
$generator = $this->getDataGenerator();
@@ -141,7 +158,12 @@ public function test_block_workflow_get_offset_time_relative_to_course() {
$this->assertEquals(strtotime('2019-02-01'), $timestamp);
}
- public function test_block_workflow_get_offset_time_relative_to_quiz() {
+ /**
+ * Tests the block_workflow_get_offset_time methods relative to quiz.
+ *
+ * @covers ::block_workflow_get_offset_time
+ */
+ public function test_block_workflow_get_offset_time_relative_to_quiz(): void {
global $SITE;
$this->resetAfterTest();
@@ -157,7 +179,12 @@ public function test_block_workflow_get_offset_time_relative_to_quiz() {
$this->assertEquals(strtotime('2019-02-01'), $timestamp);
}
- public function test_block_workflow_get_offset_time_relative_to_crs_version_pres() {
+ /**
+ * Tests the block_workflow_get_offset_time methods.
+ *
+ * @covers ::block_workflow_get_offset_time
+ */
+ public function test_block_workflow_get_offset_time_relative_to_crs_version_pres(): void {
$this->resetAfterTest();
if (!class_exists('\local_oudataload\util') || !class_exists('local_createwebsite_utils')) {
diff --git a/tests/generator/behat_block_workflow_generator.php b/tests/generator/behat_block_workflow_generator.php
index 1fa95d5..00b7250 100644
--- a/tests/generator/behat_block_workflow_generator.php
+++ b/tests/generator/behat_block_workflow_generator.php
@@ -22,8 +22,16 @@
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
+/**
+ * Behat data generator for the block_workflow plugin.
+ */
class behat_block_workflow_generator extends behat_generator_base {
+ /**
+ * Returns an array of creatable entities for the block_workflow generator.
+ *
+ * @return array List of creatable entity.
+ */
protected function get_creatable_entities(): array {
return [
'workflows' => [
diff --git a/tests/generator/lib.php b/tests/generator/lib.php
index 6cfce04..964091e 100644
--- a/tests/generator/lib.php
+++ b/tests/generator/lib.php
@@ -28,6 +28,9 @@
require_once($CFG->dirroot . '/blocks/workflow/locallib.php');
+/**
+ * Data generator class for the block_workflow plugin.
+ */
class block_workflow_generator extends testing_block_generator {
/**
@@ -60,6 +63,12 @@ public function create_workflow(array $record): block_workflow_workflow {
return $workflow;
}
+ /**
+ * Creates a workflow step with the provided record data.
+ *
+ * @param array $record Associative array containing the workflow step data.
+ * @return block_workflow_step The created workflow step instance.
+ */
public function create_workflow_step(array $record) {
$data = (object) $record;
@@ -79,6 +88,12 @@ public function create_workflow_step(array $record) {
return $step;
}
+ /**
+ * Creates an email object for testing purposes.
+ *
+ * @param string $shortname The shortname to assign to the email. Defaults to 'TESTMAIL'.
+ * @return block_workflow_email The created email object.
+ */
public function create_email($shortname = 'TESTMAIL') {
// Create a new email template.
$email = new block_workflow_email();
@@ -90,6 +105,12 @@ public function create_email($shortname = 'TESTMAIL') {
return $email;
}
+ /**
+ * Creates a new todo item for the specified workflow step.
+ *
+ * @param object $step The workflow step to create the todo item.
+ * @return block_workflow_todo The created todo item or relevant result.
+ */
public function create_todo($step) {
// Create a new todo.
$todo = new block_workflow_todo();
diff --git a/tests/lib.php b/tests/lib.php
index e12afc8..6e1c51a 100644
--- a/tests/lib.php
+++ b/tests/lib.php
@@ -20,7 +20,6 @@
* @package block_workflow
* @copyright 2011 Lancaster University Network Services Limited
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- * @group block_workflow
*/
defined('MOODLE_INTERNAL') || die();
@@ -29,7 +28,16 @@
require_once($CFG->dirroot . '/blocks/workflow/locallib.php');
+/**
+ * Class block_workflow_testing_context_hack.
+ */
class block_workflow_testing_context_hack extends context_system {
+ /**
+ * Clears the context caches for the provided test database.
+ *
+ * @param object $testdb The test database instance whose context caches should be cleared.
+ * @return void
+ */
public static function clear_context_caches($testdb) {
// We need to reset the contexcache.
@@ -49,14 +57,32 @@ public static function clear_context_caches($testdb) {
}
}
+/**
+ * Abstract test library for the block_workflow plugin.
+ */
abstract class block_workflow_testlib extends advanced_testcase {
- // Add code coverage for the libraries.
- public static $includecoverage = array('blocks/workflow/locallib.php');
- // The test course's ID, and contextid for future reference.
+ /**
+ * @var array Add code coverage for the libraries.
+ */
+ public static $includecoverage = ['blocks/workflow/locallib.php'];
+ /**
+ * @var int The test course's ID, and contextid for future reference.
+ */
protected $courseid;
+ /**
+ * @var int The context ID associated with this instance.
+ */
protected $contextid;
+
+ /**
+ * @var array List of roles relevant to the workflow.
+ */
protected $roles;
+
+ /**
+ * @var array List of users involved in the workflow.
+ */
protected $users;
/**
@@ -107,31 +133,32 @@ public function setUp(): void {
$this->contextid = $context->id;
// Create some roles.
- $roles = array(
+ $roles = [
'manager' => 'manager',
'coursecreator' => 'coursecreator',
'teacher' => 'teacher',
'editingteacher' => 'editingteacher',
'student' => 'student',
- );
+ ];
foreach ($roles as $shortname => $archetype) {
- $role = $DB->get_record('role', array('shortname' => $shortname));
+ $role = $DB->get_record('role', ['shortname' => $shortname]);
$this->roles[$shortname] = $role->id;
}
// Create some users.
- $users = array(
+ $users = [
'egmanager' => 'manager',
'egteacher' => 'teacher',
'egeditingteacher' => 'editingteacher',
'egcoursecreator' => 'coursecreator',
'egstudent' => 'student',
- );
+ ];
foreach ($users as $username => $role) {
$user = new StdClass;
$user->username = $username;
$user->firstname = $username;
$user->lastname = $username;
+ $user->email = $username . '@localhost.com';
$user->id = $DB->insert_record('user', $user);
$assignment = new stdClass();
$assignment->roleid = $this->roles[$role];
@@ -142,7 +169,6 @@ public function setUp(): void {
}
$generator->get_plugin_generator('mod_quiz')->create_instance(['course' => $course->id]);
- $generator->get_plugin_generator('mod_chat')->create_instance(['course' => $course->id]);
}
/**
@@ -154,7 +180,7 @@ public function setUp(): void {
* @param object $step The object to compare with using assertEquals
* @param array $ignore Which fields to ignore
*/
- protected function compare_step($source, $with, $ignore = array('id', 'stepno')) {
+ protected function compare_step($source, $with, $ignore = ['id', 'stepno']) {
// If we're given a step, then grab it's expected settings.
if (is_a($source, 'block_workflow_step')) {
$fields = $source->expected_settings();
@@ -174,7 +200,7 @@ protected function compare_step($source, $with, $ignore = array('id', 'stepno'))
* @param object $workflow The object to compare with using assertEqualss
* @param array $ignore Which fields to ignore
*/
- protected function compare_workflow($source, $with, $ignore = array('id', 'shortname')) {
+ protected function compare_workflow($source, $with, $ignore = ['id', 'shortname']) {
// If we're given a workflow, then grab it's expected settings.
if (is_a($source, 'block_workflow_workflow')) {
$fields = $source->expected_settings();
@@ -194,7 +220,7 @@ protected function compare_workflow($source, $with, $ignore = array('id', 'short
* @param object $todo The object to compare with using assertEqualss
* @param array $ignore Which fields to ignore
*/
- protected function compare_email($source, $with, $ignore = array('id', 'shortname')) {
+ protected function compare_email($source, $with, $ignore = ['id', 'shortname']) {
// If we're given a todo, then grab it's expected settings.
if (is_a($source, 'block_workflow_email')) {
$fields = $source->expected_settings();
@@ -214,7 +240,7 @@ protected function compare_email($source, $with, $ignore = array('id', 'shortnam
* @param object $todo The object to compare with using assertEqualss
* @param array $ignore Which fields to ignore
*/
- protected function compare_todo($source, $with, $ignore = array('id', 'obsolete')) {
+ protected function compare_todo($source, $with, $ignore = ['id', 'obsolete']) {
// If we're given a todo, then grab it's expected settings.
if (is_a($source, 'block_workflow_todo')) {
$fields = $source->expected_settings();
@@ -225,6 +251,15 @@ protected function compare_todo($source, $with, $ignore = array('id', 'obsolete'
$this->compare_object($source, $with, $fields, $ignore);
}
+ /**
+ * Compares two objects based on specified fields, ignoring certain fields.
+ *
+ * @param object $source The source object to compare.
+ * @param object $target The target object to compare against.
+ * @param array $fields The list of fields to compare between the objects.
+ * @param array $ignore The list of fields to ignore during comparison.
+ * @return void
+ */
protected function compare_object($source, $target, $fields, $ignore) {
// Check each field.
foreach ($fields as $name) {
@@ -245,7 +280,7 @@ protected function compare_object($source, $target, $fields, $ignore) {
* @param string $command The function to run on $object
* @param mixed $args Any arguments to pass to the function
*/
- protected function expect_exception_without_halting($et, $class = null, $command) {
+ protected function expect_exception_without_halting($et, $class, $command) {
$args = func_get_args();
array_shift($args);
array_shift($args);
@@ -253,7 +288,7 @@ protected function expect_exception_without_halting($et, $class = null, $command
try {
if ($class) {
- $func = array($class, $command);
+ $func = [$class, $command];
} else {
$func = $command;
}
@@ -267,6 +302,12 @@ protected function expect_exception_without_halting($et, $class = null, $command
}
}
+ /**
+ * Creates a workflow instance for testing purposes.
+ *
+ * @param bool $createstep Whether to create a workflow step (default: true).
+ * @return block_workflow_workflow The created workflow instance or relevant test object.
+ */
protected function create_workflow($createstep = true) {
// Create a new workflow.
$data = new stdClass();
@@ -282,6 +323,12 @@ protected function create_workflow($createstep = true) {
return $workflow;
}
+ /**
+ * Creates a new step for the given workflow.
+ *
+ * @param object $workflow The workflow object to which the step will be added.
+ * @return block_workflow_step The created step object.
+ */
protected function create_step($workflow) {
// Create a new step.
$step = new block_workflow_step();
@@ -293,6 +340,12 @@ protected function create_step($workflow) {
return $step;
}
+ /**
+ * Creates an email object for testing purposes.
+ *
+ * @param string $shortname Optional. The short name to assign to the email. Default is 'TESTMAIL'.
+ * @return block_workflow_email The created email object.
+ */
protected function create_email($shortname = 'TESTMAIL') {
// Create a new todo.
$email = new block_workflow_email();
@@ -304,6 +357,12 @@ protected function create_email($shortname = 'TESTMAIL') {
return $email;
}
+ /**
+ * Creates a new todo item for the specified workflow step.
+ *
+ * @param object $step The workflow step for which to create the todo item.
+ * @return block_workflow_todo The created todo item.
+ */
protected function create_todo($step) {
// Create a new todo.
$todo = new block_workflow_todo();
@@ -314,6 +373,12 @@ protected function create_todo($step) {
return $todo;
}
+ /**
+ * Assigns a workflow to the current context or object.
+ *
+ * @param object $workflow The workflow instance.
+ * @return mixed
+ */
protected function assign_workflow($workflow) {
global $DB;
@@ -330,12 +395,19 @@ protected function assign_workflow($workflow) {
INNER JOIN {context} c ON c.instanceid = cm.id
INNER JOIN {modules} md ON md.id = cm.module
WHERE md.name = ? AND cm.course = ? LIMIT 1";
- $instance = $DB->get_record_sql($sql, array($module, $this->courseid));
+ $instance = $DB->get_record_sql($sql, [$module, $this->courseid]);
// Create the activity for this type of workflow.
return $workflow->add_to_context($instance->id);
}
+ /**
+ * Creates a workflow for a specified activity type.
+ *
+ * @param string $appliesto The type of activity the workflow applies to.
+ * @param bool $createstep Whether to create an initial step in the workflow. Defaults to true.
+ * @return block_workflow_workflow The created workflow object or relevant data structure.
+ */
protected function create_activity_workflow($appliesto, $createstep = true) {
// Create a new workflow.
$data = new stdClass();
@@ -412,6 +484,13 @@ protected function create_version_pres_tables() {
$DB->execute("TRUNCATE vl_v_crs_version_pres");
}
+ /**
+ * Calculates and returns a date based on the specified number of days before or after the current date.
+ *
+ * @param int $days The number of days to add or subtract from the current date.
+ * @param string $beforeafter Determines whether to calculate the date 'before' or 'after' the current date. Default is 'after'.
+ * @return int The calculated data.
+ */
protected function get_days($days, $beforeafter = 'after') {
if ($beforeafter === 'before') {
return -($days * 24 * 60 * 60);
@@ -452,7 +531,7 @@ protected function create_a_workflow_with_one_step($stepoptions, $appliesto = 'c
// Update current step.
$newstep = new block_workflow_step($step1->id);
$newstep->update_step($step1);
- return array($workflow, $step1);
+ return [$workflow, $step1];
}
/**
@@ -465,32 +544,32 @@ protected function create_a_workflow_with_one_step($stepoptions, $appliesto = 'c
*/
protected function create_expected_active_step($state, $step, $appliesto, $course, $cmid = 0, $type = 'autofinish') {
if ($type == 'autofinish') {
- return array($state->id => (object)array(
- 'stateid' => $state->id,
- 'stepid' => $step->id,
- 'state' => BLOCK_WORKFLOW_STATE_ACTIVE,
- 'workflowid' => $step->workflowid,
- 'appliesto' => $appliesto,
- 'stepname' => $step->name,
- 'autofinish' => $step->autofinish,
- 'autofinishoffset' => $step->autofinishoffset,
- 'courseid' => ($course ? $course->id : null),
- 'courseshortname' => ($course ? $course->shortname : null),
- 'moduleid' => $cmid)
- );
- }
- return array($state->id => (object)array(
+ return [$state->id => (object)[
'stateid' => $state->id,
'stepid' => $step->id,
'state' => BLOCK_WORKFLOW_STATE_ACTIVE,
'workflowid' => $step->workflowid,
'appliesto' => $appliesto,
'stepname' => $step->name,
- 'extranotify' => $step->extranotify,
- 'extranotifyoffset' => "$step->extranotifyoffset",
+ 'autofinish' => $step->autofinish,
+ 'autofinishoffset' => $step->autofinishoffset,
'courseid' => ($course ? $course->id : null),
'courseshortname' => ($course ? $course->shortname : null),
- 'moduleid' => $cmid)
- );
+ 'moduleid' => $cmid,
+ ]];
+ }
+ return [$state->id => (object)[
+ 'stateid' => $state->id,
+ 'stepid' => $step->id,
+ 'state' => BLOCK_WORKFLOW_STATE_ACTIVE,
+ 'workflowid' => $step->workflowid,
+ 'appliesto' => $appliesto,
+ 'stepname' => $step->name,
+ 'extranotify' => $step->extranotify,
+ 'extranotifyoffset' => "$step->extranotifyoffset",
+ 'courseid' => ($course ? $course->id : null),
+ 'courseshortname' => ($course ? $course->shortname : null),
+ 'moduleid' => $cmid,
+ ]];
}
}
diff --git a/tests/lib_test.php b/tests/lib_test.php
index 8efbeb1..75dd43b 100644
--- a/tests/lib_test.php
+++ b/tests/lib_test.php
@@ -35,7 +35,10 @@
global $CFG;
require_once(dirname(__FILE__) . '/lib.php');
-class lib_test extends \block_workflow_testlib {
+/**
+ * Unit test class for the block_workflow library.
+ */
+final class lib_test extends \block_workflow_testlib {
/**
* Test that each of the defined variables are set correctly
@@ -44,8 +47,10 @@ class lib_test extends \block_workflow_testlib {
* - BLOCK_WORKFLOW_STATE_ABORTED
* - BLOCK_WORKFLOW_ENABLED
* - BLOCK_WORKFLOW_OBSOLETE
+ *
+ * @coversNothing
*/
- public function test_defines() {
+ public function test_defines(): void {
$this->assertEquals(BLOCK_WORKFLOW_STATE_ACTIVE, 'active');
$this->assertEquals(BLOCK_WORKFLOW_STATE_COMPLETED, 'completed');
$this->assertEquals(BLOCK_WORKFLOW_STATE_ABORTED, 'aborted');
@@ -53,7 +58,12 @@ public function test_defines() {
$this->assertEquals(BLOCK_WORKFLOW_OBSOLETE, 1);
}
- public function test_workflow_validation() {
+ /**
+ * Tests the block_workflow_workflow validation method.
+ *
+ * @covers ::block_workflow_workflow
+ */
+ public function test_workflow_validation(): void {
// Create a new workflow.
$data = new stdClass();
$workflow = new block_workflow_workflow();
@@ -92,7 +102,12 @@ public function test_workflow_validation() {
$workflow, 'create_workflow', $data);
}
- public function test_workflow_validation2() {
+ /**
+ * Tests the block_workflow_workflow validation method.
+ *
+ * @covers ::block_workflow_workflow
+ */
+ public function test_workflow_validation2(): void {
// Create a new workflow.
$data = new stdClass();
$workflow = new block_workflow_workflow();
@@ -127,7 +142,12 @@ public function test_workflow_validation2() {
$workflow, 'create_workflow', $data);
}
- public function test_workflow_validation3() {
+ /**
+ * Tests the block_workflow_workflow validation method.
+ *
+ * @covers ::block_workflow_workflow
+ */
+ public function test_workflow_validation3(): void {
// Create a new workflow.
$data = new stdClass();
$workflow = new block_workflow_workflow();
@@ -200,8 +220,10 @@ public function test_workflow_validation3() {
* - adding a step and checking it's data;
* - cloning that step and checking it's data; and
* - re-ordering the steps and checking the resultant data.
+ *
+ * @covers ::block_workflow_workflow
*/
- public function test_workflow() {
+ public function test_workflow(): void {
// Create a new workflow object.
$workflow = new block_workflow_workflow();
@@ -269,7 +291,13 @@ public function test_workflow() {
$this->expect_exception_without_halting('block_workflow_invalid_workflow_exception', $workflow, 'create_workflow', $data);
}
- public function test_workflow_toggle() {
+
+ /**
+ * Tests the block_workflow_step toggle method.
+ *
+ * @covers ::block_workflow_workflow::toggle
+ */
+ public function test_workflow_toggle(): void {
$workflow = new block_workflow_workflow();
// Create a new workflow.
@@ -300,7 +328,12 @@ public function test_workflow_toggle() {
$this->assertEquals($workflow->context(), CONTEXT_COURSE);
}
- public function test_workflow_steps() {
+ /**
+ * Tests the block_workflow_step method.
+ *
+ * @covers ::block_workflow_step
+ */
+ public function test_workflow_steps(): void {
// Create a new workflow.
$data = new stdClass();
$data->shortname = 'courseworkflow';
@@ -385,7 +418,12 @@ public function test_workflow_steps() {
$this->assertNull($workflow->atendgobacktostep);
}
- public function test_workflow_steps_2() {
+ /**
+ * Tests the block_workflow_step method.
+ *
+ * @covers ::block_workflow_step
+ */
+ public function test_workflow_steps_2(): void {
// Create a new workflow.
$data = new stdClass();
$data->shortname = 'courseworkflow';
@@ -510,7 +548,12 @@ public function test_workflow_steps_2() {
$step, 'load_workflow_stepno', -1, -1);
}
- public function test_workflow_extended_exception() {
+ /**
+ * Tests the workflow extended exception.
+ *
+ * @covers ::block_workflow_step
+ */
+ public function test_workflow_extended_exception(): void {
// Create a new workflow.
$data = new stdClass();
$data->shortname = 'courseworkflow';
@@ -567,7 +610,13 @@ public function test_workflow_extended_exception() {
$this->expect_exception_without_halting('block_workflow_invalid_step_exception',
$newstep, 'create_step', $nsdata);
}
- public function test_workflow_extended() {
+
+ /**
+ * Tests the block_workflow_step.
+ *
+ * @covers ::block_workflow_step
+ */
+ public function test_workflow_extended(): void {
// Create a new workflow.
$data = new stdClass();
$data->shortname = 'courseworkflow';
@@ -616,7 +665,12 @@ public function test_workflow_extended() {
$step->delete();
}
- public function test_workflow_clone_exception() {
+ /**
+ * Tests the block_workflow_workflow workflow clone exception method.
+ *
+ * @covers ::block_workflow_workflow
+ */
+ public function test_workflow_clone_exception(): void {
// Create a new workflow.
$data = new stdClass();
$data->shortname = 'courseworkflow';
@@ -654,7 +708,12 @@ public function test_workflow_clone_exception() {
'block_workflow_workflow', 'clone_workflow', $workflow->id, $newdata);
}
- public function test_workflow_clone() {
+ /**
+ * Tests the block_workflow_workflow workflow clone method.
+ *
+ * @covers ::block_workflow_workflow
+ */
+ public function test_workflow_clone(): void {
// Create a new workflow.
$data = new stdClass();
$data->shortname = 'courseworkflow';
@@ -701,10 +760,10 @@ public function test_workflow_clone() {
$tmp, '__construct', $cloneid);
// And then faking the form submission editor part too.
- $newdata->description_editor = array(
+ $newdata->description_editor = [
'text' => 'Example text',
'format' => FORMAT_HTML,
- );
+ ];
$clone = block_workflow_workflow::clone_workflow($workflow->id, $newdata);
// And remove them both.
@@ -712,7 +771,12 @@ public function test_workflow_clone() {
}
- public function test_course_workflow() {
+ /**
+ * Tests the block_workflow_workflow available_workflows method.
+ *
+ * @covers ::block_workflow_workflow
+ */
+ public function test_course_workflow(): void {
$workflow = $this->create_workflow();
// Retrieve a list of all workflows available to courses.
@@ -742,7 +806,12 @@ public function test_course_workflow() {
$workflow, 'add_to_context', $this->contextid);
}
- public function test_course_workflow_2() {
+ /**
+ * Tests the available_workflows method.
+ *
+ * @covers ::block_workflow_workflow
+ */
+ public function test_course_workflow_2(): void {
$workflow = $this->create_workflow();
// Retrieve a list of all workflows available to courses.
@@ -828,7 +897,12 @@ public function test_course_workflow_2() {
$workflow, 'remove_workflow', $this->contextid);
}
- public function test_activity_workflow() {
+ /**
+ * Tests the block_workflow_workflow method.
+ *
+ * @covers ::block_workflow_workflow
+ */
+ public function test_activity_workflow(): void {
// Create a new workflow.
$data = new stdClass();
$data->shortname = 'activityworkflow';
@@ -849,18 +923,34 @@ public function test_activity_workflow() {
$this->assertEquals($workflow->context(), CONTEXT_MODULE);
}
- public function test_appliesto_list() {
+ /**
+ * Tests the block_workflow_appliesto_list method.
+ *
+ * @covers ::block_workflow_appliesto_list
+ */
+ public function test_appliesto_list(): void {
$list = block_workflow_appliesto_list();
$this->assertEquals('array', gettype($list));
$this->assertNotEquals(count($list), 0);
}
- public function test_editor_options() {
+ /**
+ * Tests the block_workflow_editor_options method.
+ *
+ * @covers ::block_workflow_editor_options
+ */
+ public function test_editor_options(): void {
$format = block_workflow_editor_options();
$this->assertEquals($format['maxfiles'], 0);
}
- public function test_editor_format() {
+ /**
+ * Tests the block_workflow_editor_format, block_workflow_convert_editor_format method.
+ *
+ * @covers ::block_workflow_editor_format
+ * @covers ::block_workflow_convert_editor_format
+ */
+ public function test_editor_format(): void {
$this->assertEquals(block_workflow_editor_format(FORMAT_HTML), get_string('format_html', 'block_workflow'));
$this->assertEquals(block_workflow_editor_format(FORMAT_PLAIN), get_string('format_plain', 'block_workflow'));
$this->assertEquals(block_workflow_editor_format(-1), get_string('format_unknown', 'block_workflow'));
@@ -872,7 +962,12 @@ public function test_editor_format() {
null, 'block_workflow_convert_editor_format', 'baddata');
}
- public function test_appliesto_string() {
+ /**
+ * Tests the block_workflow_appliesto method.
+ *
+ * @covers ::block_workflow_appliesto
+ */
+ public function test_appliesto_string(): void {
// Test that we get the correct strings from block_workflow_appliesto for both of it's routes.
$this->assertEquals(block_workflow_appliesto('course'), get_string('course'));
$this->assertEquals(block_workflow_appliesto('quiz'), get_string('pluginname', 'mod_quiz'));
diff --git a/tests/privacy_provider_test.php b/tests/privacy_provider_test.php
index 81db25e..9e06b9d 100644
--- a/tests/privacy_provider_test.php
+++ b/tests/privacy_provider_test.php
@@ -40,7 +40,7 @@
* @copyright 2018 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-class privacy_provider_test extends \core_privacy\tests\provider_testcase {
+final class privacy_provider_test extends \core_privacy\tests\provider_testcase {
/** @var \stdClass A student who is enrolled in course */
protected $student1;
@@ -64,6 +64,7 @@ class privacy_provider_test extends \core_privacy\tests\provider_testcase {
* Set up for each test
*/
public function setUp(): void {
+ parent::setUp();
$this->resetAfterTest(true);
$this->setAdminUser();
@@ -117,13 +118,15 @@ public function setUp(): void {
$this->todo->create_todo($data);
// Toggle the to-do item.
- $state->todo_toggle($this->todo->id);
+ $state->todo_toggle($this->todo->id, true);
}
/**
* Test for provider::get_contexts_for_userid().
+ *
+ * @covers \block_workflow\privacy\provider::get_contexts_for_userid
*/
- public function test_get_contexts_for_userid() {
+ public function test_get_contexts_for_userid(): void {
// Get workflow context for student1.
$contextids = provider::get_contexts_for_userid($this->student1->id)->get_contextids();
@@ -133,8 +136,10 @@ public function test_get_contexts_for_userid() {
/**
* Test for provider::get_users_in_context().
+ *
+ * @covers \block_workflow\privacy\provider::get_users_in_context
*/
- public function test_get_users_in_context() {
+ public function test_get_users_in_context(): void {
$userlist = new userlist($this->coursecontext, 'block_workflow');
$this->assertCount(0, $userlist);
provider::get_users_in_context($userlist);
@@ -144,8 +149,10 @@ public function test_get_users_in_context() {
/**
* Test for provider::export_user_data().
+ *
+ * @covers \block_workflow\privacy\provider::export_user_data
*/
- public function test_export_user_data() {
+ public function test_export_user_data(): void {
// Get workflow context for student1.
$contextids = provider::get_contexts_for_userid($this->student1->id)->get_contextids();
$context = \context::instance_by_id($contextids[0]);
@@ -164,28 +171,30 @@ public function test_export_user_data() {
'description' => $this->workflow->description,
'stepname' => $this->step->name,
'userid' => get_string('privacy_you', 'block_workflow'),
- 'newstate' => 'active'
+ 'newstate' => 'active',
], $data->statechangedata[0]);
$this->assertEquals((object)[
'workflowname' => $this->workflow->name,
'description' => $this->workflow->description,
'stepname' => $this->step->name,
'userid' => get_string('privacy_you', 'block_workflow'),
- 'newstate' => 'completed'
+ 'newstate' => 'completed',
], $data->statechangedata[1]);
// Check student1 has one task done.
$this->assertEquals((object)[
'stepname' => $this->step->name,
'taskdone' => $this->todo->task,
- 'userid' => get_string('privacy_you', 'block_workflow')
+ 'userid' => get_string('privacy_you', 'block_workflow'),
], $data->tododonedata[0]);
}
/**
* Test for delete_data_for_user().
+ *
+ * @covers \block_workflow\privacy\provider::delete_data_for_user
*/
- public function test_delete_data_for_user() {
+ public function test_delete_data_for_user(): void {
global $DB;
// Get workflow context for student1.
$contextids = provider::get_contexts_for_userid($this->student1->id)->get_contextids();
@@ -203,9 +212,11 @@ public function test_delete_data_for_user() {
}
/**
- * Test for provider::test_delete_data_for_users().
+ * Test for provider::delete_data_for_users().
+ *
+ * @covers \block_workflow\privacy\provider::delete_data_for_users
*/
- public function test_delete_data_for_users() {
+ public function test_delete_data_for_users(): void {
global $DB;
// Get workflow context for student1.
$approveduserids = [$this->student1->id];
@@ -224,8 +235,10 @@ public function test_delete_data_for_users() {
/**
* Test for delete_data_for_all_users_in_context().
+ *
+ * @covers \block_workflow\privacy\provider::delete_data_for_all_users_in_context
*/
- public function test_delete_data_for_all_users_in_context() {
+ public function test_delete_data_for_all_users_in_context(): void {
global $DB;
// Add the workflow to our course (returns the block_workflow_step_state).
@@ -243,7 +256,7 @@ public function test_delete_data_for_all_users_in_context() {
$this->todo->create_todo($data);
// Toggle the to-do item.
- $state->todo_toggle($this->todo->id);
+ $state->todo_toggle($this->todo->id, true);
$params = ['statescontextid' => $this->coursecontext->id];
$statechangesql = "SELECT statechanges.id, statechanges.userid
diff --git a/tests/steps_test.php b/tests/steps_test.php
index 69a1973..2f891a1 100644
--- a/tests/steps_test.php
+++ b/tests/steps_test.php
@@ -37,8 +37,19 @@
global $CFG;
require_once(dirname(__FILE__) . '/lib.php');
-class steps_test extends \block_workflow_testlib {
- public function test_step_validation() {
+/**
+ * Unit tests for the workflow steps functionality in the block_workflow plugin.
+ *
+ * This class extends the block_workflow_testlib to provide test cases
+ * for verifying the behavior and integrity of workflow steps.
+ */
+final class steps_test extends \block_workflow_testlib {
+ /**
+ * Tests the create_step methods.
+ *
+ * @covers \block_workflow_step::create_step
+ */
+ public function test_step_validation(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
@@ -91,7 +102,18 @@ public function test_step_validation() {
unset($data->oncompletescript);
}
- public function test_step_validation_2() {
+ /**
+ * Tests the create_step, update_step methods.
+ *
+ * @covers \block_workflow_step::create_step
+ * @covers \block_workflow_step::update_step
+ * @covers \block_workflow_step::delete
+ * @covers \block_workflow_step::load_workflow_stepno
+ * @covers \block_workflow_workflow::update
+ * @covers \block_workflow_workflow::load_workflow
+ * @covers \block_workflow_workflow::steps
+ */
+ public function test_step_validation_2(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
@@ -190,7 +212,13 @@ public function test_step_validation_2() {
unset($data->oncompletescript);
}
- public function test_step_validation_3() {
+ /**
+ * Tests the create_step methods.
+ *
+ * @covers \block_workflow_step::create_step
+ * @covers \block_workflow_step::update_step
+ */
+ public function test_step_validation_3(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
@@ -272,6 +300,8 @@ public function test_step_validation_3() {
}
/**
+ * Tests the toggle_role methods.
+ *
* Test toggling of block_workflow_step roles
* - Ensure that we can add a role
* - Ensure that we get the right result from step->roles()
@@ -281,8 +311,11 @@ public function test_step_validation_3() {
* - Ensure that we get the right result from step->roles()
* - Ensure that we can remove the second role
* - Ensure that we get the right result from step->roles()
+ *
+ * @covers \block_workflow_step::toggle_role
+ * @covers \block_workflow_step::roles
*/
- public function test_step_roles() {
+ public function test_step_roles(): void {
global $DB;
// Create a new workflow.
$data = new stdClass();
@@ -304,7 +337,7 @@ public function test_step_roles() {
$step->load_workflow_stepno($workflow->id, 1);
// Find the ID for the manager role.
- $managerid = $DB->get_field('role', 'id', array('shortname' => 'manager'));
+ $managerid = $DB->get_field('role', 'id', ['shortname' => 'manager']);
// Enable the role.
$return = $step->toggle_role($managerid);
@@ -323,7 +356,7 @@ public function test_step_roles() {
$this->assertEquals($thisrole->id, $managerid);
// Add a second role.
- $teacherid = $DB->get_field('role', 'id', array('shortname' => 'teacher'));
+ $teacherid = $DB->get_field('role', 'id', ['shortname' => 'teacher']);
// Enable the second role.
$return = $step->toggle_role($teacherid);
@@ -364,7 +397,12 @@ public function test_step_roles() {
$this->assertEquals(count($return), 0);
}
- public function test_script_parse() {
+ /**
+ * Tests the parse_script methods.
+ *
+ * @covers \block_workflow_step::parse_script
+ */
+ public function test_script_parse(): void {
// Create a new workflow and step.
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -382,7 +420,14 @@ public function test_script_parse() {
$this->assertEquals(count($command->errors), 0);
}
- public function test_script_validation() {
+ /**
+ * Tests the is_script_valid, require_script_valid, get_validation_errors methods.
+ *
+ * @covers \block_workflow_step::is_script_valid
+ * @covers \block_workflow_step::require_script_valid
+ * @covers \block_workflow_step::get_validation_errors
+ */
+ public function test_script_validation(): void {
// Create a new workflow and step.
$workflow = $this->create_workflow(false);
$step = $this->create_step($workflow);
@@ -415,7 +460,14 @@ public function test_script_validation() {
$this->assertEquals(count($errors), 0);
}
- public function test_step_commands() {
+ /**
+ * Tests the validate_script, update_step, create methods.
+ *
+ * @covers \block_workflow_step::validate_script
+ * @covers \block_workflow_step::update_step
+ * @covers \block_workflow_email::create
+ */
+ public function test_step_commands(): void {
// Create a new workflow.
$data = new stdClass();
$data->shortname = 'courseworkflow';
@@ -496,7 +548,12 @@ public function test_step_commands() {
$this->expect_exception_without_halting('block_workflow_invalid_command_exception', $step, 'update_step', $update);
}
- public function test_next_step_end() {
+ /**
+ * Tests the get_next_step method.
+ *
+ * @covers \block_workflow_step::get_next_step
+ */
+ public function test_next_step_end(): void {
// Create a new workflow.
$workflow = $this->create_workflow(false);
@@ -521,7 +578,12 @@ public function test_next_step_end() {
$this->assertFalse($getnext);
}
- public function test_next_step_loop() {
+ /**
+ * Tests the get_next_step method.
+ *
+ * @covers \block_workflow_step::get_next_step
+ */
+ public function test_next_step_loop(): void {
// Create a new workflow.
$workflow = $this->create_workflow(false);
@@ -553,7 +615,12 @@ public function test_next_step_loop() {
$this->compare_step($firststep, $getnext);
}
- public function test_set_workflow() {
+ /**
+ * Tests the set_workflow method.
+ *
+ * @covers \block_workflow_step::set_workflow
+ */
+ public function test_set_workflow(): void {
$step = new block_workflow_step();
$step->set_workflow(1);
$this->assertEquals($step->workflowid, 1);
@@ -563,7 +630,12 @@ public function test_set_workflow() {
'set_workflow', 1);
}
- public function test_get_all_users_and_their_roles() {
+ /**
+ * Tests the get_all_users_and_their_roles method.
+ *
+ * @covers \block_workflow_step_state::get_all_users_and_their_roles
+ */
+ public function test_get_all_users_and_their_roles(): void {
global $DB;
$this->resetAfterTest(true);
@@ -571,7 +643,7 @@ public function test_get_all_users_and_their_roles() {
$roleids = $DB->get_records_menu('role', null, '', 'shortname, id');
$roles = $DB->get_records('role');
- $rolenames = array();
+ $rolenames = [];
$rolenames['manager'] = 'Manager';
$rolenames['coursecreator'] = 'Course creater';
$rolenames['editingteacher'] = 'Teacher';
@@ -593,12 +665,12 @@ public function test_get_all_users_and_their_roles() {
// Create users.
$maxnumberofusers = 5;
- $users = array();
+ $users = [];
for ($index = 1; $index < ($maxnumberofusers + 1); $index++) {
- $users[$index] = $generator->create_user(array('username' => 'user' . $index));
+ $users[$index] = $generator->create_user(['username' => 'user' . $index]);
}
// Create a course.
- $course = $generator->create_course(array('shortname' => 'MK123-12J'));
+ $course = $generator->create_course(['shortname' => 'MK123-12J']);
$coursecontext = \context_course::instance($course->id);
// Users one to 5 get following roles.
@@ -609,16 +681,16 @@ public function test_get_all_users_and_their_roles() {
// user5 is a student.
$manualenrol = enrol_get_plugin('manual');
$manualenrol->add_default_instance($course);
- $instance1 = $DB->get_record('enrol', array('enrol' => 'manual', 'courseid' => $course->id));
+ $instance1 = $DB->get_record('enrol', ['enrol' => 'manual', 'courseid' => $course->id]);
foreach ($users as $i => $user) {
$manualenrol->enrol_user($instance1, $user->id, $roleids[$roles[$i]->shortname]);
}
- $expectedroles = array();
+ $expectedroles = [];
- $expectedusers = array();
+ $expectedusers = [];
foreach ($users as $key => $user) {
- $user->roles = array();
+ $user->roles = [];
$user->roles[] = $rolenames[$roles[$key]->shortname];
$expectedusers[$user->id] = $user;
}
diff --git a/tests/todos_test.php b/tests/todos_test.php
index 5d0a66c..0afc42b 100644
--- a/tests/todos_test.php
+++ b/tests/todos_test.php
@@ -34,8 +34,19 @@
global $CFG;
require_once(dirname(__FILE__) . '/lib.php');
-class todos_test extends \block_workflow_testlib {
- public function test_todo_validation() {
+/**
+ * Unit tests for the block_workflow plugin's todo functionality.
+ *
+ * This class contains test cases for verifying the behavior and features
+ * related to todos in the block_workflow plugin.
+ */
+final class todos_test extends \block_workflow_testlib {
+ /**
+ * Tests the validation method of the block_workflow_todo class.
+ *
+ * @covers \block_workflow_todo::validation
+ */
+ public function test_todo_validation(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
@@ -71,7 +82,12 @@ public function test_todo_validation() {
$data->obsolete = BLOCK_WORKFLOW_OBSOLETE;
}
- public function test_todo_create() {
+ /**
+ * Tests the create_todo method of the block_workflow_todo class.
+ *
+ * @covers \block_workflow_todo::create_todo
+ */
+ public function test_todo_create(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
@@ -108,7 +124,12 @@ public function test_todo_create() {
unset($data->badfield);
}
- public function test_todo_update() {
+ /**
+ * Tests the update_todo method of the block_workflow_todo class.
+ *
+ * @covers \block_workflow_todo::update_todo
+ */
+ public function test_todo_update(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
@@ -136,10 +157,15 @@ public function test_todo_update() {
$todo->update_todo($data);
// Compare the updated task.
- $this->compare_todo($data, $todo, array('id'));
+ $this->compare_todo($data, $todo, ['id']);
}
- public function test_todo_loading() {
+ /**
+ * Tests the load_by_id method of the block_workflow_todo class.
+ *
+ * @covers \block_workflow_todo::load_by_id
+ */
+ public function test_todo_loading(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
@@ -160,7 +186,12 @@ public function test_todo_loading() {
$this->compare_todo($todo, $reloaded);
}
- public function test_todo_clone() {
+ /**
+ * Tests the clone_todo method of the block_workflow_todo class.
+ *
+ * @covers \block_workflow_todo::clone_todo
+ */
+ public function test_todo_clone(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
@@ -173,19 +204,24 @@ public function test_todo_clone() {
// Clone the todo.
$clone = $todo->clone_todo($todo->id);
- $this->compare_todo($todo, $clone, array('id'));
+ $this->compare_todo($todo, $clone, ['id']);
$this->assertNotEquals($todo->id, $clone->id);
// Add a second step and clone the task from the first step.
$newstep = $this->create_step($workflow);
$clone = $todo->clone_todo($todo->id, $newstep->id);
- $this->compare_todo($todo, $clone, array('id', 'stepid'));
+ $this->compare_todo($todo, $clone, ['id', 'stepid']);
$this->assertNotEquals($todo->id, $clone->id);
$this->assertNotEquals($todo->stepid, $clone->stepid);
$this->assertEquals($clone->stepid, $newstep->id);
}
- public function test_todo_delete() {
+ /**
+ * Tests the delete_todo method of the block_workflow_todo class.
+ *
+ * @covers \block_workflow_todo::delete_todo
+ */
+ public function test_todo_delete(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
@@ -204,7 +240,12 @@ public function test_todo_delete() {
$reload, 'load_by_id', $todo->id);
}
- public function test_todo_toggle() {
+ /**
+ * Tests the toggle functionality of the block_workflow_todo class.
+ *
+ * @covers \block_workflow_todo::toggle
+ */
+ public function test_todo_toggle(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
@@ -232,16 +273,21 @@ public function test_todo_toggle() {
$return = block_workflow_todo::toggle_task($todo->id);
$check = new block_workflow_todo($todo->id);
$this->assertEquals($check->obsolete, BLOCK_WORKFLOW_OBSOLETE);
- $this->compare_todo($return, $check, array());
+ $this->compare_todo($return, $check, []);
// And also to re-enable.
$return = block_workflow_todo::toggle_task($todo->id);
$check = new block_workflow_todo($todo->id);
$this->assertEquals($check->obsolete, BLOCK_WORKFLOW_ENABLED);
- $this->compare_todo($return, $check, array());
+ $this->compare_todo($return, $check, []);
}
- public function test_todo_step() {
+ /**
+ * Tests the validation logic for the todo step in the workflow.
+ *
+ * @covers \block_workflow_todo::step
+ */
+ public function test_todo_step(): void {
// Create a new workflow.
$workflow = $this->create_workflow();
diff --git a/tests/walkthrough_test.php b/tests/walkthrough_test.php
index 4690570..88afe1f 100644
--- a/tests/walkthrough_test.php
+++ b/tests/walkthrough_test.php
@@ -43,7 +43,7 @@
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
-class walkthrough_test extends \advanced_testcase {
+final class walkthrough_test extends \advanced_testcase {
/**
* Test some of the basic workflow actions including:
@@ -52,8 +52,11 @@ class walkthrough_test extends \advanced_testcase {
* - adding a step and checking it's data;
* - cloning that step and checking it's data; and
* - re-ordering the steps and checking the resultant data.
+ *
+ * @covers \block_workflow_workflow
+ * @covers \block_workflow_step
*/
- public function test_course_workflow() {
+ public function test_course_workflow(): void {
global $DB;
$this->resetAfterTest(true);
@@ -61,15 +64,15 @@ public function test_course_workflow() {
// Create a course ready to test with.
$generator = $this->getDataGenerator();
- $egstudent = $generator->create_user(array('username' => 'egstudent'));
- $u2 = $generator->create_user(array('username' => 'u2'));
+ $egstudent = $generator->create_user(['username' => 'egstudent']);
+ $u2 = $generator->create_user(['username' => 'u2']);
- $course = $generator->create_course(array('shortname' => 'X943-12K'));
+ $course = $generator->create_course(['shortname' => 'X943-12K']);
$coursecontext = \context_course::instance($course->id);
$manualenrol = enrol_get_plugin('manual');
$manualenrol->add_default_instance($course);
- $instance1 = $DB->get_record('enrol', array('enrol' => 'manual', 'courseid' => $course->id));
+ $instance1 = $DB->get_record('enrol', ['enrol' => 'manual', 'courseid' => $course->id]);
$manualenrol->enrol_user($instance1, $egstudent->id, $roleids['student']);
// Create a new workflow object.
@@ -118,15 +121,15 @@ public function test_course_workflow() {
$this->assertEquals(BLOCK_WORKFLOW_STATE_ACTIVE, $state->state);
// Verify that student is now a teacher - i.e. that step 1's onactivescript ran.
- $this->assertTrue($DB->record_exists('role_assignments', array(
+ $this->assertTrue($DB->record_exists('role_assignments', [
'userid' => $egstudent->id,
'roleid' => $roleids['teacher'],
'contextid' => $coursecontext->id,
'component' => 'block_workflow',
- )));
+ ]));
// Hide the course, so we can test if the onactivescript runs.
- $DB->set_field('course', 'visible', '0', array('id' => $course->id));
+ $DB->set_field('course', 'visible', '0', ['id' => $course->id]);
// Finish the first step.
$state2 = $state->finish_step('Comment on task 1', FORMAT_HTML);
@@ -140,18 +143,18 @@ public function test_course_workflow() {
$this->assertEquals(BLOCK_WORKFLOW_STATE_ACTIVE, $state2->state);
// Verify the role assignment from task 1 was removed.
- $this->assertFalse($DB->record_exists('role_assignments', array(
+ $this->assertFalse($DB->record_exists('role_assignments', [
'userid' => $egstudent->id,
'roleid' => $roleids['teacher'],
'contextid' => $coursecontext->id,
'component' => 'block_workflow',
- )));
+ ]));
// Verify the start script from task 2 ran.
- $this->assertTrue((bool) $DB->get_field('course', 'visible', array('id' => $course->id)));
+ $this->assertTrue((bool) $DB->get_field('course', 'visible', ['id' => $course->id]));
// The next line is redundant unless the previous assert failed, which
// was the case at one time.
- $DB->set_field('course', 'visible', 1, array('id' => $course->id));
+ $DB->set_field('course', 'visible', 1, ['id' => $course->id]);
// Jump back to step 1.
$state1again = $state2->jump_to_step(null, $step1->id);
@@ -165,24 +168,24 @@ public function test_course_workflow() {
$this->assertEquals(BLOCK_WORKFLOW_STATE_ACTIVE, $state1again->state);
// Verify that student is now a teacher - i.e. that step 1's onactivescript ran.
- $this->assertTrue($DB->record_exists('role_assignments', array(
+ $this->assertTrue($DB->record_exists('role_assignments', [
'userid' => $egstudent->id,
'roleid' => $roleids['teacher'],
'contextid' => $coursecontext->id,
'component' => 'block_workflow',
- )));
+ ]));
// Verify that step 2's oncomplete script did not run.
- $this->assertTrue((bool) $DB->get_field('course', 'visible', array('id' => $course->id)));
+ $this->assertTrue((bool) $DB->get_field('course', 'visible', ['id' => $course->id]));
// Now hide the course so we can tell if the onactive scripts runs in a minute.
- $DB->set_field('course', 'visible', 0, array('id' => $course->id));
+ $DB->set_field('course', 'visible', 0, ['id' => $course->id]);
// Finish both steps, and hence the workflow.
$state2again = $state1again->finish_step('Updated comment on task 1', FORMAT_HTML);
// Verify that step 2's onactive script ran.
- $this->assertTrue((bool) $DB->get_field('course', 'visible', array('id' => $course->id)));
+ $this->assertTrue((bool) $DB->get_field('course', 'visible', ['id' => $course->id]));
$results = $state2again->finish_step('Comment on task 2', FORMAT_HTML);
@@ -190,17 +193,17 @@ public function test_course_workflow() {
$this->assertSame(false, $results);
// Check that step 2's oncomplete script ran.
- $this->assertFalse((bool) $DB->get_field('course', 'visible', array('id' => $course->id)));
+ $this->assertFalse((bool) $DB->get_field('course', 'visible', ['id' => $course->id]));
// Start the workflow yet again.
$state = $workflow->add_to_context($coursecontext->id);
// Verify that student is now a teacher - i.e. that step 1's onactivescript ran.
- $this->assertTrue($DB->record_exists('role_assignments', array(
+ $this->assertTrue($DB->record_exists('role_assignments', [
'userid' => $egstudent->id,
'roleid' => $roleids['teacher'],
'contextid' => $coursecontext->id,
'component' => 'block_workflow',
- )));
+ ]));
}
}
diff --git a/togglerole.php b/togglerole.php
index 6181c8a..b714430 100644
--- a/togglerole.php
+++ b/togglerole.php
@@ -21,6 +21,7 @@
* @copyright 2011 Lancaster University Network Services Limited
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
+
require_once(dirname(__FILE__) . '/../../config.php');
require_once(dirname(__FILE__) . '/locallib.php');
@@ -42,4 +43,4 @@
$step->toggle_role($roleid);
// Redirect.
-redirect(new moodle_url('/blocks/workflow/editstep.php', array('stepid' => $stepid)));
+redirect(new moodle_url('/blocks/workflow/editstep.php', ['stepid' => $stepid]));
diff --git a/toggletaskdone.php b/toggletaskdone.php
index 598423f..e299b60 100644
--- a/toggletaskdone.php
+++ b/toggletaskdone.php
@@ -21,6 +21,7 @@
* @copyright 2011 Lancaster University Network Services Limited
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
+
require_once(dirname(__FILE__) . '/../../config.php');
require_once(dirname(__FILE__) . '/locallib.php');
@@ -41,7 +42,7 @@
require_capability('block/workflow:dostep', $context);
// Toggle the todo item.
-$state->todo_toggle($todoid);
+$state->todo_toggle($todoid, true);
if ($returnto) {
redirect(new moodle_url($returnto));
diff --git a/toggletaskobsolete.php b/toggletaskobsolete.php
index d229b09..280c1b5 100644
--- a/toggletaskobsolete.php
+++ b/toggletaskobsolete.php
@@ -21,6 +21,7 @@
* @copyright 2011 Lancaster University Network Services Limited
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
+
require_once(dirname(__FILE__) . '/../../config.php');
require_once(dirname(__FILE__) . '/locallib.php');
@@ -38,4 +39,4 @@
$task = block_workflow_todo::toggle_task($taskid);
// Redirect.
-redirect(new moodle_url('/blocks/workflow/editstep.php', array('stepid' => $task->stepid)));
+redirect(new moodle_url('/blocks/workflow/editstep.php', ['stepid' => $task->stepid]));
diff --git a/toggleworkflowobsolete.php b/toggleworkflowobsolete.php
index f80d116..81ed041 100644
--- a/toggleworkflowobsolete.php
+++ b/toggleworkflowobsolete.php
@@ -42,7 +42,7 @@
// Redirect as appropriate.
if ($returnto == 'editsteps') {
- redirect(new moodle_url('/blocks/workflow/editsteps.php', array('workflowid' => $workflowid)));
+ redirect(new moodle_url('/blocks/workflow/editsteps.php', ['workflowid' => $workflowid]));
} else {
redirect(new moodle_url('/blocks/workflow/manage.php'));
}
diff --git a/version.php b/version.php
index 1e314f1..63b0601 100644
--- a/version.php
+++ b/version.php
@@ -24,10 +24,10 @@
defined('MOODLE_INTERNAL') || die();
-$plugin->version = 2022040800;
+$plugin->version = 2025073000;
$plugin->requires = 2021051700;
$plugin->component = 'block_workflow';
$plugin->maturity = MATURITY_STABLE;
-$plugin->release = 'v2.3 for Moodle 3.11+';
+$plugin->release = 'v2.4 for Moodle 5.0+';
$plugin->outestssufficient = true;
diff --git a/yui/build/moodle-block_workflow-comments/moodle-block_workflow-comments-debug.js b/yui/build/moodle-block_workflow-comments/moodle-block_workflow-comments-debug.js
deleted file mode 100644
index 045a254..0000000
--- a/yui/build/moodle-block_workflow-comments/moodle-block_workflow-comments-debug.js
+++ /dev/null
@@ -1,296 +0,0 @@
-YUI.add('moodle-block_workflow-comments', function (Y, NAME) {
-
-var COMMENTSNAME = 'blocks_workflow_comments',
- AJAXURL = '/blocks/workflow/ajax.php',
- STATEID = 'stateid',
- EDITORID = 'editorid',
- EDITORNAME = 'editorname',
- CSS = {
- BLOCKWORKFLOW: 'block_workflow',
- BLOCKCOMMENTS: 'block_workflow_comments',
- BLOCKCOMMBTN: 'block_workflow_editcommentbutton',
- BLOCKFINISHBTN: 'block_workflow_finishstepbutton',
- PANEL: 'block-workflow-panel',
- CONTENT: 'content',
- COMMENTS: 'wkf-comments',
- LIGHTBOX: 'loading-lightbox',
- LOADINGICON: 'loading-icon',
- TEXTAREA: 'wfk-textarea',
- SUBMIT: 'wfk-submit',
- HIDDEN: 'hidden'
- };
-
-var overlay = new M.core.dialogue({
- headerContent: '',
- bodyContent: Y.one('.' + CSS.PANEL),
- visible: false,
- modal: true,
- width: 'auto',
- zIndex: 100
-});
-
-var COMMENTS = function() {
- COMMENTS.superclass.constructor.apply(this, arguments);
-};
-
-Y.extend(COMMENTS, Y.Base, {
- _formSubmitEvent: null,
- _escCloseEvent: null,
- _closeButtonEvent: null,
- _loadingNode: null,
-
- initializer: function() {
- overlay.hide();
- var panel = Y.one('.' + CSS.PANEL);
- if (!panel) {
- return;
- }
- this._loadingNode = panel.one('.' + CSS.LIGHTBOX);
- this.attachEvents();
- },
-
- show: function (e, finishstep) {
- e.halt();
-
- // Different scenario depending on whether we finishing the step or just editiong the comment
- if (finishstep) {
- overlay.set('headerContent', M.str.block_workflow.finishstep);
- Y.one('.' + CSS.PANEL).one('.' + CSS.SUBMIT + ' input').set('value', M.str.block_workflow.finishstep);
- this._formSubmitEvent = Y.one('.' + CSS.SUBMIT + ' input').on('click', this.finishstep, this);
- } else {
- overlay.set('headerContent', M.str.block_workflow.editcomments);
- Y.one('.' + CSS.PANEL).one('.' + CSS.SUBMIT + ' input').set('value', M.str.moodle.savechanges);
- this._formSubmitEvent = Y.one('.' + CSS.SUBMIT + ' input').on('click', this.save, this);
- }
-
- overlay.show(); //show the overlay
- // We add a new event on the body in order to hide the overlay for the next click
- this._escCloseEvent = Y.on('key', this.hide, document.body, 'down:27', this);
-
- // Remove the existing handler for the closebutton
- Y.Event.purgeElement(Y.one('.moodle-dialogue-hd .closebutton'), true);
- // Add a new event for close button.
- this._closeButtonEvent = Y.on('click', this.hide, Y.one('.moodle-dialogue-hd .closebutton'), this);
-
- // Build the data for submission
- var data = {
- sesskey: M.cfg.sesskey,
- action: 'getcomment',
- stateid: this.get(STATEID)
- };
-
- if (typeof tinyMCE !== 'undefined') {
- var ed = tinyMCE.get(this.get(EDITORID));
-
- // Resize then editor when first shown if it would otherwise be too small.
- var ifr = tinymce.DOM.get(this.get(EDITORID) + '_ifr');
- var size = tinymce.DOM.getSize(ifr);
- if (size.h === 30) {
- ed.theme.resizeTo(size.w, 90);
- }
- }
-
- // Fetch the comment and update the form
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method:'POST',
- data:build_querystring(data),
- on: {
- start: this.displayLoading,
- complete: function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (typeof tinyMCE !== 'undefined') {
- ed.setContent(result.response.comment);
- } else {
- var editorid = this.get(EDITORID);
- var editor = Y.one(document.getElementById(editorid + 'editable'));
- if (editor) {
- editor.setHTML(result.response.comment);
- }
- Y.one(document.getElementById(editorid)).set(
- 'value', result.response.comment);
- }
- },
- end: this.removeLoading
- },
- context:this
- });
- },
-
- hide: function () {
- overlay.hide(); //hide the overlay
- if (this._escCloseEvent) {
- this._escCloseEvent.detach();
- this._escCloseEvent = null;
- }
- if (this._closeButtonEvent) {
- this._closeButtonEvent.detach();
- this._closeButtonEvent = null;
- }
- if (this._formSubmitEvent) {
- this._formSubmitEvent.detach();
- this._formSubmitEvent = null;
- }
- },
- save: function () {
- var comment;
- if (typeof tinyMCE !== 'undefined') {
- comment = tinyMCE.get(this.get(EDITORID)).getContent();
- } else {
- comment = Y.one(document.getElementById(this.get(EDITORID))).get('value');
- }
-
- var commentsblock = Y.one('.' + CSS.BLOCKWORKFLOW + ' .' + CSS.BLOCKCOMMENTS);
- // Build the data for submission
- var data = {
- sesskey: M.cfg.sesskey,
- action: 'savecomment',
- stateid: this.get(STATEID),
- text: comment,
- format: document.getElementsByName(this.get(EDITORNAME) + '[format]')[0].value
- };
-
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method:'POST',
- data:build_querystring(data),
- on: {
- start: this.displayLoading,
- complete: function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (result.response.blockcomments) {
- commentsblock.setContent(result.response.blockcomments);
- } else {
- commentsblock.setContent(M.str.block_workflow.nocomments);
- }
- },
- end: this.removeLoading
- },
- context:this
- });
- this.hide();
- },
- finishstep: function () {
- var comment;
- if (typeof tinyMCE !== 'undefined') {
- comment = tinyMCE.get(this.get(EDITORID)).getContent();
- } else {
- comment = Y.one(document.getElementById(this.get(EDITORID))).get('value');
- }
-
- var workflowblock = Y.one('.' + CSS.BLOCKWORKFLOW + ' .' + CSS.CONTENT);
- // Build the data for submission
- var data = {
- sesskey: M.cfg.sesskey,
- action: 'finishstep',
- stateid: this.get(STATEID),
- text: comment,
- format: document.getElementsByName(this.get(EDITORNAME) + '[format]')[0].value
- };
-
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method:'POST',
- data:build_querystring(data),
- on: {
- start: this.displayLoading,
- complete: function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (result.response.blockcontent) {
- // Update content
- workflowblock.setContent(result.response.blockcontent);
- if (result.response.stateid) {
- // we are on the next step
- this.set(STATEID, result.response.stateid);
- // re-attach events to block buttons
- this.attachEvents();
- // reinit todo events
- M.blocks_workflow.init_todolist({"stateid":result.response.stateid});
- }
- if (result.response.listworkflows) {
- // Last step, available workflows are listed
- var select_id = workflowblock.one('.singleselect form select').getAttribute('id');
- // Reinit single_select event
- // This is horrible, but the core JS we need is now inline in the template,
- // so we have to copy it.
- require(['jquery'], function($) {
- $('#' + select_id).change(function() {
- var ignore = $(this).find(':selected').attr('data-ignore');
- if (typeof ignore === typeof undefined) {
- $('#' + select_id).closest('form').submit();
- }
- });
- });
- }
- }
- },
- end: this.removeLoading
- },
- context:this
- });
- this.hide();
- },
- displayLoading: function() {
- this._loadingNode.removeClass(CSS.HIDDEN);
- },
- removeLoading: function() {
- this._loadingNode.addClass(CSS.HIDDEN);
- },
- attachEvents: function() {
- var commentbutton = Y.one('.' + CSS.BLOCKCOMMBTN + ' button, .' +
- CSS.BLOCKCOMMBTN + ' input[type=submit]');
- if (commentbutton) {
- commentbutton.on('click', this.show, this, false);
- }
- var finishbutton = Y.one('.' + CSS.BLOCKFINISHBTN + ' button, .' +
- CSS.BLOCKFINISHBTN + ' input[type=submit]');
- if (finishbutton) {
- finishbutton.on('click', this.show, this, true);
- }
- }
-
-}, {
- NAME: COMMENTSNAME,
- ATTRS: {
- stateid: {
- value: null
- },
- editorid: {
- value: null
- },
- editorname: {
- validator: Y.Lang.isString,
- value: null
- }
-
- }
-});
-
-M.blocks_workflow = M.blocks_workflow || {};
-M.blocks_workflow.init_comments = function(params) {
- return new COMMENTS(params);
-};
-
-
-}, '@VERSION@', {"requires": ["base", "overlay", "moodle-core-formautosubmit", "moodle-core-notification"]});
diff --git a/yui/build/moodle-block_workflow-comments/moodle-block_workflow-comments-min.js b/yui/build/moodle-block_workflow-comments/moodle-block_workflow-comments-min.js
deleted file mode 100644
index 50b17d4..0000000
--- a/yui/build/moodle-block_workflow-comments/moodle-block_workflow-comments-min.js
+++ /dev/null
@@ -1 +0,0 @@
-YUI.add("moodle-block_workflow-comments",function(c,e){var o="/blocks/workflow/ajax.php",l="stateid",r="editorid",t="editorname",n="block_workflow",i="block_workflow_comments",u="block_workflow_editcommentbutton",m="block_workflow_finishstepbutton",a="block-workflow-panel",f="content",g="loading-lightbox",d="wfk-submit",w="hidden",h=new M.core.dialogue({headerContent:"",bodyContent:c.one("."+a),visible:!1,modal:!0,width:"auto",zIndex:100}),s=function(){s.superclass.constructor.apply(this,arguments)};c.extend(s,c.Base,{_formSubmitEvent:null,_escCloseEvent:null,_closeButtonEvent:null,_loadingNode:null,initializer:function(){h.hide();var e=c.one("."+a);e&&(this._loadingNode=e.one("."+g),this.attachEvents())},show:function(s,e){var i,t;s.halt(),e?(h.set("headerContent",M.str.block_workflow.finishstep),c.one("."+a).one("."+d+" input").set("value",M.str.block_workflow.finishstep),this._formSubmitEvent=c.one("."+d+" input").on("click",this.finishstep,this)):(h.set("headerContent",M.str.block_workflow.editcomments),c.one("."+a).one("."+d+" input").set("value",M.str.moodle.savechanges),this._formSubmitEvent=c.one("."+d+" input").on("click",this.save,this)),h.show(),this._escCloseEvent=c.on("key",this.hide,document.body,"down:27",this),c.Event.purgeElement(c.one(".moodle-dialogue-hd .closebutton"),!0),this._closeButtonEvent=c.on("click",this.hide,c.one(".moodle-dialogue-hd .closebutton"),this),e={sesskey:M.cfg.sesskey,action:"getcomment",stateid:this.get(l)},"undefined"!=typeof tinyMCE&&(i=tinyMCE.get(this.get(r)),t=tinymce.DOM.get(this.get(r)+"_ifr"),30===(t=tinymce.DOM.getSize(t)).h&&i.theme.resizeTo(t.w,90)),c.io(M.cfg.wwwroot+o,{method:"POST",data:build_querystring(e),on:{start:this.displayLoading,complete:function(e,t){var o,n;try{if((o=c.JSON.parse(t.responseText)).error)return new M.core.ajaxException(o)}catch(s){new M.core.exception(s)}"undefined"!=typeof tinyMCE?i.setContent(o.response.comment):(t=this.get(r),(n=c.one(document.getElementById(t+"editable")))&&n.setHTML(o.response.comment),c.one(document.getElementById(t)).set("value",o.response.comment))},end:this.removeLoading},context:this})},hide:function(){h.hide(),this._escCloseEvent&&(this._escCloseEvent.detach(),this._escCloseEvent=null),this._closeButtonEvent&&(this._closeButtonEvent.detach(),this._closeButtonEvent=null),this._formSubmitEvent&&(this._formSubmitEvent.detach(),this._formSubmitEvent=null)},save:function(){var e="undefined"!=typeof tinyMCE?tinyMCE.get(this.get(r)).getContent():c.one(document.getElementById(this.get(r))).get("value"),s=c.one("."+n+" ."+i),e={sesskey:M.cfg.sesskey,action:"savecomment",stateid:this.get(l),text:e,format:document.getElementsByName(this.get(t)+"[format]")[0].value};c.io(M.cfg.wwwroot+o,{method:"POST",data:build_querystring(e),on:{start:this.displayLoading,complete:function(e,t){var o;try{if((o=c.JSON.parse(t.responseText)).error)return new M.core.ajaxException(o)}catch(n){new M.core.exception(n)}o.response.blockcomments?s.setContent(o.response.blockcomments):s.setContent(M.str.block_workflow.nocomments)},end:this.removeLoading},context:this}),this.hide()},finishstep:function(){var e="undefined"!=typeof tinyMCE?tinyMCE.get(this.get(r)).getContent():c.one(document.getElementById(this.get(r))).get("value"),i=c.one("."+n+" ."+f),e={sesskey:M.cfg.sesskey,action:"finishstep",stateid:this.get(l),text:e,format:document.getElementsByName(this.get(t)+"[format]")[0].value};c.io(M.cfg.wwwroot+o,{method:"POST",data:build_querystring(e),on:{start:this.displayLoading,complete:function(e,t){var o,n;try{if((o=c.JSON.parse(t.responseText)).error)return new M.core.ajaxException(o)}catch(s){new M.core.exception(s)}o.response.blockcontent&&(i.setContent(o.response.blockcontent),o.response.stateid&&(this.set(l,o.response.stateid),this.attachEvents(),M.blocks_workflow.init_todolist({stateid:o.response.stateid})),o.response.listworkflows&&(n=i.one(".singleselect form select").getAttribute("id"),require(["jquery"],function(e){e("#"+n).change(function(){typeof e(this).find(":selected").attr("data-ignore")==typeof undefined&&e("#"+n).closest("form").submit()})})))},end:this.removeLoading},context:this}),this.hide()},displayLoading:function(){this._loadingNode.removeClass(w)},removeLoading:function(){this._loadingNode.addClass(w)},attachEvents:function(){var e=c.one("."+u+" button, ."+u+" input[type=submit]");e&&e.on("click",this.show,this,!1),(e=c.one("."+m+" button, ."+m+" input[type=submit]"))&&e.on("click",this.show,this,!0)}},{NAME:"blocks_workflow_comments",ATTRS:{stateid:{value:null},editorid:{value:null},editorname:{validator:c.Lang.isString,value:null}}}),M.blocks_workflow=M.blocks_workflow||{},M.blocks_workflow.init_comments=function(e){return new s(e)}},"@VERSION@",{requires:["base","overlay","moodle-core-formautosubmit","moodle-core-notification"]});
\ No newline at end of file
diff --git a/yui/build/moodle-block_workflow-comments/moodle-block_workflow-comments.js b/yui/build/moodle-block_workflow-comments/moodle-block_workflow-comments.js
deleted file mode 100644
index 045a254..0000000
--- a/yui/build/moodle-block_workflow-comments/moodle-block_workflow-comments.js
+++ /dev/null
@@ -1,296 +0,0 @@
-YUI.add('moodle-block_workflow-comments', function (Y, NAME) {
-
-var COMMENTSNAME = 'blocks_workflow_comments',
- AJAXURL = '/blocks/workflow/ajax.php',
- STATEID = 'stateid',
- EDITORID = 'editorid',
- EDITORNAME = 'editorname',
- CSS = {
- BLOCKWORKFLOW: 'block_workflow',
- BLOCKCOMMENTS: 'block_workflow_comments',
- BLOCKCOMMBTN: 'block_workflow_editcommentbutton',
- BLOCKFINISHBTN: 'block_workflow_finishstepbutton',
- PANEL: 'block-workflow-panel',
- CONTENT: 'content',
- COMMENTS: 'wkf-comments',
- LIGHTBOX: 'loading-lightbox',
- LOADINGICON: 'loading-icon',
- TEXTAREA: 'wfk-textarea',
- SUBMIT: 'wfk-submit',
- HIDDEN: 'hidden'
- };
-
-var overlay = new M.core.dialogue({
- headerContent: '',
- bodyContent: Y.one('.' + CSS.PANEL),
- visible: false,
- modal: true,
- width: 'auto',
- zIndex: 100
-});
-
-var COMMENTS = function() {
- COMMENTS.superclass.constructor.apply(this, arguments);
-};
-
-Y.extend(COMMENTS, Y.Base, {
- _formSubmitEvent: null,
- _escCloseEvent: null,
- _closeButtonEvent: null,
- _loadingNode: null,
-
- initializer: function() {
- overlay.hide();
- var panel = Y.one('.' + CSS.PANEL);
- if (!panel) {
- return;
- }
- this._loadingNode = panel.one('.' + CSS.LIGHTBOX);
- this.attachEvents();
- },
-
- show: function (e, finishstep) {
- e.halt();
-
- // Different scenario depending on whether we finishing the step or just editiong the comment
- if (finishstep) {
- overlay.set('headerContent', M.str.block_workflow.finishstep);
- Y.one('.' + CSS.PANEL).one('.' + CSS.SUBMIT + ' input').set('value', M.str.block_workflow.finishstep);
- this._formSubmitEvent = Y.one('.' + CSS.SUBMIT + ' input').on('click', this.finishstep, this);
- } else {
- overlay.set('headerContent', M.str.block_workflow.editcomments);
- Y.one('.' + CSS.PANEL).one('.' + CSS.SUBMIT + ' input').set('value', M.str.moodle.savechanges);
- this._formSubmitEvent = Y.one('.' + CSS.SUBMIT + ' input').on('click', this.save, this);
- }
-
- overlay.show(); //show the overlay
- // We add a new event on the body in order to hide the overlay for the next click
- this._escCloseEvent = Y.on('key', this.hide, document.body, 'down:27', this);
-
- // Remove the existing handler for the closebutton
- Y.Event.purgeElement(Y.one('.moodle-dialogue-hd .closebutton'), true);
- // Add a new event for close button.
- this._closeButtonEvent = Y.on('click', this.hide, Y.one('.moodle-dialogue-hd .closebutton'), this);
-
- // Build the data for submission
- var data = {
- sesskey: M.cfg.sesskey,
- action: 'getcomment',
- stateid: this.get(STATEID)
- };
-
- if (typeof tinyMCE !== 'undefined') {
- var ed = tinyMCE.get(this.get(EDITORID));
-
- // Resize then editor when first shown if it would otherwise be too small.
- var ifr = tinymce.DOM.get(this.get(EDITORID) + '_ifr');
- var size = tinymce.DOM.getSize(ifr);
- if (size.h === 30) {
- ed.theme.resizeTo(size.w, 90);
- }
- }
-
- // Fetch the comment and update the form
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method:'POST',
- data:build_querystring(data),
- on: {
- start: this.displayLoading,
- complete: function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (typeof tinyMCE !== 'undefined') {
- ed.setContent(result.response.comment);
- } else {
- var editorid = this.get(EDITORID);
- var editor = Y.one(document.getElementById(editorid + 'editable'));
- if (editor) {
- editor.setHTML(result.response.comment);
- }
- Y.one(document.getElementById(editorid)).set(
- 'value', result.response.comment);
- }
- },
- end: this.removeLoading
- },
- context:this
- });
- },
-
- hide: function () {
- overlay.hide(); //hide the overlay
- if (this._escCloseEvent) {
- this._escCloseEvent.detach();
- this._escCloseEvent = null;
- }
- if (this._closeButtonEvent) {
- this._closeButtonEvent.detach();
- this._closeButtonEvent = null;
- }
- if (this._formSubmitEvent) {
- this._formSubmitEvent.detach();
- this._formSubmitEvent = null;
- }
- },
- save: function () {
- var comment;
- if (typeof tinyMCE !== 'undefined') {
- comment = tinyMCE.get(this.get(EDITORID)).getContent();
- } else {
- comment = Y.one(document.getElementById(this.get(EDITORID))).get('value');
- }
-
- var commentsblock = Y.one('.' + CSS.BLOCKWORKFLOW + ' .' + CSS.BLOCKCOMMENTS);
- // Build the data for submission
- var data = {
- sesskey: M.cfg.sesskey,
- action: 'savecomment',
- stateid: this.get(STATEID),
- text: comment,
- format: document.getElementsByName(this.get(EDITORNAME) + '[format]')[0].value
- };
-
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method:'POST',
- data:build_querystring(data),
- on: {
- start: this.displayLoading,
- complete: function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (result.response.blockcomments) {
- commentsblock.setContent(result.response.blockcomments);
- } else {
- commentsblock.setContent(M.str.block_workflow.nocomments);
- }
- },
- end: this.removeLoading
- },
- context:this
- });
- this.hide();
- },
- finishstep: function () {
- var comment;
- if (typeof tinyMCE !== 'undefined') {
- comment = tinyMCE.get(this.get(EDITORID)).getContent();
- } else {
- comment = Y.one(document.getElementById(this.get(EDITORID))).get('value');
- }
-
- var workflowblock = Y.one('.' + CSS.BLOCKWORKFLOW + ' .' + CSS.CONTENT);
- // Build the data for submission
- var data = {
- sesskey: M.cfg.sesskey,
- action: 'finishstep',
- stateid: this.get(STATEID),
- text: comment,
- format: document.getElementsByName(this.get(EDITORNAME) + '[format]')[0].value
- };
-
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method:'POST',
- data:build_querystring(data),
- on: {
- start: this.displayLoading,
- complete: function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (result.response.blockcontent) {
- // Update content
- workflowblock.setContent(result.response.blockcontent);
- if (result.response.stateid) {
- // we are on the next step
- this.set(STATEID, result.response.stateid);
- // re-attach events to block buttons
- this.attachEvents();
- // reinit todo events
- M.blocks_workflow.init_todolist({"stateid":result.response.stateid});
- }
- if (result.response.listworkflows) {
- // Last step, available workflows are listed
- var select_id = workflowblock.one('.singleselect form select').getAttribute('id');
- // Reinit single_select event
- // This is horrible, but the core JS we need is now inline in the template,
- // so we have to copy it.
- require(['jquery'], function($) {
- $('#' + select_id).change(function() {
- var ignore = $(this).find(':selected').attr('data-ignore');
- if (typeof ignore === typeof undefined) {
- $('#' + select_id).closest('form').submit();
- }
- });
- });
- }
- }
- },
- end: this.removeLoading
- },
- context:this
- });
- this.hide();
- },
- displayLoading: function() {
- this._loadingNode.removeClass(CSS.HIDDEN);
- },
- removeLoading: function() {
- this._loadingNode.addClass(CSS.HIDDEN);
- },
- attachEvents: function() {
- var commentbutton = Y.one('.' + CSS.BLOCKCOMMBTN + ' button, .' +
- CSS.BLOCKCOMMBTN + ' input[type=submit]');
- if (commentbutton) {
- commentbutton.on('click', this.show, this, false);
- }
- var finishbutton = Y.one('.' + CSS.BLOCKFINISHBTN + ' button, .' +
- CSS.BLOCKFINISHBTN + ' input[type=submit]');
- if (finishbutton) {
- finishbutton.on('click', this.show, this, true);
- }
- }
-
-}, {
- NAME: COMMENTSNAME,
- ATTRS: {
- stateid: {
- value: null
- },
- editorid: {
- value: null
- },
- editorname: {
- validator: Y.Lang.isString,
- value: null
- }
-
- }
-});
-
-M.blocks_workflow = M.blocks_workflow || {};
-M.blocks_workflow.init_comments = function(params) {
- return new COMMENTS(params);
-};
-
-
-}, '@VERSION@', {"requires": ["base", "overlay", "moodle-core-formautosubmit", "moodle-core-notification"]});
diff --git a/yui/build/moodle-block_workflow-todolist/moodle-block_workflow-todolist-debug.js b/yui/build/moodle-block_workflow-todolist/moodle-block_workflow-todolist-debug.js
deleted file mode 100644
index b383e8c..0000000
--- a/yui/build/moodle-block_workflow-todolist/moodle-block_workflow-todolist-debug.js
+++ /dev/null
@@ -1,81 +0,0 @@
-YUI.add('moodle-block_workflow-todolist', function (Y, NAME) {
-
-var TODOLISTNAME = 'blocks_workflow_todolist',
- AJAXURL = '/blocks/workflow/ajax.php',
- STATEID = 'stateid',
- CSS = {
- BLOCKWORKFLOW : 'block_workflow',
- BLOCKTODOLIST : 'block_workflow_todolist',
- BLOCKTODOTASK : 'block-workflow-todotask',
- BLOCKTODOID : 'block-workflow-todoid'
- };
-
-var TODOLIST = function() {
- TODOLIST.superclass.constructor.apply(this, arguments);
-};
-
-Y.extend(TODOLIST, Y.Base, {
-
- initializer : function() {
- // Take each of the workflow tasks, remove the anchor, and change it to
- // call our update function
- Y.all('a.' + CSS.BLOCKTODOTASK).each(function(node) {
- node.ancestor('li').on('click', this.toggle, this, node);
- node.setAttribute('href', '#');
- }, this);
- },
-
- toggle : function(e, node) {
- e.halt();
-
- // expression to fetch ID
- var reg = new RegExp(CSS.BLOCKTODOID + "-(\\d{1,})");
- // Build the data for submission
- var data = {
- sesskey : M.cfg.sesskey,
- action : 'toggletaskdone',
- stateid : this.get(STATEID),
- todoid : node.getAttribute('id').match(reg)[1]
- };
-
- // Send the query
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method : 'POST',
- data : build_querystring(data),
- on : {
- complete : function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (result.response.iscompleted) {
- node.get('parentNode').addClass('completed');
- } else {
- node.get('parentNode').removeClass('completed');
- }
- }
- }
- });
- }
-
-}, {
- NAME : TODOLISTNAME,
- ATTRS : {
- stateid: {
- value: null
- }
- }
-});
-
-M.blocks_workflow = M.blocks_workflow || {};
-M.blocks_workflow.init_todolist = function(params) {
- return new TODOLIST(params);
-};
-
-
-}, '@VERSION@', {"requires": ["base", "node", "event"]});
diff --git a/yui/build/moodle-block_workflow-todolist/moodle-block_workflow-todolist-min.js b/yui/build/moodle-block_workflow-todolist/moodle-block_workflow-todolist-min.js
deleted file mode 100644
index 4f5a8e4..0000000
--- a/yui/build/moodle-block_workflow-todolist/moodle-block_workflow-todolist-min.js
+++ /dev/null
@@ -1 +0,0 @@
-YUI.add("moodle-block_workflow-todolist",function(i,o){var t="block-workflow-todotask",e="block-workflow-todoid",s=function(){s.superclass.constructor.apply(this,arguments)};i.extend(s,i.Base,{initializer:function(){i.all("a."+t).each(function(o){o.ancestor("li").on("click",this.toggle,this,o),o.setAttribute("href","#")},this)},toggle:function(s,l){var o;s.halt(),o=new RegExp(e+"-(\\d{1,})"),o={sesskey:M.cfg.sesskey,action:"toggletaskdone",stateid:this.get("stateid"),todoid:l.getAttribute("id").match(o)[1]},i.io(M.cfg.wwwroot+"/blocks/workflow/ajax.php",{method:"POST",data:build_querystring(o),on:{complete:function(o,t){var e;try{if((e=i.JSON.parse(t.responseText)).error)return new M.core.ajaxException(e)}catch(s){new M.core.exception(s)}e.response.iscompleted?l.get("parentNode").addClass("completed"):l.get("parentNode").removeClass("completed")}}})}},{NAME:"blocks_workflow_todolist",ATTRS:{stateid:{value:null}}}),M.blocks_workflow=M.blocks_workflow||{},M.blocks_workflow.init_todolist=function(o){return new s(o)}},"@VERSION@",{requires:["base","node","event"]});
\ No newline at end of file
diff --git a/yui/build/moodle-block_workflow-todolist/moodle-block_workflow-todolist.js b/yui/build/moodle-block_workflow-todolist/moodle-block_workflow-todolist.js
deleted file mode 100644
index b383e8c..0000000
--- a/yui/build/moodle-block_workflow-todolist/moodle-block_workflow-todolist.js
+++ /dev/null
@@ -1,81 +0,0 @@
-YUI.add('moodle-block_workflow-todolist', function (Y, NAME) {
-
-var TODOLISTNAME = 'blocks_workflow_todolist',
- AJAXURL = '/blocks/workflow/ajax.php',
- STATEID = 'stateid',
- CSS = {
- BLOCKWORKFLOW : 'block_workflow',
- BLOCKTODOLIST : 'block_workflow_todolist',
- BLOCKTODOTASK : 'block-workflow-todotask',
- BLOCKTODOID : 'block-workflow-todoid'
- };
-
-var TODOLIST = function() {
- TODOLIST.superclass.constructor.apply(this, arguments);
-};
-
-Y.extend(TODOLIST, Y.Base, {
-
- initializer : function() {
- // Take each of the workflow tasks, remove the anchor, and change it to
- // call our update function
- Y.all('a.' + CSS.BLOCKTODOTASK).each(function(node) {
- node.ancestor('li').on('click', this.toggle, this, node);
- node.setAttribute('href', '#');
- }, this);
- },
-
- toggle : function(e, node) {
- e.halt();
-
- // expression to fetch ID
- var reg = new RegExp(CSS.BLOCKTODOID + "-(\\d{1,})");
- // Build the data for submission
- var data = {
- sesskey : M.cfg.sesskey,
- action : 'toggletaskdone',
- stateid : this.get(STATEID),
- todoid : node.getAttribute('id').match(reg)[1]
- };
-
- // Send the query
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method : 'POST',
- data : build_querystring(data),
- on : {
- complete : function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (result.response.iscompleted) {
- node.get('parentNode').addClass('completed');
- } else {
- node.get('parentNode').removeClass('completed');
- }
- }
- }
- });
- }
-
-}, {
- NAME : TODOLISTNAME,
- ATTRS : {
- stateid: {
- value: null
- }
- }
-});
-
-M.blocks_workflow = M.blocks_workflow || {};
-M.blocks_workflow.init_todolist = function(params) {
- return new TODOLIST(params);
-};
-
-
-}, '@VERSION@', {"requires": ["base", "node", "event"]});
diff --git a/yui/build/moodle-block_workflow-userinfo/moodle-block_workflow-userinfo-debug.js b/yui/build/moodle-block_workflow-userinfo/moodle-block_workflow-userinfo-debug.js
deleted file mode 100644
index f13e8f3..0000000
--- a/yui/build/moodle-block_workflow-userinfo/moodle-block_workflow-userinfo-debug.js
+++ /dev/null
@@ -1,83 +0,0 @@
-YUI.add('moodle-block_workflow-userinfo', function (Y, NAME) {
-
-// This file is part of Moodle - http://moodle.org/
-//
-// Moodle is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// Moodle is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with Moodle. If not, see
.
-
-
-/**
- * User info functionality for a popup in workflow block.
- *
- * @package block_workflow
- * @copyright 2014 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-var CSS = {
- USERINFO: '#userinfo',
- USERINFOCLASS: '.userinfoclass'
-};
-
-var PARAMS = {
- id: 'id',
- HEADER: 'header',
- BODY: 'body',
- STEPNO: 'stepno'
-};
-
-var POPUP = function() {
- POPUP.superclass.constructor.apply(this, arguments);
-};
-
-Y.extend(POPUP, Y.Base, {
-
- initializer : function() {
- Y.all(CSS.USERINFOCLASS).each(function(node) {
- var stepno = node.getAttribute(PARAMS.STEPNO);
- var header = node.getAttribute(PARAMS.HEADER);
- var body = node.getAttribute(PARAMS.BODY);
- node.on('click', this.display_dialog, this, stepno, header, body);
- }, this);
- },
-
- display_dialog : function (e, stepno, header, body) {
- e.preventDefault();
-
- // Configure the popup.
- var config = {
- headerContent : header,
- bodyContent : body,
- draggable : true,
- modal : true,
- zIndex : 1000,
- centered: false,
- width: 'auto',
- visible: false,
- postmethod: 'form',
- footerContent: null
- };
-
- var popup = { dialog: null };
- popup.dialog = new M.core.dialogue(config);
- popup.dialog.show();
- }
-});
-
-M.block_workflow = M.block_workflow || {};
-M.block_workflow.userinfo = M.block_workflow.userinfo || {};
-M.block_workflow.userinfo.init = function() {
- return new POPUP();
-};
-
-}, '@VERSION@', {"requires": ["base", "event", "node", "io"]});
diff --git a/yui/build/moodle-block_workflow-userinfo/moodle-block_workflow-userinfo-min.js b/yui/build/moodle-block_workflow-userinfo/moodle-block_workflow-userinfo-min.js
deleted file mode 100644
index 79f4ed0..0000000
--- a/yui/build/moodle-block_workflow-userinfo/moodle-block_workflow-userinfo-min.js
+++ /dev/null
@@ -1 +0,0 @@
-YUI.add("moodle-block_workflow-userinfo",function(o,e){var t=".userinfoclass",i="header",l="body",r="stepno",n=function(){n.superclass.constructor.apply(this,arguments)};o.extend(n,o.Base,{initializer:function(){o.all(t).each(function(o){var e=o.getAttribute(r),t=o.getAttribute(i),n=o.getAttribute(l);o.on("click",this.display_dialog,this,e,t,n)},this)},display_dialog:function(o,e,t,n){o.preventDefault(),(o={dialog:null}).dialog=new M.core.dialogue({headerContent:t,bodyContent:n,draggable:!0,modal:!0,zIndex:1e3,centered:!1,width:"auto",visible:!1,postmethod:"form",footerContent:null}),o.dialog.show()}}),M.block_workflow=M.block_workflow||{},M.block_workflow.userinfo=M.block_workflow.userinfo||{},M.block_workflow.userinfo.init=function(){return new n}},"@VERSION@",{requires:["base","event","node","io"]});
\ No newline at end of file
diff --git a/yui/build/moodle-block_workflow-userinfo/moodle-block_workflow-userinfo.js b/yui/build/moodle-block_workflow-userinfo/moodle-block_workflow-userinfo.js
deleted file mode 100644
index f13e8f3..0000000
--- a/yui/build/moodle-block_workflow-userinfo/moodle-block_workflow-userinfo.js
+++ /dev/null
@@ -1,83 +0,0 @@
-YUI.add('moodle-block_workflow-userinfo', function (Y, NAME) {
-
-// This file is part of Moodle - http://moodle.org/
-//
-// Moodle is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// Moodle is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with Moodle. If not, see
.
-
-
-/**
- * User info functionality for a popup in workflow block.
- *
- * @package block_workflow
- * @copyright 2014 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-var CSS = {
- USERINFO: '#userinfo',
- USERINFOCLASS: '.userinfoclass'
-};
-
-var PARAMS = {
- id: 'id',
- HEADER: 'header',
- BODY: 'body',
- STEPNO: 'stepno'
-};
-
-var POPUP = function() {
- POPUP.superclass.constructor.apply(this, arguments);
-};
-
-Y.extend(POPUP, Y.Base, {
-
- initializer : function() {
- Y.all(CSS.USERINFOCLASS).each(function(node) {
- var stepno = node.getAttribute(PARAMS.STEPNO);
- var header = node.getAttribute(PARAMS.HEADER);
- var body = node.getAttribute(PARAMS.BODY);
- node.on('click', this.display_dialog, this, stepno, header, body);
- }, this);
- },
-
- display_dialog : function (e, stepno, header, body) {
- e.preventDefault();
-
- // Configure the popup.
- var config = {
- headerContent : header,
- bodyContent : body,
- draggable : true,
- modal : true,
- zIndex : 1000,
- centered: false,
- width: 'auto',
- visible: false,
- postmethod: 'form',
- footerContent: null
- };
-
- var popup = { dialog: null };
- popup.dialog = new M.core.dialogue(config);
- popup.dialog.show();
- }
-});
-
-M.block_workflow = M.block_workflow || {};
-M.block_workflow.userinfo = M.block_workflow.userinfo || {};
-M.block_workflow.userinfo.init = function() {
- return new POPUP();
-};
-
-}, '@VERSION@', {"requires": ["base", "event", "node", "io"]});
diff --git a/yui/src/comments/build.json b/yui/src/comments/build.json
deleted file mode 100644
index 6ca73c2..0000000
--- a/yui/src/comments/build.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
- "name": "moodle-block_workflow-comments",
- "builds": {
- "moodle-block_workflow-comments": {
- "jsfiles": [
- "comments.js"
- ]
- }
- }
-}
diff --git a/yui/src/comments/js/comments.js b/yui/src/comments/js/comments.js
deleted file mode 100644
index a8f0d8e..0000000
--- a/yui/src/comments/js/comments.js
+++ /dev/null
@@ -1,291 +0,0 @@
-var COMMENTSNAME = 'blocks_workflow_comments',
- AJAXURL = '/blocks/workflow/ajax.php',
- STATEID = 'stateid',
- EDITORID = 'editorid',
- EDITORNAME = 'editorname',
- CSS = {
- BLOCKWORKFLOW: 'block_workflow',
- BLOCKCOMMENTS: 'block_workflow_comments',
- BLOCKCOMMBTN: 'block_workflow_editcommentbutton',
- BLOCKFINISHBTN: 'block_workflow_finishstepbutton',
- PANEL: 'block-workflow-panel',
- CONTENT: 'content',
- COMMENTS: 'wkf-comments',
- LIGHTBOX: 'loading-lightbox',
- LOADINGICON: 'loading-icon',
- TEXTAREA: 'wfk-textarea',
- SUBMIT: 'wfk-submit',
- HIDDEN: 'hidden'
- };
-
-var overlay = new M.core.dialogue({
- headerContent: '',
- bodyContent: Y.one('.' + CSS.PANEL),
- visible: false,
- modal: true,
- width: 'auto',
- zIndex: 100
-});
-
-var COMMENTS = function() {
- COMMENTS.superclass.constructor.apply(this, arguments);
-};
-
-Y.extend(COMMENTS, Y.Base, {
- _formSubmitEvent: null,
- _escCloseEvent: null,
- _closeButtonEvent: null,
- _loadingNode: null,
-
- initializer: function() {
- overlay.hide();
- var panel = Y.one('.' + CSS.PANEL);
- if (!panel) {
- return;
- }
- this._loadingNode = panel.one('.' + CSS.LIGHTBOX);
- this.attachEvents();
- },
-
- show: function (e, finishstep) {
- e.halt();
-
- // Different scenario depending on whether we finishing the step or just editiong the comment
- if (finishstep) {
- overlay.set('headerContent', M.str.block_workflow.finishstep);
- Y.one('.' + CSS.PANEL).one('.' + CSS.SUBMIT + ' input').set('value', M.str.block_workflow.finishstep);
- this._formSubmitEvent = Y.one('.' + CSS.SUBMIT + ' input').on('click', this.finishstep, this);
- } else {
- overlay.set('headerContent', M.str.block_workflow.editcomments);
- Y.one('.' + CSS.PANEL).one('.' + CSS.SUBMIT + ' input').set('value', M.str.moodle.savechanges);
- this._formSubmitEvent = Y.one('.' + CSS.SUBMIT + ' input').on('click', this.save, this);
- }
-
- overlay.show(); //show the overlay
- // We add a new event on the body in order to hide the overlay for the next click
- this._escCloseEvent = Y.on('key', this.hide, document.body, 'down:27', this);
-
- // Remove the existing handler for the closebutton
- Y.Event.purgeElement(Y.one('.moodle-dialogue-hd .closebutton'), true);
- // Add a new event for close button.
- this._closeButtonEvent = Y.on('click', this.hide, Y.one('.moodle-dialogue-hd .closebutton'), this);
-
- // Build the data for submission
- var data = {
- sesskey: M.cfg.sesskey,
- action: 'getcomment',
- stateid: this.get(STATEID)
- };
-
- if (typeof tinyMCE !== 'undefined') {
- var ed = tinyMCE.get(this.get(EDITORID));
-
- // Resize then editor when first shown if it would otherwise be too small.
- var ifr = tinymce.DOM.get(this.get(EDITORID) + '_ifr');
- var size = tinymce.DOM.getSize(ifr);
- if (size.h === 30) {
- ed.theme.resizeTo(size.w, 90);
- }
- }
-
- // Fetch the comment and update the form
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method:'POST',
- data:build_querystring(data),
- on: {
- start: this.displayLoading,
- complete: function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (typeof tinyMCE !== 'undefined') {
- ed.setContent(result.response.comment);
- } else {
- var editorid = this.get(EDITORID);
- var editor = Y.one(document.getElementById(editorid + 'editable'));
- if (editor) {
- editor.setHTML(result.response.comment);
- }
- Y.one(document.getElementById(editorid)).set(
- 'value', result.response.comment);
- }
- },
- end: this.removeLoading
- },
- context:this
- });
- },
-
- hide: function () {
- overlay.hide(); //hide the overlay
- if (this._escCloseEvent) {
- this._escCloseEvent.detach();
- this._escCloseEvent = null;
- }
- if (this._closeButtonEvent) {
- this._closeButtonEvent.detach();
- this._closeButtonEvent = null;
- }
- if (this._formSubmitEvent) {
- this._formSubmitEvent.detach();
- this._formSubmitEvent = null;
- }
- },
- save: function () {
- var comment;
- if (typeof tinyMCE !== 'undefined') {
- comment = tinyMCE.get(this.get(EDITORID)).getContent();
- } else {
- comment = Y.one(document.getElementById(this.get(EDITORID))).get('value');
- }
-
- var commentsblock = Y.one('.' + CSS.BLOCKWORKFLOW + ' .' + CSS.BLOCKCOMMENTS);
- // Build the data for submission
- var data = {
- sesskey: M.cfg.sesskey,
- action: 'savecomment',
- stateid: this.get(STATEID),
- text: comment,
- format: document.getElementsByName(this.get(EDITORNAME) + '[format]')[0].value
- };
-
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method:'POST',
- data:build_querystring(data),
- on: {
- start: this.displayLoading,
- complete: function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (result.response.blockcomments) {
- commentsblock.setContent(result.response.blockcomments);
- } else {
- commentsblock.setContent(M.str.block_workflow.nocomments);
- }
- },
- end: this.removeLoading
- },
- context:this
- });
- this.hide();
- },
- finishstep: function () {
- var comment;
- if (typeof tinyMCE !== 'undefined') {
- comment = tinyMCE.get(this.get(EDITORID)).getContent();
- } else {
- comment = Y.one(document.getElementById(this.get(EDITORID))).get('value');
- }
-
- var workflowblock = Y.one('.' + CSS.BLOCKWORKFLOW + ' .' + CSS.CONTENT);
- // Build the data for submission
- var data = {
- sesskey: M.cfg.sesskey,
- action: 'finishstep',
- stateid: this.get(STATEID),
- text: comment,
- format: document.getElementsByName(this.get(EDITORNAME) + '[format]')[0].value
- };
-
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method:'POST',
- data:build_querystring(data),
- on: {
- start: this.displayLoading,
- complete: function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (result.response.blockcontent) {
- // Update content
- workflowblock.setContent(result.response.blockcontent);
- if (result.response.stateid) {
- // we are on the next step
- this.set(STATEID, result.response.stateid);
- // re-attach events to block buttons
- this.attachEvents();
- // reinit todo events
- M.blocks_workflow.init_todolist({"stateid":result.response.stateid});
- }
- if (result.response.listworkflows) {
- // Last step, available workflows are listed
- var select_id = workflowblock.one('.singleselect form select').getAttribute('id');
- // Reinit single_select event
- // This is horrible, but the core JS we need is now inline in the template,
- // so we have to copy it.
- require(['jquery'], function($) {
- $('#' + select_id).change(function() {
- var ignore = $(this).find(':selected').attr('data-ignore');
- if (typeof ignore === typeof undefined) {
- $('#' + select_id).closest('form').submit();
- }
- });
- });
- }
- }
- },
- end: this.removeLoading
- },
- context:this
- });
- this.hide();
- },
- displayLoading: function() {
- this._loadingNode.removeClass(CSS.HIDDEN);
- },
- removeLoading: function() {
- this._loadingNode.addClass(CSS.HIDDEN);
- },
- attachEvents: function() {
- var commentbutton = Y.one('.' + CSS.BLOCKCOMMBTN + ' button, .' +
- CSS.BLOCKCOMMBTN + ' input[type=submit]');
- if (commentbutton) {
- commentbutton.on('click', this.show, this, false);
- }
- var finishbutton = Y.one('.' + CSS.BLOCKFINISHBTN + ' button, .' +
- CSS.BLOCKFINISHBTN + ' input[type=submit]');
- if (finishbutton) {
- finishbutton.on('click', this.show, this, true);
- }
- }
-
-}, {
- NAME: COMMENTSNAME,
- ATTRS: {
- stateid: {
- value: null
- },
- editorid: {
- value: null
- },
- editorname: {
- validator: Y.Lang.isString,
- value: null
- }
-
- }
-});
-
-M.blocks_workflow = M.blocks_workflow || {};
-M.blocks_workflow.init_comments = function(params) {
- return new COMMENTS(params);
-};
diff --git a/yui/src/comments/meta/comments.json b/yui/src/comments/meta/comments.json
deleted file mode 100644
index f2e1ce5..0000000
--- a/yui/src/comments/meta/comments.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
- "moodle-block_workflow-comments": {
- "requires": [
- "base",
- "overlay",
- "moodle-core-formautosubmit",
- "moodle-core-notification"
- ]
- }
-}
diff --git a/yui/src/todolist/build.json b/yui/src/todolist/build.json
deleted file mode 100644
index e6b8b5a..0000000
--- a/yui/src/todolist/build.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
- "name": "moodle-block_workflow-todolist",
- "builds": {
- "moodle-block_workflow-todolist": {
- "jsfiles": [
- "todolist.js"
- ]
- }
- }
-}
diff --git a/yui/src/todolist/js/todolist.js b/yui/src/todolist/js/todolist.js
deleted file mode 100644
index 9ed0a82..0000000
--- a/yui/src/todolist/js/todolist.js
+++ /dev/null
@@ -1,76 +0,0 @@
-var TODOLISTNAME = 'blocks_workflow_todolist',
- AJAXURL = '/blocks/workflow/ajax.php',
- STATEID = 'stateid',
- CSS = {
- BLOCKWORKFLOW : 'block_workflow',
- BLOCKTODOLIST : 'block_workflow_todolist',
- BLOCKTODOTASK : 'block-workflow-todotask',
- BLOCKTODOID : 'block-workflow-todoid'
- };
-
-var TODOLIST = function() {
- TODOLIST.superclass.constructor.apply(this, arguments);
-};
-
-Y.extend(TODOLIST, Y.Base, {
-
- initializer : function() {
- // Take each of the workflow tasks, remove the anchor, and change it to
- // call our update function
- Y.all('a.' + CSS.BLOCKTODOTASK).each(function(node) {
- node.ancestor('li').on('click', this.toggle, this, node);
- node.setAttribute('href', '#');
- }, this);
- },
-
- toggle : function(e, node) {
- e.halt();
-
- // expression to fetch ID
- var reg = new RegExp(CSS.BLOCKTODOID + "-(\\d{1,})");
- // Build the data for submission
- var data = {
- sesskey : M.cfg.sesskey,
- action : 'toggletaskdone',
- stateid : this.get(STATEID),
- todoid : node.getAttribute('id').match(reg)[1]
- };
-
- // Send the query
- Y.io(M.cfg.wwwroot + AJAXURL, {
- method : 'POST',
- data : build_querystring(data),
- on : {
- complete : function(tid, outcome) {
- var result;
- try {
- result = Y.JSON.parse(outcome.responseText);
- if (result.error) {
- return new M.core.ajaxException(result);
- }
- } catch (e) {
- new M.core.exception(e);
- }
- if (result.response.iscompleted) {
- node.get('parentNode').addClass('completed');
- } else {
- node.get('parentNode').removeClass('completed');
- }
- }
- }
- });
- }
-
-}, {
- NAME : TODOLISTNAME,
- ATTRS : {
- stateid: {
- value: null
- }
- }
-});
-
-M.blocks_workflow = M.blocks_workflow || {};
-M.blocks_workflow.init_todolist = function(params) {
- return new TODOLIST(params);
-};
diff --git a/yui/src/todolist/meta/todolist.json b/yui/src/todolist/meta/todolist.json
deleted file mode 100644
index 163167a..0000000
--- a/yui/src/todolist/meta/todolist.json
+++ /dev/null
@@ -1,9 +0,0 @@
-{
- "moodle-block_workflow-todolist": {
- "requires": [
- "base",
- "node",
- "event"
- ]
- }
-}
diff --git a/yui/src/userinfo/build.json b/yui/src/userinfo/build.json
deleted file mode 100644
index 0bafaf8..0000000
--- a/yui/src/userinfo/build.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
- "name": "moodle-block_workflow-userinfo",
- "builds": {
- "moodle-block_workflow-userinfo": {
- "jsfiles": [
- "userinfo.js"
- ]
- }
- }
-}
diff --git a/yui/src/userinfo/js/userinfo.js b/yui/src/userinfo/js/userinfo.js
deleted file mode 100644
index ff82668..0000000
--- a/yui/src/userinfo/js/userinfo.js
+++ /dev/null
@@ -1,79 +0,0 @@
-// This file is part of Moodle - http://moodle.org/
-//
-// Moodle is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// Moodle is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with Moodle. If not, see
.
-
-
-/**
- * User info functionality for a popup in workflow block.
- *
- * @package block_workflow
- * @copyright 2014 The Open University
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
-var CSS = {
- USERINFO: '#userinfo',
- USERINFOCLASS: '.userinfoclass'
-};
-
-var PARAMS = {
- id: 'id',
- HEADER: 'header',
- BODY: 'body',
- STEPNO: 'stepno'
-};
-
-var POPUP = function() {
- POPUP.superclass.constructor.apply(this, arguments);
-};
-
-Y.extend(POPUP, Y.Base, {
-
- initializer : function() {
- Y.all(CSS.USERINFOCLASS).each(function(node) {
- var stepno = node.getAttribute(PARAMS.STEPNO);
- var header = node.getAttribute(PARAMS.HEADER);
- var body = node.getAttribute(PARAMS.BODY);
- node.on('click', this.display_dialog, this, stepno, header, body);
- }, this);
- },
-
- display_dialog : function (e, stepno, header, body) {
- e.preventDefault();
-
- // Configure the popup.
- var config = {
- headerContent : header,
- bodyContent : body,
- draggable : true,
- modal : true,
- zIndex : 1000,
- centered: false,
- width: 'auto',
- visible: false,
- postmethod: 'form',
- footerContent: null
- };
-
- var popup = { dialog: null };
- popup.dialog = new M.core.dialogue(config);
- popup.dialog.show();
- }
-});
-
-M.block_workflow = M.block_workflow || {};
-M.block_workflow.userinfo = M.block_workflow.userinfo || {};
-M.block_workflow.userinfo.init = function() {
- return new POPUP();
-};
\ No newline at end of file
diff --git a/yui/src/userinfo/meta/userinfo.json b/yui/src/userinfo/meta/userinfo.json
deleted file mode 100644
index 609c5e7..0000000
--- a/yui/src/userinfo/meta/userinfo.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
- "moodle-block_workflow-userinfo": {
- "requires": [
- "base",
- "event",
- "node",
- "io"
- ]
- }
-}