communication/classes/form_provider.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 namespace core_communication;
  18
  19 /**
  20  * Interface form_provider to manage communication provider form options from provider plugins.
  21  *
  22  * Every provider plugin should implement this class to return the implemented form elements for custom data.
  23  *
  24  * @package    core_communication
  25  * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
  26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27  */
  28 interface form_provider {
  29     /**
  30      * Set the form data to the instance if any data is available.
  31      *
  32      * @param \stdClass $instance The actual instance to set the data
  33      */
  34     public function save_form_data(\stdClass $instance): void;
  35
  36     /**
  37      * Set the form data to the instance if any data is available.
  38      *
  39      * @param \stdClass $instance The actual instance to set the data
  40      */
  41     public function set_form_data(\stdClass $instance): void;
  42
  43     /**
  44      * Set the form definitions.
  45      *
  46      * @param \MoodleQuickForm $mform The form object
  47      */
  48     public static function set_form_definition(\MoodleQuickForm $mform): void;
  49 }