[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  /**
  18   * @package    tool_xmldb
  19   * @copyright  2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  20   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  21   */
  22  
  23  /**
  24   * This class will create a new default table to be edited
  25   *
  26   * @package    tool_xmldb
  27   * @copyright  2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  28   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29   */
  30  class new_table extends XMLDBAction {
  31  
  32      /**
  33       * Init method, every subclass will have its own
  34       */
  35      function init() {
  36          parent::init();
  37  
  38          // Set own custom attributes
  39  
  40          // Get needed strings
  41          $this->loadStrings(array(
  42              // 'key' => 'module',
  43          ));
  44      }
  45  
  46      /**
  47       * Invoke method, every class will have its own
  48       * returns true/false on completion, setting both
  49       * errormsg and output as necessary
  50       */
  51      function invoke() {
  52          parent::invoke();
  53  
  54          $result = true;
  55  
  56          // Set own core attributes
  57          $this->does_generate = ACTION_NONE;
  58          //$this->does_generate = ACTION_GENERATE_HTML;
  59  
  60          // These are always here
  61          global $CFG, $XMLDB;
  62  
  63          // Do the job, setting result as needed
  64          // Get the dir containing the file
  65          $dirpath = required_param('dir', PARAM_PATH);
  66          $dirpath = $CFG->dirroot . $dirpath;
  67  
  68          // Get the correct dirs
  69          if (!empty($XMLDB->dbdirs)) {
  70              $dbdir = $XMLDB->dbdirs[$dirpath];
  71          } else {
  72              return false;
  73          }
  74          if (!empty($XMLDB->editeddirs)) {
  75              $editeddir = $XMLDB->editeddirs[$dirpath];
  76              $structure = $editeddir->xml_file->getStructure();
  77          }
  78  
  79          // If the changeme table exists, just get it and continue
  80          $changeme_exists = false;
  81          if ($tables = $structure->getTables()) {
  82              if ($table = $structure->getTable('changeme')) {
  83                  $changeme_exists = true;
  84              }
  85          }
  86          if (!$changeme_exists) { // Lets create the table
  87              $field = new xmldb_field('id');
  88              $field->setType(XMLDB_TYPE_INTEGER);
  89              $field->setLength(10);
  90              $field->setNotNull(true);
  91              $field->setSequence(true);
  92              $field->setLoaded(true);
  93              $field->setChanged(true);
  94  
  95              $key = new xmldb_key('primary');
  96              $key->setType(XMLDB_KEY_PRIMARY);
  97              $key->setFields(array('id'));
  98              $key->setLoaded(true);
  99              $key->setChanged(true);
 100  
 101              $table = new xmldb_table('changeme');
 102              $table->setComment('Default comment for the table, please edit me');
 103              $table->addField($field);
 104              $table->addKey($key);
 105  
 106              // Finally, add the whole retrofitted table to the structure
 107              // in the place specified
 108              $structure->addTable($table);
 109          }
 110          // Launch postaction if exists (leave this here!)
 111          if ($this->getPostAction() && $result) {
 112              return $this->launch($this->getPostAction());
 113          }
 114  
 115          // Return ok if arrived here
 116          return $result;
 117      }
 118  }
 119