first commit

mod/data/field/menu/classes/privacy/provider.php

@@ -0,0 +1,71 @@
+<?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/>.
+/**
+ * Privacy Subsystem implementation for datafield_menu.
+ *
+ * @package    datafield_menu
+ * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace datafield_menu\privacy;
+use core_privacy\local\request\writer;
+use mod_data\privacy\datafield_provider;
+
+defined('MOODLE_INTERNAL') || die();
+/**
+ * Privacy Subsystem for datafield_menu implementing null_provider.
+ *
+ * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider,
+        datafield_provider {
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return  string
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+
+    /**
+     * Exports data about one record in {data_content} table.
+     *
+     * @param \context_module $context
+     * @param \stdClass $recordobj record from DB table {data_records}
+     * @param \stdClass $fieldobj record from DB table {data_fields}
+     * @param \stdClass $contentobj record from DB table {data_content}
+     * @param \stdClass $defaultvalue pre-populated default value that most of plugins will use
+     */
+    public static function export_data_content($context, $recordobj, $fieldobj, $contentobj, $defaultvalue) {
+        $defaultvalue->field['options'] = preg_split('/\s*\n\s*/', trim($fieldobj->param1), -1, PREG_SPLIT_NO_EMPTY);
+        writer::with_context($context)->export_data([$recordobj->id, $contentobj->id], $defaultvalue);
+    }
+
+    /**
+     * Allows plugins to delete locally stored data.
+     *
+     * @param \context_module $context
+     * @param \stdClass $recordobj record from DB table {data_records}
+     * @param \stdClass $fieldobj record from DB table {data_fields}
+     * @param \stdClass $contentobj record from DB table {data_content}
+     */
+    public static function delete_data_content($context, $recordobj, $fieldobj, $contentobj) {
+
+    }
+}

mod/data/field/menu/field.class.php

@@ -0,0 +1,176 @@
+<?php
+///////////////////////////////////////////////////////////////////////////
+//                                                                       //
+// NOTICE OF COPYRIGHT                                                   //
+//                                                                       //
+// Moodle - Modular Object-Oriented Dynamic Learning Environment         //
+//          http://moodle.org                                            //
+//                                                                       //
+// Copyright (C) 1999-onwards Moodle Pty Ltd  http://moodle.com          //
+//                                                                       //
+// This program 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 2 of the License, or     //
+// (at your option) any later version.                                   //
+//                                                                       //
+// This program 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:                          //
+//                                                                       //
+//          http://www.gnu.org/copyleft/gpl.html                         //
+//                                                                       //
+///////////////////////////////////////////////////////////////////////////
+
+class data_field_menu extends data_field_base {
+
+    var $type = 'menu';
+    /**
+     * priority for globalsearch indexing
+     *
+     * @var int
+     */
+    protected static $priority = self::HIGH_PRIORITY;
+
+    public function supports_preview(): bool {
+        return true;
+    }
+
+    public function get_data_content_preview(int $recordid): stdClass {
+        $options = explode("\n", $this->field->param1);
+        $options = array_map('trim', $options);
+        $selected = $options[$recordid % count($options)];
+        return (object)[
+            'id' => 0,
+            'fieldid' => $this->field->id,
+            'recordid' => $recordid,
+            'content' => $selected,
+            'content1' => null,
+            'content2' => null,
+            'content3' => null,
+            'content4' => null,
+        ];
+    }
+
+    function display_add_field($recordid = 0, $formdata = null) {
+        global $DB, $OUTPUT;
+
+        if ($formdata) {
+            $fieldname = 'field_' . $this->field->id;
+            $content = $formdata->$fieldname;
+        } else if ($recordid) {
+            $content = $DB->get_field('data_content', 'content', array('fieldid'=>$this->field->id, 'recordid'=>$recordid));
+            $content = trim($content);
+        } else {
+            $content = '';
+        }
+        $str = '<div title="' . s($this->field->description) . '">';
+
+        $options = array();
+        $rawoptions = explode("\n",$this->field->param1);
+        foreach ($rawoptions as $option) {
+            $option = trim($option);
+            if (strlen($option) > 0) {
+                $options[$option] = $option;
+            }
+        }
+
+        $str .= '<label for="' . 'field_' . $this->field->id . '">';
+        $str .= html_writer::span($this->field->name, 'accesshide');
+        if ($this->field->required) {
+            $image = $OUTPUT->pix_icon('req', get_string('requiredelement', 'form'));
+            $str .= html_writer::div($image, 'inline-req');
+        }
+        $str .= '</label>';
+        $str .= html_writer::select($options, 'field_'.$this->field->id, $content, array('' => get_string('menuchoose', 'data')),
+                                    array('id' => 'field_'.$this->field->id, 'class' => 'mod-data-input custom-select'));
+
+        $str .= '</div>';
+
+        return $str;
+    }
+
+    function display_search_field($content = '') {
+        global $CFG, $DB;
+
+        $varcharcontent =  $DB->sql_compare_text('content', 255);
+        $sql = "SELECT DISTINCT $varcharcontent AS content
+                  FROM {data_content}
+                 WHERE fieldid=? AND content IS NOT NULL";
+
+        $usedoptions = array();
+        if ($used = $DB->get_records_sql($sql, array($this->field->id))) {
+            foreach ($used as $data) {
+                $value = $data->content;
+                if ($value === '') {
+                    continue;
+                }
+                $usedoptions[$value] = $value;
+            }
+        }
+
+        $options = array();
+        foreach (explode("\n",$this->field->param1) as $option) {
+            $option = trim($option);
+            if (!isset($usedoptions[$option])) {
+                continue;
+            }
+            $options[$option] = $option;
+        }
+        if (!$options) {
+            // oh, nothing to search for
+            return '';
+        }
+
+        $return = html_writer::label(get_string('fieldtypelabel', "datafield_" . $this->type),
+            'menuf_' . $this->field->id, false, array('class' => 'accesshide'));
+        $return .= html_writer::select($options, 'f_'.$this->field->id, $content, array('' => get_string('menuchoose', 'data')),
+                array('class' => 'custom-select'));
+        return $return;
+    }
+
+    public function parse_search_field($defaults = null) {
+        $param = 'f_'.$this->field->id;
+        if (empty($defaults[$param])) {
+            $defaults = array($param => '');
+        }
+        return optional_param($param, $defaults[$param], PARAM_NOTAGS);
+    }
+
+    function generate_sql($tablealias, $value) {
+        global $DB;
+
+        static $i=0;
+        $i++;
+        $name = "df_menu_$i";
+        $varcharcontent = $DB->sql_compare_text("{$tablealias}.content", 255);
+
+        return array(" ({$tablealias}.fieldid = {$this->field->id} AND $varcharcontent = :$name) ", array($name=>$value));
+    }
+
+    /**
+     * Check if a field from an add form is empty
+     *
+     * @param mixed $value
+     * @param mixed $name
+     * @return bool
+     */
+    function notemptyfield($value, $name) {
+        return strval($value) !== '';
+    }
+
+    /**
+     * Return the plugin configs for external functions.
+     *
+     * @return array the list of config parameters
+     * @since Moodle 3.3
+     */
+    public function get_config_for_external() {
+        // Return all the config parameters.
+        $configs = [];
+        for ($i = 1; $i <= 10; $i++) {
+            $configs["param$i"] = $this->field->{"param$i"};
+        }
+        return $configs;
+    }
+}

mod/data/field/menu/lang/en/datafield_menu.php

@@ -0,0 +1,29 @@
+<?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/>.
+
+/**
+ * Strings for component 'datafield_menu', language 'en', branch 'master'
+ *
+ * @package    datafield
+ * @subpackage menu
+ * @copyright  2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['pluginname'] = 'Dropdown list';
+$string['fieldtypelabel'] = 'Dropdown list';
+$string['privacy:metadata'] = 'The Dropdown list field component doesn\'t store any personal data; it uses tables defined in mod_data.';

mod/data/field/menu/templates/menu.mustache

@@ -0,0 +1,54 @@
+{{!
+    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/>.
+}}
+{{!
+    @template datafield_menu/menu
+
+    The purpose of this template is to enable the user to define a menu field.
+
+    Classes required for JS:
+    * none
+
+    Data attributes required for JS:
+    * none
+
+    Context variables required for this template:
+    * name string The field's name.
+    * description string The field's description.
+    * required bool The field's requiredness.
+    * param1 string The field's options.
+
+    Example context (json):
+    {
+        "name": "A name",
+        "description": "A description",
+        "required": true,
+        "param1": "One\nTwo\nThree"
+    }
+}}
+
+<fieldset>
+    {{> mod_data/fields/basicfields }}
+    {{> mod_data/fields/requiredfield }}
+    <div class="form-group row fitem">
+        <div class="col-md-3 col-form-label d-flex pb-0 pr-md-0">
+            <label for="param1">{{#str}}fieldoptions, data{{/str}}</label>
+        </div>
+        <div class="col-md-9 form-inline align-items-start felement">
+            <textarea class="optionstextarea form-control" name="param1" id="param1" cols="80" rows="10">{{param1}}</textarea>
+        </div>
+    </div>
+</fieldset>

mod/data/field/menu/version.php

@@ -0,0 +1,28 @@
+<?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/>.
+
+/**
+ * @package    datafield
+ * @subpackage menu
+ * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->version   = 2024042200;        // The current plugin version (Date: YYYYMMDDXX).
+$plugin->requires  = 2024041600;        // Requires this Moodle version.
+$plugin->component = 'datafield_menu';  // Full name of the plugin (used for diagnostics)