first commit

course/classes/hook/after_course_created.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 core_course\hook;
+
+use stdClass;
+
+/**
+ * Hook after course creation.
+ *
+ * This hook will be dispatched after the course is created and events are fired.
+ *
+ * @package    core_course
+ * @copyright  2024 Safat Shahin <safat.shahin@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\label('Allows plugins or features to perform actions after a course is created.')]
+#[\core\attribute\tags('course')]
+class after_course_created {
+    /**
+     * Constructor for the hook.
+     *
+     * @param stdClass $course The course instance.
+     */
+    public function __construct(
+        /** @var stdClass The course instance */
+        public readonly stdClass $course,
+    ) {
+    }
+}

course/classes/hook/after_course_updated.php

@@ -0,0 +1,47 @@
+<?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 core_course\hook;
+
+use stdClass;
+
+/**
+ * Hook after course updates.
+ *
+ * @package    core_course
+ * @copyright  2024 Safat Shahin <safat.shahin@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\label('Allows plugins or features to perform actions after a course is updated.')]
+#[\core\attribute\tags('course')]
+class after_course_updated {
+    /**
+     * Constructor for the hook.
+     *
+     * @param stdClass $course The course instance.
+     * @param stdClass $oldcourse The old course instance.
+     * @param bool $changeincoursecat Whether the course category has changed.
+     */
+    public function __construct(
+        /** @var stdClass The course instance */
+        public readonly stdClass $course,
+        /** @var stdClass The old course instance */
+        public readonly stdClass $oldcourse,
+        /** @var bool Whether the course category has changed */
+        public readonly bool $changeincoursecat = false,
+    ) {
+    }
+}

course/classes/hook/after_form_definition.php

@@ -0,0 +1,48 @@
+<?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 core_course\hook;
+
+use core\hook\described_hook;
+use course_edit_form;
+use MoodleQuickForm;
+
+/**
+ * Allows plugins to extend course form definition and add/remove/update form elements.
+ *
+ * @see course_edit_form::definition()
+ *
+ * @package    core_course
+ * @copyright  2023 Dmitrii Metelkin <dmitriim@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\label('Allows plugins to extend course editing form')]
+#[\core\attribute\tags('course')]
+class after_form_definition {
+    /**
+     * Creates new hook.
+     *
+     * @param course_edit_form $formwrapper Course form wrapper.
+     * @param MoodleQuickForm $mform Form to be extended.
+     */
+    public function __construct(
+        /** @var course_edit_form The form wrapper for the edit form */
+        public readonly course_edit_form $formwrapper,
+        /** @var MoodlequickForm The form to be extended */
+        public readonly MoodleQuickForm $mform,
+    ) {
+    }
+}

course/classes/hook/after_form_definition_after_data.php

@@ -0,0 +1,47 @@
+<?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 core_course\hook;
+
+use course_edit_form;
+use MoodleQuickForm;
+
+/**
+ * Allows plugins to extend course form after data is set.
+ *
+ * @see course_edit_form::definition_after_data()
+ *
+ * @package    core_course
+ * @copyright  2023 Dmitrii Metelkin <dmitriim@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\label('Allows plugins to extend course editing form after data is set')]
+#[\core\attribute\tags('course')]
+class after_form_definition_after_data {
+    /**
+     * Creates new hook.
+     *
+     * @param course_edit_form $formwrapper Course form wrapper..
+     * @param MoodleQuickForm $mform Form to be extended.
+     */
+    public function __construct(
+        /** @var course_edit_form The form wrapper for the edit form */
+        public readonly course_edit_form $formwrapper,
+        /** @var MoodlequickForm The form to be extended */
+        public readonly MoodleQuickForm $mform,
+    ) {
+    }
+}

course/classes/hook/after_form_submission.php

@@ -0,0 +1,54 @@
+<?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 core_course\hook;
+
+/**
+ * Allows plugins to extend course form submission.
+ *
+ * @see create_course()
+ * @see update_course()
+ *
+ * @package    core_course
+ * @copyright  2023 Dmitrii Metelkin <dmitriim@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\label('Allows plugins to extend saving of the course editing form')]
+#[\core\attribute\tags('course')]
+class after_form_submission {
+    /**
+     * Creates new hook.
+     *
+     * @param \stdClass $data Submitted data
+     * @param bool $isnewcourse Whether this is a new course
+     */
+    public function __construct(
+        /** @var \stdClass The submitted data */
+        protected \stdClass $data,
+        /** @var bool Whether this is a new course */
+        public readonly bool $isnewcourse = false,
+    ) {
+    }
+
+    /**
+     * Returns submitted data.
+     *
+     * @return \stdClass
+     */
+    public function get_data(): \stdClass {
+        return $this->data;
+    }
+}

course/classes/hook/after_form_validation.php

@@ -0,0 +1,92 @@
+<?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 core_course\hook;
+
+use course_edit_form;
+
+/**
+ * Allows plugins to extend course form validation.
+ *
+ * @see course_edit_form::validation()
+ *
+ * @package    core_course
+ * @copyright  2023 Dmitrii Metelkin <dmitriim@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\label('Allow plugins to extend a validation of the course editing form')]
+#[\core\attribute\tags('course')]
+class after_form_validation {
+    /**
+     * Plugin errors.
+     *
+     * @var array
+     */
+    protected $errors = [];
+
+    /**
+     * Creates new hook.
+     *
+     * @param course_edit_form $formwrapper Course form wrapper..
+     * @param array $data Submitted data.
+     * @param array $files Submitted files.
+     */
+    public function __construct(
+        /** @var course_edit_form Course form wrapper */
+        public readonly course_edit_form $formwrapper,
+        /** @var array The submitted data */
+        private array $data,
+        /** @var array Submitted files */
+        private array $files = [],
+    ) {
+    }
+
+    /**
+     * Returns submitted data.
+     *
+     * @return array
+     */
+    public function get_data(): array {
+        return $this->data;
+    }
+
+    /**
+     * Returns submitted files.
+     *
+     * @return array
+     */
+    public function get_files(): array {
+        return $this->files;
+    }
+
+    /**
+     * Return plugin generated errors.
+     *
+     * @return array
+     */
+    public function get_errors(): array {
+        return $this->errors;
+    }
+
+    /**
+     * Plugins implementing a callback can add validation errors.
+     *
+     * @param array $errors Validation errors generated by a plugin.
+     */
+    public function add_errors(array $errors): void {
+        $this->errors = array_merge($this->errors, $errors);
+    }
+}

course/classes/hook/before_course_deleted.php

@@ -0,0 +1,46 @@
+<?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 core_course\hook;
+
+use stdClass;
+use Psr\EventDispatcher\StoppableEventInterface;
+
+/**
+ * Hook before course deletion.
+ *
+ * @package    core_course
+ * @copyright  2024 Safat Shahin <safat.shahin@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+#[\core\attribute\label('Allows plugins or features to perform actions before a course is deleted.')]
+#[\core\attribute\tags('course')]
+class before_course_deleted implements
+    StoppableEventInterface
+{
+    use \core\hook\stoppable_trait;
+
+    /**
+     * Constructor for the hook.
+     *
+     * @param stdClass $course The course instance.
+     */
+    public function __construct(
+        /** @var stdClass The course instance */
+        public readonly stdClass $course,
+    ) {
+    }
+}