admin/xmldb/actions/edit_xml_file_save/edit_xml_file_save.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) 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 save the changes performed to the comment of one file
  28
  29 class edit_xml_file_save 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
  64         if (!data_submitted('nomatch')) { ///Basic prevention
  65             error('Wrong action call');
  66         }
  67
  68     /// Get parameters
  69         $dirpath = required_param('dir', PARAM_PATH);
  70         $dirpath = $CFG->dirroot . stripslashes_safe($dirpath);
  71
  72         $comment = required_param('comment', PARAM_CLEAN);
  73         $comment = stripslashes_safe($comment);
  74
  75     /// Set comment and recalculate hash
  76         $editeddir =& $XMLDB->editeddirs[$dirpath];
  77         $structure =& $editeddir->xml_file->getStructure();
  78         $structure->setComment($comment);
  79         $structure->calculateHash(true);
  80
  81
  82     /// If the hash has changed from the original one, change the version
  83     /// and mark the structure as changed
  84         $origdir =& $XMLDB->dbdirs[$dirpath];
  85         $origstructure =& $origdir->xml_file->getStructure();
  86         if ($structure->getHash() != $origstructure->getHash()) {
  87             $structure->setVersion(userdate(time(), '%Y%m%d', 99, false));
  88             $structure->setChanged(true);
  89         }
  90
  91     /// Launch postaction if exists (leave this here!)
  92         if ($this->getPostAction() && $result) {
  93             return $this->launch($this->getPostAction());
  94         }
  95
  96     /// Return ok if arrived here
  97         return $result;
  98     }
  99 }
 100 ?>