Issue #1: Add ability to define custom content types

Author: marcusboon

.github/workflows/ci.yml

@@ -0,0 +1,14 @@
+# .github/workflows/ci.yml
+name: ci
+
+on: [push, pull_request]
+
+jobs:
+  ci:
+    uses: catalyst/catalyst-moodle-workflows/.github/workflows/ci.yml@main
+    # secrets:
+      # Required if you plan to publish (uncomment the below)
+      # moodle_org_token: ${{ secrets.MOODLE_ORG_TOKEN }}
+    with:
+      disable_behat: true
+      disable_grunt: true

README.md

@@ -1,6 +1,44 @@
-# moodle-mod_cms
+<a href="https://github.com/catalyst/moodle-mod_cms/actions">
+<img src="https://github.com/catalyst/moodle-mod_cms/workflows/ci/badge.svg">
+</a>
 
-This is a placeholder for a planned module for managing custom defined content
-types which are 'first class' concepts in Moodle. This is to enable course
-author to think in proper concepts that matter to them and not worry about
-the rendering of each content type which will be defined centrally.
+# Custom activity content types for Moodle
+
+An activity module for managing custom defined content types which are 'first class' concepts in Moodle. This is to enable course author to think in proper concepts that matter to them and not worry about the rendering of each content type which will be defined centrally.
+
+## Installation
+
+Step 1: Install the activity module
+-----------------------------------
+
+Using git submodule:
+```
+git submodule add [email protected]:catalyst/moodle-mod_cms.git mod/cms
+```
+
+OR you can download as a zip from github
+
+https://github.com/catalyst/moodle-mod_cms/archive/refs/heads/main.zip
+
+Extract this into /path/to/moodle/mod/cms
+
+Then run the Moodle upgrade as normal.
+
+https://docs.moodle.org/en/Installing_plugins
+
+# Contributing and Support
+
+Issues and pull requests using github are welcome and encouraged!
+
+https:/github.com/catalyst/moodle-mod_cms/issues
+
+If you would like commercial support or would like to sponsor additional improvements to this plugin please contact us:
+
+https://www.catalyst-au.net/contact-us
+
+# Crafted by Catalyst IT
+This plugin was developed by Catalyst IT Australia:
+
+https://www.catalyst-au.net
+
+<img alt="Catalyst IT" src="https://cdn.rawgit.com/CatalystIT-AU/moodle-auth_saml2/master/pix/catalyst-logo.svg" width="400">

classes/event/cms_type_created.php

@@ -0,0 +1,70 @@
+<?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/>.
+
+/**
+ * Event that gets triggered when a custom content type is created in the database
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<[email protected]>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_cms\event;
+
+use stdClass;
+use core\event\base;
+
+/**
+ * Event that gets triggered when a custom content type is created in the database
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<[email protected]>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class cms_type_created extends base {
+
+    /**
+     * Initialise the event data.
+     */
+    protected function init() {
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+        $this->data['crud'] = 'c';
+        $this->data['objecttable'] = 'cms_types';
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name(): string {
+        return get_string('event:cms_type_created', 'mod_cms');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description(): string {
+        $a = new stdClass();
+        $a->userid = $this->userid;
+        $a->typeid = $this->objectid;
+
+        return get_string('event:cms_type_created_desc', 'mod_cms', $a);
+    }
+}

classes/event/cms_type_deleted.php

@@ -0,0 +1,70 @@
+<?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/>.
+
+/**
+ * Event that gets triggered when a custom content type is deleted in the database
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<[email protected]>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_cms\event;
+
+use stdClass;
+use core\event\base;
+
+/**
+ * Event that gets triggered when a custom content type is deleted in the database
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<[email protected]>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class cms_type_deleted extends base {
+
+    /**
+     * Initialise the event data.
+     */
+    protected function init() {
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+        $this->data['crud'] = 'd';
+        $this->data['objecttable'] = 'cms_types';
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name(): string {
+        return get_string('event:cms_type_deleted', 'mod_cms');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description(): string {
+        $a = new stdClass();
+        $a->userid = $this->userid;
+        $a->typeid = $this->objectid;
+
+        return get_string('event:cms_type_deleted_desc', 'mod_cms', $a);
+    }
+}

classes/event/cms_type_updated.php

@@ -0,0 +1,70 @@
+<?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/>.
+
+/**
+ * Event that gets triggered when a custom content type is updated in the database
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<[email protected]>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_cms\event;
+
+use stdClass;
+use core\event\base;
+
+/**
+ * Event that gets triggered when a custom content type is updated in the database
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<[email protected]>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class cms_type_updated extends base {
+
+    /**
+     * Initialise the event data.
+     */
+    protected function init() {
+        $this->data['edulevel'] = self::LEVEL_OTHER;
+        $this->data['crud'] = 'u';
+        $this->data['objecttable'] = 'cms_types';
+    }
+
+    /**
+     * Return localised event name.
+     *
+     * @return string
+     */
+    public static function get_name(): string {
+        return get_string('event:cms_type_updated', 'mod_cms');
+    }
+
+    /**
+     * Returns description of what happened.
+     *
+     * @return string
+     */
+    public function get_description(): string {
+        $a = new stdClass();
+        $a->userid = $this->userid;
+        $a->typeid = $this->objectid;
+
+        return get_string('event:cms_type_updated_desc', 'mod_cms', $a);
+    }
+}

classes/event/course_module_instance_list_viewed.php

@@ -0,0 +1,39 @@
+<?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/>.
+
+/**
+ * The mod_cms instance list viewed event.
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<[email protected]>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_cms\event;
+
+use core\event\course_module_instance_list_viewed as core_course_module_instance_list_viewed;
+
+/**
+ * The mod_cms instance list viewed event.
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<[email protected]>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class course_module_instance_list_viewed extends core_course_module_instance_list_viewed {
+    // Everything is handled by the parent class.
+}

classes/event/course_module_viewed.php

@@ -0,0 +1,57 @@
+<?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/>.
+
+/**
+ * The mod_cms course module viewed event.
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<[email protected]>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_cms\event;
+
+use core\event\course_module_viewed as core_course_module_viewed;
+
+/**
+ * The mod_cms course module viewed event.
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<[email protected]>
+ * @copyright   Catalyst IT
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class course_module_viewed extends core_course_module_viewed {
+
+    /**
+     * Init method.
+     */
+    protected function init() {
+        $this->data['objecttable'] = 'cms';
+        $this->data['crud'] = 'r';
+        $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
+    }
+
+    /**
+     * Get objectid mapping.
+     */
+    public static function get_objectid_mapping() {
+        return [
+            'db' => 'cms',
+            'restore' => 'cms',
+        ];
+    }
+}