Add ability to manage custom content types

classes/manage_content_types.php

@@ -0,0 +1,278 @@
+<?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/>.
+
+/**
+ * Class for managing the custom content types.
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<marcus@catalyst-au.net>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace mod_cms;
+
+use stdClass;
+use moodle_url;
+use core\notification;
+use mod_cms\model\cms_types;
+use mod_cms\form\cms_types_form;
+use mod_cms\local\table\content_types_list;
+
+class manage_content_types {
+
+    /**
+     * Locally cached $OUTPUT object
+     */
+    protected $output;
+
+    public function __construct() {
+        global $OUTPUT;
+
+        $this->output = $OUTPUT;
+    }
+
+    /**
+     * Execute the required action.
+     *
+     * @param string $action
+     *
+     * @return void
+     */
+    public function execute(string $action): void {
+        $this->set_external_page();
+        switch($action) {
+            case 'add':
+            case 'edit':
+                $this->edit($action, optional_param('id', null, PARAM_INT));
+                break;
+            case 'delete':
+                $this->delete(required_param('id', PARAM_INT));
+                break;
+            case 'view':
+            default:
+                $this->view();
+                break;
+        }
+    }
+
+    /**
+     * Set external page.
+     *
+     * @return void
+     */
+    protected function set_external_page(): void {
+        admin_externalpage_setup('mod_cms/managetypes');
+    }
+
+    /**
+     * Return record instance.
+     *
+     * @param int      $id
+     * @param stdClass $data
+     *
+     * @return cms_types
+     */
+    protected function get_instance($id = 0, ?stdClass $data = null): cms_types {
+        return new cms_types($id, $data);
+    }
+
+    /**
+     * Print out all records in the table.
+     *
+     * @return void
+     */
+    protected function display_all_records(): void {
+        $records = cms_types::get_records([], 'id');
+
+        $table = new content_types_list();
+        $table->display($records);
+    }
+
+    /**
+     * Returns a text for create new record button.
+     *
+     * @return string
+     */
+    protected function get_create_button_text(): string {
+        return get_string('addnewtype', 'mod_cms');
+    }
+
+    /**
+     * Returns a form for the record.
+     *
+     * @param cms_types $type
+     *
+     * @return cms_types_form
+     */
+    protected function get_form(?cms_types $type = null): cms_types_form {
+        global $PAGE;
+
+        return new cms_types_form($PAGE->url->out(false), ['persistent' => $type]);
+    }
+
+    /**
+     * View page heading string.
+     *
+     * @return string
+     */
+    protected function get_view_heading(): string {
+        return get_string('managetypes', 'mod_cms');
+    }
+
+    /**
+     * New content type heading string.
+     *
+     * @return string
+     */
+    protected function get_new_heading(): string {
+        return get_string('newcontenttype', 'mod_cms');
+    }
+
+    /**
+     * Edit content type heading string.
+     *
+     * @return string
+     */
+    protected function get_edit_heading(): string {
+        return get_string('editcontenttype', 'mod_cms');
+    }
+
+    /**
+     * Return the base URL.
+     *
+     * @return string
+     */
+    public static function get_base_url(): string {
+        return '/mod/cms/managetypes.php';
+    }
+
+    /**
+     * Execute edit action.
+     *
+     * @param string $action Could be edit or create.
+     * @param int    $id     If no ID is provided, that means we are creating a new one
+     *
+     * @return void
+     */
+    protected function edit(string $action, ?int $id = null): void {
+        global $PAGE;
+
+        $PAGE->set_url(new moodle_url(self::get_base_url(), ['action' => $action, 'id' => $id]));
+        $instance = null;
+
+        if (!empty($id)) {
+            $instance = $this->get_instance($id);
+        }
+
+        $form = $this->get_form($instance);
+
+        if ($form->is_cancelled()) {
+            redirect(new moodle_url(self::get_base_url()));
+        } else if ($data = $form->get_data()) {
+            unset($data->submitbutton);
+            try {
+                // Create new.
+                if (empty($data->id)) {
+                    $contenttype = $this->get_instance(0, $data);
+                    $contenttype->create();
+                } else { // Update existing.
+                    $instance->from_record($data);
+                    $instance->update();
+                }
+                notification::success(get_string('changessaved'));
+            } catch (Exception $e) {
+                notification::error($e->getMessage());
+            }
+            redirect(new moodle_url(self::get_base_url()));
+        } else {
+            if (empty($instance)) {
+                $this->header($this->get_new_heading());
+            } else {
+                $this->header($this->get_edit_heading());
+            }
+        }
+
+        $form->display();
+        $this->footer();
+    }
+
+    /**
+     * Execute delete action.
+     *
+     * @param int $id
+     *
+     * @return void
+     */
+    protected function delete(int $id): void {
+        require_sesskey();
+        $instance = $this->get_instance($id);
+
+        if ($instance->can_delete()) {
+            $instance->delete();
+            notification::success(get_string('deleted'));
+        } else {
+            notification::warning(get_string('cantdelete', 'mod_cms'));
+        }
+        redirect(new moodle_url(self::get_base_url()));
+    }
+
+    /**
+     * Execute view action.
+     *
+     * @return void
+     */
+    protected function view(): void {
+        global $PAGE;
+
+        $PAGE->set_url(self::get_base_url());
+        $this->header($this->get_view_heading());
+        $this->print_add_button();
+        $this->display_all_records();
+
+        $PAGE->requires->js_call_amd('mod_cms/managecontenttypes', 'setup');
+        $this->footer();
+    }
+
+    /**
+     * Print out add button.
+     */
+    protected function print_add_button(): void {
+        echo $this->output->single_button(
+            new moodle_url(self::get_base_url(), ['action' => 'add']),
+            $this->get_create_button_text()
+        );
+    }
+
+    /**
+     * Print out page header.
+     *
+     * @param string $title
+     *
+     * @return void
+     */
+    protected function header(string $title): void {
+        echo $this->output->header();
+        echo $this->output->heading($title);
+    }
+
+    /**
+     * Print out the page footer.
+     *
+     * @return void
+     */
+    protected function footer(): void {
+        echo $this->output->footer();
+    }
+}

lang/en/cms.php

@@ -24,6 +24,8 @@
 
 defined('MOODLE_INTERNAL') || die();
 
+$string['addnewtype'] = 'Add new content type';
+$string['editcontenttype'] = 'Edit content type';
 $string['event:cms_type_created'] = 'Custom content type created';
 $string['event_cms_type_created_desc'] = 'The user with ID: {$a->userid} has created a custom content type with ID: {$a->typeid}';
 $string['event:cms_type_deleted'] = 'Custom content type deleted';
@@ -34,5 +36,7 @@
 $string['maxgrade'] = 'Default max grade';
 $string['maxgrade_desc'] = 'The default max grade when creating a new custom content type instance.';
 $string['modulename'] = 'CMS';
+$string['newcontenttype'] = 'Add new content type';
 $string['pluginname'] = 'CMS';
 $string['settings'] = 'Custom content type settings';
+$string['table:name'] = 'Custom content type';

managetypes.php

@@ -0,0 +1,36 @@
+<?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/>.
+
+/**
+ * Admin page to configure the custom content types
+ *
+ * @package     mod_cms
+ * @author      Marcus Boon<marcus@catalyst-au.net>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+use mod_cms\manage_content_types;
+
+require_once('../../config.php');
+require_once($CFG->libdir.'/adminlib.php');
+
+require_login();
+
+$action = optional_param('action', 'view', PARAM_ALPHANUMEXT);
+$PAGE->set_context(context_system::instance());
+
+$contenttypes = new manage_content_types();
+$contenttypes->execute($action);
+