[Summary view]

   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_xapi;
  18  
  19  /**
  20   * The xAPI internal API.
  21   *
  22   * @package    core_xapi
  23   * @copyright  2023 Ferran Recio
  24   * @since      Moodle 4.2
  25   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26   */
  27  class api {
  28      /**
  29       * Delete all states from a component.
  30       *
  31       * @param string $component The component name in frankenstyle.
  32       * @return void
  33       */
  34      public static function remove_states_from_component(string $component): void {
  35          global $DB;
  36  
  37          $statestore = null;
  38          $dbman = $DB->get_manager();
  39          try {
  40              $handler = handler::create($component);
  41              $statestore = $handler->get_state_store();
  42          } catch (xapi_exception $exception) {
  43              // If the component is not available but the xapi_states table exists, use the standard one to ensure we clean it.
  44              $table = new \xmldb_table('xapi_states');
  45              if ($dbman->table_exists($table)) {
  46                  $statestore = new state_store($component);
  47              }
  48          }
  49          if ($statestore) {
  50              $statestore->wipe();
  51          }
  52      }
  53  
  54      /**
  55       * Execute the states clean up for all compatible components.
  56       *
  57       * @return void
  58       */
  59      public static function execute_state_cleanup(): void {
  60          foreach (\core_component::get_plugin_types() as $ptype => $unused) {
  61              $components = \core_component::get_plugin_list_with_class($ptype, 'xapi\handler');
  62              foreach ($components as $component => $unused) {
  63                  $handler = handler::create($component);
  64                  $statestore = $handler->get_state_store();
  65                  $statestore->cleanup();
  66              }
  67          }
  68      }
  69  }