first commit

course/classes/local/entity/activity_chooser_footer.php

@@ -0,0 +1,86 @@
+<?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/>.
+
+/**
+ * Activity Chooser footer data class.
+ *
+ * @package    core
+ * @subpackage course
+ * @copyright  2020 Mathew May <mathew.solutions>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace core_course\local\entity;
+
+/**
+ * A class to represent the Activity Chooser footer data.
+ *
+ * @package    core
+ * @subpackage course
+ * @copyright  2020 Mathew May <mathew.solutions>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class activity_chooser_footer {
+
+    /** @var string $footerjspath The path to the plugin JS file to dynamically import later. */
+    protected $footerjspath;
+
+    /** @var string $footertemplate The rendered template for the footer. */
+    protected $footertemplate;
+
+    /** @var string $carouseltemplate The rendered template for the footer. */
+    protected $carouseltemplate;
+
+    /**
+     * Constructor method.
+     *
+     * @param string $footerjspath JS file to dynamically import later.
+     * @param string $footertemplate Footer template that has been rendered.
+     * @param string|null $carouseltemplate Carousel template that may have been rendered.
+     */
+    public function __construct(string $footerjspath, string $footertemplate, ?string $carouseltemplate = '') {
+        $this->footerjspath = $footerjspath;
+        $this->footertemplate = $footertemplate;
+        $this->carouseltemplate = $carouseltemplate;
+    }
+
+    /**
+     *  Get the footer JS file path for this plugin.
+     *
+     * @return string The JS file to call functions from.
+     */
+    public function get_footer_js_file(): string {
+        return $this->footerjspath;
+    }
+
+    /**
+     * Get the footer rendered template for this plugin.
+     *
+     * @return string The template that has been rendered for the chooser footer.
+     */
+    public function get_footer_template(): string {
+        return $this->footertemplate;
+    }
+
+    /**
+     * Get the carousel rendered template for this plugin.
+     *
+     * @return string The template that has been rendered for the chooser carousel.
+     */
+    public function get_carousel_template(): string {
+        return $this->carouseltemplate;
+    }
+}

course/classes/local/entity/content_item.php

@@ -0,0 +1,182 @@
+<?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/>.
+
+/**
+ * Contains the content_item class.
+ *
+ * @package    core
+ * @subpackage course
+ * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core_course\local\entity;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * The content_item class.
+ *
+ * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class content_item {
+    /** @var int $id the id. */
+    private $id;
+
+    /** @var string $name the name. */
+    private $name;
+
+    /** @var title $title the title. */
+    private $title;
+
+    /** @var \moodle_url $link the url for the content item's setup page (usually mod/edit.php). */
+    private $link;
+
+    /** @var string $icon an html string containing the icon for this item. */
+    private $icon;
+
+    /** @var string $help the description/help text for this content item. */
+    private $help;
+
+    /** @var int $achetype a module archetype, e.g. MOD_ARCHETYPE_RESOURCE, MOD_ARCHETYPE_OTHER. */
+    private $archetype;
+
+    /** @var string $componentname the name of the component from which this content item originates. */
+    private $componentname;
+
+    /** @var string $purpose the purpose type of this component. */
+    private $purpose;
+
+    /** @var bool $branded whether or not this component is branded. */
+    private $branded;
+
+    /**
+     * The content_item constructor.
+     *
+     * @param int $id Id number.
+     * @param string $name Name of the item, not human readable.
+     * @param title $title Human readable title for the item.
+     * @param \moodle_url $link The URL to the creation page, with any item specific params
+     * @param string $icon HTML containing the icon for the item
+     * @param string $help The description of the item.
+     * @param int $archetype the archetype for the content item (see MOD_ARCHETYPE_X definitions in lib/moodlelib.php).
+     * @param string $componentname the name of the component/plugin with which this content item is associated.
+     * @param string $purpose the purpose type of this component.
+     * @param bool $branded whether or not this item is branded.
+     */
+    public function __construct(int $id, string $name, title $title, \moodle_url $link, string $icon, string $help,
+            int $archetype, string $componentname, string $purpose, bool $branded = false) {
+        $this->id = $id;
+        $this->name = $name;
+        $this->title = $title;
+        $this->link = $link;
+        $this->icon = $icon;
+        $this->help = $help;
+        $this->archetype = $archetype;
+        $this->componentname = $componentname;
+        $this->purpose = $purpose;
+        $this->branded = $branded;
+    }
+
+    /**
+     * Get the name of the component with which this content item is associated.
+     *
+     * @return string
+     */
+    public function get_component_name(): string {
+        return $this->componentname;
+    }
+
+    /**
+     * Get the help description of this item.
+     *
+     * @return string
+     */
+    public function get_help(): string {
+        return $this->help;
+    }
+
+    /**
+     * Get the archetype of this item.
+     *
+     * @return int
+     */
+    public function get_archetype(): int {
+        return $this->archetype;
+    }
+
+    /**
+     * Get the id of this item.
+     * @return int
+     */
+    public function get_id(): int {
+        return $this->id;
+    }
+
+    /**
+     * Get the name of this item.
+     *
+     * @return string
+     */
+    public function get_name(): string {
+        return $this->name;
+    }
+
+    /**
+     * Get the human readable title of this item.
+     *
+     * @return title
+     */
+    public function get_title(): title {
+        return $this->title;
+    }
+
+    /**
+     * Get the link to the creation page of this item.
+     *
+     * @return \moodle_url
+     */
+    public function get_link(): \moodle_url {
+        return $this->link;
+    }
+
+    /**
+     * Get the icon html for this item.
+     *
+     * @return string
+     */
+    public function get_icon(): string {
+        return $this->icon;
+    }
+
+    /**
+     * Get purpose for this item.
+     *
+     * @return string
+     */
+    public function get_purpose(): string {
+        return $this->purpose;
+    }
+
+    /**
+     * Whether this item is branded.
+     *
+     * @return bool true if this item is branded, false otherwise.
+     */
+    public function is_branded(): bool {
+        return $this->branded;
+    }
+}

course/classes/local/entity/lang_string_title.php

@@ -0,0 +1,62 @@
+<?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/>.
+
+/**
+ * Contains the lang_string_title class of value object, providing access to the value of a lang string.
+ *
+ * @package    core
+ * @subpackage course
+ * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core_course\local\entity;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * The lang_string_title class of value object, providing access to the value of a lang string.
+ *
+ * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class lang_string_title implements title {
+
+    /** @var string $component the component name. */
+    private $component;
+
+    /** @var string $identifier the string identifier. */
+    private $identifier;
+
+    /**
+     * The lang_string_title constructor.
+     *
+     * @param string $identifier the component name.
+     * @param string $component the string identifier.
+     */
+    public function __construct(string $identifier, string $component) {
+        $this->identifier = $identifier;
+        $this->component = $component;
+    }
+
+    /**
+     * Returns the value of the wrapped string.
+     *
+     * @return string the value of the string.
+     */
+    public function get_value(): string {
+        return get_string($this->identifier, $this->component);
+    }
+}

course/classes/local/entity/string_title.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/>.
+
+/**
+ * Contains the string_title class of value object, which provides access to a simple string.
+ *
+ * @package    core
+ * @subpackage course
+ * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core_course\local\entity;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * The string_title class of value object, which provides access to a simple string.
+ *
+ * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class string_title implements title {
+
+    /** @var string $title the title string. */
+    private $title;
+
+    /**
+     * The string_title constructor.
+     *
+     * @param string $title a string.
+     */
+    public function __construct(string $title) {
+        $this->title = $title;
+    }
+
+    /**
+     * Return the value of the wrapped string.
+     *
+     * @return string
+     */
+    public function get_value(): string {
+        return $this->title;
+    }
+}

course/classes/local/entity/title.php

@@ -0,0 +1,35 @@
+<?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/>.
+
+/**
+ * Contains the title value object interface, which provides a basic interface to a string.
+ *
+ * @package    core
+ * @subpackage course
+ * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core_course\local\entity;
+
+defined('MOODLE_INTERNAL') || die();
+
+interface title {
+
+    /**
+     * Get the value of this title.
+     */
+    public function get_value(): string;
+}