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/>.

/**
 * @package    tool_lifecycle
 * @copyright  2017 Tobias Reischmann WWU
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

define('ACTION_ENABLE_TRIGGER', 'enable');
define('ACTION_DISABLE_TRIGGER', 'disable');
define('ACTION_UP_TRIGGER', 'up_trigger');
define('ACTION_DOWN_TRIGGER', 'down_trigger');
define('ACTION_WORKFLOW_TRIGGER', 'workflow_trigger');
define('ACTION_UP_STEP', 'up_step');
define('ACTION_DOWN_STEP', 'down_step');
define('ACTION_UP_WORKFLOW', 'up_workflow');
define('ACTION_DOWN_WORKFLOW', 'down_workflow');
define('ACTION_STEP_INSTANCE_FORM', 'step_instance_form');
define('SETTINGS_TYPE_TRIGGER', 'trigger');
define('SETTINGS_TYPE_STEP', 'step');
define('ACTION_TRIGGER_INSTANCE_FORM', 'trigger_instance_form');
define('ACTION_TRIGGER_INSTANCE_DELETE', 'trigger_instance_delete');
define('ACTION_STEP_INSTANCE_DELETE', 'step_instance_delete');
define('ACTION_WORKFLOW_INSTANCE_FROM', 'workflow_instance_form');
define('ACTION_WORKFLOW_DELETE', 'workflow_instance_delete');
define('ACTION_WORKFLOW_DUPLICATE', 'workflow_instance_duplicate');
define('ACTION_WORKFLOW_ACTIVATE', 'workflow_instance_activate');
define('ACTION_WORKFLOW_DISABLE', 'workflow_instance_disable');
define('ACTION_WORKFLOW_ABORTDISABLE', 'workflow_instance_abortdisable');
define('ACTION_WORKFLOW_ABORT', 'workflow_instance_abort');

/**
 * Adds a tool_lifecycle link to the course admin menu.
 *
 * @param navigation_node $navigation The navigation node to extend
 * @param stdClass $course The course to object for the tool
 * @param context $context The context of the course
 * @return void|null return null if we don't want to display the node.
 */
function tool_lifecycle_extend_navigation_course($navigation, $course, $context) {
    global $PAGE;

    // Only add this settings item on non-site course pages.
    if (!$PAGE->course || $PAGE->course->id == SITEID) {
        return null;
    }

    $url = null;
    $settingnode = null;

    $url = new moodle_url('/admin/tool/lifecycle/view.php', array(
        'contextid' => $context->id
    ));

    // Add the course life cycle link.
    $pluginname = get_string('plugintitle', 'tool_lifecycle');

    $node = navigation_node::create(
        $pluginname,
        $url,
        navigation_node::NODETYPE_LEAF,
        'tool_lifecycle',
        'tool_lifecycle',
        new pix_icon('recycle', $pluginname, 'tool_lifecycle')
    );

    if ($PAGE->url->compare($url, URL_MATCH_BASE)) {
        $node->make_active();
    }

    $navigation->add_node($node);
}

/**
 * Map icons for font-awesome themes.
 */
function tool_lifecycle_get_fontawesome_icon_map() {
    return [
        'tool_lifecycle:recycle' => 'fa-recycle',
        'tool_lifecycle:t/disable' => 'fa-hand-paper-o',
    ];
}