admin/xmldb/actions/new_index/new_index.class.php

   1 <?php // $Id$
   2
   3 ///////////////////////////////////////////////////////////////////////////
   4 //                                                                       //
   5 // NOTICE OF COPYRIGHT                                                   //
   6 //                                                                       //
   7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   8 //          http://moodle.com                                            //
   9 //                                                                       //
  10 // Copyright (C) 2001-3001 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 create a new default index to be edited
  28
  29 class new_index extends XMLDBAction {
  30
  31     /**
  32      * Init method, every subclass will have its own
  33      */
  34     function init() {
  35         parent::init();
  36
  37     /// Set own custom attributes
  38
  39     /// Get needed strings
  40         $this->loadStrings(array(
  41         /// 'key' => 'module',
  42         ));
  43     }
  44
  45     /**
  46      * Invoke method, every class will have its own
  47      * returns true/false on completion, setting both
  48      * errormsg and output as necessary
  49      */
  50     function invoke() {
  51         parent::invoke();
  52
  53         $result = true;
  54
  55     /// Set own core attributes
  56         $this->does_generate = ACTION_NONE;
  57         //$this->does_generate = ACTION_GENERATE_HTML;
  58
  59     /// These are always here
  60         global $CFG, $XMLDB;
  61
  62     /// Do the job, setting result as needed
  63     /// Get the dir containing the file
  64         $dirpath = required_param('dir', PARAM_PATH);
  65         $dirpath = $CFG->dirroot . stripslashes_safe($dirpath);
  66
  67     /// Get the correct dirs
  68         if (!empty($XMLDB->dbdirs)) {
  69             $dbdir =& $XMLDB->dbdirs[$dirpath];
  70         } else {
  71             return false;
  72         }
  73         if (!empty($XMLDB->editeddirs)) {
  74             $editeddir =& $XMLDB->editeddirs[$dirpath];
  75             $structure =& $editeddir->xml_file->getStructure();
  76         }
  77     /// ADD YOUR CODE HERE
  78
  79     $tableparam = required_param('table', PARAM_CLEAN);
  80
  81     $table =& $structure->getTable($tableparam);
  82
  83     /// If the changeme index exists, just get it and continue
  84         $changeme_exists = false;
  85         if ($indexes =& $table->getIndexes()) {
  86             if ($index =& $table->getIndex('changeme')) {
  87                 $changeme_exists = true;
  88             }
  89         }
  90         if (!$changeme_exists) { /// Lets create the Index
  91             $index = new XMLDBIndex('changeme');
  92             $index->setComment('Default comment for the index, please edit me');
  93             $table->addIndex($index);
  94
  95         /// We have one new key, so the structure has changed
  96             $structure->setVersion(userdate(time(), '%Y%m%d', 99, false));
  97             $structure->setChanged(true);
  98         }
  99     /// Launch postaction if exists (leave this here!)
 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 ?>