communication/classes/communication_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  * A base communication provider.
  21  *
  22  * This interface should be used to declare support for the instantiation method for communication providers.
  23  *
  24  * Every communication provider must, as a minimum, implement this provider.
  25  *
  26  * @package    core_communication
  27  * @copyright  2023 Andrew Lyons <andrew@nicols.co.uk>
  28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29  */
  30 interface communication_provider {
  31     /**
  32      * A base communication provider.
  33      *
  34      * @param processor $communication The communication object
  35      */
  36     public static function load_for_instance(processor $communication): self;
  37
  38     /**
  39      * Check if the provider is configured or not.
  40      *
  41      * This method is intended to check if the plugin have got any settings and if all the settings are set properly.
  42      * This checking helps to reduce errors in future when a communication instance is added for the provider and not configured.
  43      */
  44     public static function is_configured(): bool;
  45 }