admin/xmldb/actions/move_updown_key/move_updown_key.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 will move one key up/down
  28
  29 class move_updown_key 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         $prev = NULL;
  79         $next = NULL;
  80         $tableparam = required_param('table', PARAM_CLEAN);
  81         $keyparam = required_param('key', PARAM_CLEAN);
  82         $direction  = required_param('direction', PARAM_ALPHA);
  83         $tables =& $structure->getTables();
  84         $table =& $structure->getTable($tableparam);
  85         $keys =& $table->getKeys();
  86         if ($direction == 'down') {
  87             $key =& $table->getKey($keyparam);
  88             $swap =& $table->getKey($key->getNext());
  89         } else {
  90             $swap =& $table->getKey($keyparam);
  91             $key =& $table->getKey($swap->getPrevious());
  92         }
  93
  94     /// Change the key before the pair
  95         if ($key->getPrevious()) {
  96             $prev =& $table->getKey($key->getPrevious());
  97             $prev->setNext($swap->getName());
  98             $swap->setPrevious($prev->getName());
  99             $prev->setChanged(true);
 100         } else {
 101             $swap->setPrevious(NULL);
 102         }
 103     /// Change the key after the pair
 104         if ($swap->getNext()) {
 105             $next =& $table->getKey($swap->getNext());
 106             $next->setPrevious($key->getName());
 107             $key->setNext($next->getName());
 108             $next->setChanged(true);
 109         } else {
 110             $key->setNext(NULL);
 111         }
 112     /// Swap the keys
 113         $key->setPrevious($swap->getName());
 114         $swap->setNext($key->getName());
 115
 116     /// Mark keys as changed
 117         $key->setChanged(true);
 118         $swap->setChanged(true);
 119
 120     /// Table has changed
 121         $table->setChanged(true);
 122
 123     /// Reorder the keys
 124         $table->orderKeys($keys);
 125
 126     /// Recalculate the hash
 127         $structure->calculateHash(true);
 128
 129     /// If the hash has changed from the original one, change the version
 130     /// and mark the structure as changed
 131         $origstructure =& $dbdir->xml_file->getStructure();
 132         if ($structure->getHash() != $origstructure->getHash()) {
 133             $structure->setVersion(userdate(time(), '%Y%m%d', 99, false));
 134             $structure->setChanged(true);
 135         }
 136
 137     /// Launch postaction if exists (leave this here!)
 138         if ($this->getPostAction() && $result) {
 139             return $this->launch($this->getPostAction());
 140         }
 141
 142     /// Return ok if arrived here
 143         return $result;
 144     }
 145 }
 146 ?>