first commit

mod/bigbluebuttonbn/classes/local/extension/action_url_addons.php

@@ -0,0 +1,43 @@
+<?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/>.
+namespace mod_bigbluebuttonbn\local\extension;
+
+/**
+ * A single action class to mutate the action URL.
+ *
+ * @package   mod_bigbluebuttonbn
+ * @copyright 2023 onwards, Blindside Networks Inc
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author    Laurent David (laurent@call-learning.fr)
+ */
+class action_url_addons {
+    /**
+     * Mutate the action URL.
+     *
+     * By design:
+     *  1. we should only add parameters
+     *  2. we cannot count on the order the subplugins are called
+     *
+     * @param string $action
+     * @param array $data
+     * @param array $metadata
+     * @return array associative array with the additional data and metadata (indexed by 'data' and
+     * 'metadata' keys).
+     */
+    public function execute(string $action = '', array $data = [], array $metadata = []): array {
+        return ['data' => [], 'metadata' => []];
+    }
+}

mod/bigbluebuttonbn/classes/local/extension/custom_completion_addons.php

@@ -0,0 +1,79 @@
+<?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/>.
+namespace mod_bigbluebuttonbn\local\extension;
+
+use cm_info;
+
+/**
+ * A class to deal with completion rules addons in a subplugin
+ *
+ * @package   mod_bigbluebuttonbn
+ * @copyright 2023 onwards, Blindside Networks Inc
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author    Laurent David (laurent@call-learning.fr)
+ */
+abstract class custom_completion_addons {
+    /** @var cm_info The course module information object. */
+    protected $cm;
+
+    /** @var int The user's ID. */
+    protected $userid;
+
+    /** @var array The current state of core completion */
+    protected $completionstate;
+
+    /**
+     * activity_custom_completion constructor.
+     *
+     * @param cm_info $cm
+     * @param int $userid
+     * @param array|null $completionstate The current state of the core completion criteria
+     */
+    public function __construct(cm_info $cm, int $userid, ?array $completionstate = null) {
+        $this->cm = $cm;
+        $this->userid = $userid;
+        $this->completionstate = $completionstate;
+    }
+
+    /**
+     * Fetches the completion state for a given completion rule.
+     *
+     * @param string $rule The completion rule.
+     * @return int The completion state.
+     */
+    abstract public function get_state(string $rule): int;
+
+    /**
+     * Fetch the list of custom completion rules that this module defines.
+     *
+     * @return array
+     */
+    abstract public static function get_defined_custom_rules(): array;
+
+    /**
+     * Returns an associative array of the descriptions of custom completion rules.
+     *
+     * @return array
+     */
+    abstract public function get_custom_rule_descriptions(): array;
+
+    /**
+     * Returns an array of all completion rules, in the order they should be displayed to users.
+     *
+     * @return array
+     */
+    abstract public function get_sort_order(): array;
+}

mod/bigbluebuttonbn/classes/local/extension/mod_form_addons.php

@@ -0,0 +1,113 @@
+<?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/>.
+namespace mod_bigbluebuttonbn\local\extension;
+
+use stdClass;
+
+/**
+ * A class for the main mod form extension
+ *
+ * @package   mod_bigbluebuttonbn
+ * @copyright 2023 onwards, Blindside Networks Inc
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author    Laurent David (laurent@call-learning.fr)
+ */
+abstract class mod_form_addons {
+    /**
+     * @var \MoodleQuickForm|null moodle form
+     */
+    protected $mform = null;
+
+    /**
+     * @var stdClass|null $bigbluebuttonbndata BigBlueButton data if any
+     */
+    protected $bigbluebuttonbndata = null;
+
+    /**
+     * @var string|null $suffix suffix for form elements
+     */
+    protected $suffix = null;
+
+    /**
+     * Constructor
+     *
+     * @param \MoodleQuickForm $mform
+     * @param stdClass|null $bigbluebuttonbndata
+     * @param string|null $suffix
+     */
+    public function __construct(\MoodleQuickForm &$mform, ?stdClass $bigbluebuttonbndata = null, string $suffix = null) {
+        $this->mform = $mform;
+        $this->bigbluebuttonbndata = $bigbluebuttonbndata;
+        $this->suffix = $suffix;
+    }
+
+    /**
+     * Add new form field definition
+     */
+    abstract public function add_fields(): void;
+
+    /**
+     * Validate form and returns an array of errors indexed by field name
+     *
+     * @param array $data
+     * @param array $files
+     * @return array
+     */
+    abstract public function validation(array $data, array $files): array;
+
+    /**
+     * Allows modules to modify the data returned by form get_data().
+     * This method is also called in the bulk activity completion form.
+     *
+     * Only available on moodleform_mod.
+     *
+     * @param stdClass $data passed by reference
+     */
+    abstract public function data_postprocessing(\stdClass &$data): void;
+
+    /**
+     * Can be overridden to add custom completion rules if the module wishes
+     * them. If overriding this, you should also override completion_rule_enabled.
+     * <p>
+     * Just add elements to the form as needed and return the list of IDs. The
+     * system will call disabledIf and handle other behaviour for each returned
+     * ID.
+     *
+     * @return string[] Array of string IDs of added items, empty array if none
+     */
+    abstract public function add_completion_rules(): array;
+
+    /**
+     * Called during validation. Override to indicate, based on the data, whether
+     * a custom completion rule is enabled (selected).
+     *
+     * @param array $data Input data (not yet validated)
+     * @return bool True if one or more rules is enabled, false if none are;
+     *   default returns false
+     */
+    public function completion_rule_enabled(array $data): bool {
+        return false;
+    }
+
+    /**
+     * Form adjustments after setting data
+     *
+     * @return void
+     */
+    public function definition_after_data() {
+        // Nothing for now.
+    }
+}

mod/bigbluebuttonbn/classes/local/extension/mod_instance_helper.php

@@ -0,0 +1,60 @@
+<?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/>.
+namespace mod_bigbluebuttonbn\local\extension;
+use stdClass;
+
+/**
+ * Class defining a way to deal with instance save/update/delete in extension
+ *
+ * @package   mod_bigbluebuttonbn
+ * @copyright 2023 onwards, Blindside Networks Inc
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @author    Laurent David (laurent@call-learning.fr)
+ */
+class mod_instance_helper {
+    /**
+     * Runs any processes that must run before a bigbluebuttonbn insert/update.
+     *
+     * @param stdClass $bigbluebuttonbn BigBlueButtonBN form data
+     */
+    public function add_instance(stdClass $bigbluebuttonbn) {
+        // Nothing for now.
+    }
+    /**
+     * Runs any processes that must be run after a bigbluebuttonbn insert/update.
+     *
+     * @param stdClass $bigbluebuttonbn BigBlueButtonBN form data
+     */
+    public function update_instance(stdClass $bigbluebuttonbn): void {
+        // Nothing for now.
+    }
+
+    /**
+     * Runs any processes that must be run after a bigbluebuttonbn delete.
+     *
+     * @param int $cmid
+     */
+    public function delete_instance(int $cmid): void {
+    }
+
+    /**
+     * Get any join table name that is used to store additional data for the instance.
+     * @return string[]
+     */
+    public function get_join_tables(): array {
+        return [];
+    }
+}