lib.php

<?php
// 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 <http://www.gnu.org/licenses/>.

/**
 * Global functions for tool_trigger plugin.
 *
 * @package    tool_trigger
 * @copyright  Matt Porritt <mattp@catalyst-au.net>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

use tool_trigger\steps\base\base_form;
use tool_trigger\import_form;

/**
 * Renders the top part of the "new workflow step" modal form. (The part with
 * the "Step type" and "Step" menus.
 *
 * @param array $args
 * @param context $args['context']
 * @return string
 */
function tool_trigger_output_fragment_new_base_form($args) {
    require_capability('tool/trigger:manageworkflows', $args['context']);

    $mform = new base_form();

    ob_start();
    $mform->display();
    $o = ob_get_contents();
    ob_end_clean();

    return $o;
}

/**
 * Renders the full form for a particular step class, for the "new workflow
 * step" modal form.
 *
 * @param array   $args
 * @param context $args['context']
 * @param string  $args['steptype'] The steptype to display in the form.
 * @param string  $args['stepclass'] The stepclass to display in the form.
 * @param string  $args['defaults'] Default values to populate the form with (JSON-encoded array)
 * @param string  $args['ajaxformdata'] Serialized form submission data, if the form
 * is being redisplayed after failed validation.
 * @return string
 */
function tool_trigger_output_fragment_new_step_form($args) {
    $context = $args['context'];
    require_capability('tool/trigger:manageworkflows', $context);

    $event = clean_param($args['event'], PARAM_RAW_TRIMMED);
    $existingsteps = json_decode(clean_param($args['existingsteps'], PARAM_RAW_TRIMMED), true);
    $steptype = clean_param($args['steptype'], PARAM_ALPHA);
    $steporder = clean_param($args['steporder'], PARAM_INT);

    $stepclass = clean_param($args['stepclass'], PARAM_RAW);
    $workflowmanager = new \tool_trigger\workflow_manager();
    $stepclassobj = $workflowmanager->validate_and_make_step($stepclass);

    $customdata = array(
        'type'      => $steptype,
        'stepclass' => $stepclass,
        'steptext'  => $stepclass::get_step_name(),
        'steps' => $workflowmanager->get_steps_by_type($steptype),
        'event' => $event,
        'existingsteps' => $existingsteps,
        'steporder' => $steporder
    );

    $ajaxformdata = array();
    if (!empty($args['ajaxformdata'])) {
        // Don't need to clean/validate these, because formslib will do that.
        parse_str($args['ajaxformdata'], $ajaxformdata);

        // Apply any data transforms - determined in each step's class.
        $ajaxformdata = $stepclassobj->transform_form_data($ajaxformdata);
    }

    $mform = $stepclassobj->make_form($customdata, $ajaxformdata);

    if (!empty($args['defaults'])) {
        // Don't need to clean/validate these, because formslib will do that.

        $data = json_decode($args['defaults'], true);

        // Requirement for new editor to populate text area..
        if (!empty($data['emailcontent_editor[text]'])) {
            $data['emailcontent'] = "";
            $data['emailcontentformat'] = $data['emailcontent_editor[format]'];
            $data['emailcontent_editor']['text'] = $data['emailcontent_editor[text]'];
            $data['emailcontent_editor']['format'] = $data['emailcontent_editor[format]'];
            $data['emailcontent_editor']['itemid'] = $data['id'];
            $data['emailcontenttrust'] = false;
        }

        // Also fix up duration for debouncing.
        if (!empty($data['debounceduration[number]'])) {
            $data['debounceduration']['number'] = $data['debounceduration[number]'];
            $data['debounceduration']['timeunit'] = $data['debounceduration[timeunit]'];
        }

        // Apply any data transforms - determined in each step's class.
        $data = $stepclassobj->transform_form_data($data);

        $mform->set_data($data);
    }

    if (!empty($ajaxformdata)) {
        // If we were passed non-empty form data we want the mform to call validation functions and show errors.
        $mform->is_validated();
    }

    ob_start();
    $mform->display();
    $o = ob_get_contents();
    ob_end_clean();

    return $o;
}

/**
 * Renders the import workflow from file form.
 *
 * @param array $args
 * @return string
 */
function tool_trigger_output_fragment_new_import_form($args) {
    require_capability('tool/trigger:manageworkflows', $args['context']);

    $mform = new import_form(null, null, 'post', '', ['class' => 'ignoredirty']);

    ob_start();
    $mform->display();
    $o = ob_get_contents();
    ob_end_clean();

    return $o;
}