[Summary view] [Print] [Text view]

   1  <?php // $Id: create_xml_file.class.php,v 1.5 2007/10/10 05:25:28 nicolasconnault Exp $
   2  
   3  ///////////////////////////////////////////////////////////////////////////
   4  //                                                                       //
   5  // NOTICE OF COPYRIGHT                                                   //
   6  //                                                                       //
   7  // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   8  //          http://moodle.com                                            //
   9  //                                                                       //
  10  // Copyright (C) 1999 onwards Martin Dougiamas        http://dougiamas.com  //
  11  //           (C) 2001-3001 Eloy Lafuente (stronk7) http://contiento.com  //
  12  //                                                                       //
  13  // This program is free software; you can redistribute it and/or modify  //
  14  // it under the terms of the GNU General Public License as published by  //
  15  // the Free Software Foundation; either version 2 of the License, or     //
  16  // (at your option) any later version.                                   //
  17  //                                                                       //
  18  // This program is distributed in the hope that it will be useful,       //
  19  // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
  20  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
  21  // GNU General Public License for more details:                          //
  22  //                                                                       //
  23  //          http://www.gnu.org/copyleft/gpl.html                         //
  24  //                                                                       //
  25  ///////////////////////////////////////////////////////////////////////////
  26  
  27  /// This class will
  28  
  29  class create_xml_file extends XMLDBAction {
  30  
  31      /**
  32       * Init method, every subclass will have its own
  33       */
  34      function init() {
  35          parent::init();
  36      /// Set own core attributes
  37          $this->can_subaction = ACTION_NONE;
  38          //$this->can_subaction = ACTION_HAVE_SUBACTIONS;
  39  
  40      /// Set own custom attributes
  41  
  42      /// Get needed strings
  43          $this->loadStrings(array(
  44          /// 'key' => 'module',
  45          ));
  46      }
  47  
  48      /**
  49       * Invoke method, every class will have its own
  50       * returns true/false on completion, setting both
  51       * errormsg and output as necessary
  52       */
  53      function invoke() {
  54          parent::invoke();
  55  
  56          $result = true;
  57  
  58      /// Set own core attributes
  59          $this->does_generate = ACTION_NONE;
  60          //$this->does_generate = ACTION_GENERATE_HTML;
  61  
  62      /// These are always here
  63          global $CFG, $XMLDB;
  64  
  65      /// Do the job, setting result as needed
  66  
  67      /// Get the dir containing the file
  68          $dirpath = required_param('dir', PARAM_PATH);
  69          $dirpath = $CFG->dirroot . stripslashes_safe($dirpath);
  70          $file = $dirpath . '/install.xml';
  71  
  72      /// Some variables
  73          $xmlpath = dirname(str_replace($CFG->dirroot . '/', '', $file));
  74          $xmlversion = userdate(time(), '%Y%m%d', 99, false);
  75          $xmlcomment = 'XMLDB file for Moodle ' . dirname($xmlpath);
  76  
  77          $xmltable = strtolower(basename(dirname($xmlpath)));
  78  
  79      /// Initial contents
  80          $c = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n";
  81          $c.= '  <XMLDB PATH="' . $xmlpath . '" VERSION="' . $xmlversion .'" COMMENT="' . $xmlcomment .'">' . "\n";
  82          $c.= '    <TABLES>' . "\n";
  83          $c.= '      <TABLE NAME="' . $xmltable . '" COMMENT="Default comment for ' . $xmltable .', please edit me">' . "\n";
  84          $c.= '        <FIELDS>' . "\n";
  85          $c.= '          <FIELD NAME="id" TYPE="int" LENGTH="10" UNSIGNED="true" NOTNULL="true" SEQUENCE="true" />' . "\n";
  86          $c.= '        </FIELDS>' . "\n";
  87          $c.= '        <KEYS>' . "\n";
  88          $c.= '          <KEY NAME="primary" TYPE="primary" FIELDS="id" />' . "\n";
  89          $c.= '        </KEYS>' . "\n";
  90          $c.= '      </TABLE>' . "\n";
  91          $c.= '    </TABLES>' . "\n";
  92          $c.= '  </XMLDB>';
  93  
  94          if (!file_put_contents($file, $c)) {
  95              $errormsg = 'Error creando fichero ' . $file;
  96              $result = false;
  97          }
  98  
  99      /// Launch postaction if exists
 100          if ($this->getPostAction() && $result) {
 101              return $this->launch($this->getPostAction());
 102          }
 103  
 104      /// Return ok if arrived here
 105          return $result;
 106      }
 107  }
 108  ?>