Skip to content

Commit

Permalink
Merge branch 'MDL-64587-master' of https://github.com/junpataleta/moodle
Browse files Browse the repository at this point in the history
  • Loading branch information
David Monllaó committed Feb 18, 2019
2 parents ceea116 + b0e8a83 commit 0a828b5
Show file tree
Hide file tree
Showing 3 changed files with 168 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.

/**
* @package tool_xmldb
* @copyright 2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

/**
* Add the mandatory fields for persistent to the table.
*
* @package tool_xmldb
* @copyright 2019 Michael Aherne
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class add_persistent_mandatory extends XMLDBAction {

function init() {

parent::init();

// Get needed strings.
$this->loadStrings(array(
'addpersistent' => 'tool_xmldb',
'persistentfieldsconfirm' => 'tool_xmldb',
'persistentfieldscomplete' => 'tool_xmldb',
'persistentfieldsexist' => 'tool_xmldb',
'back' => 'core'
));

}

function getTitle() {
return $this->str['addpersistent'];
}

function invoke() {

parent::invoke();

$this->does_generate = ACTION_GENERATE_HTML;

global $CFG, $XMLDB, $OUTPUT;

$dir = required_param('dir', PARAM_PATH);
$dirpath = $CFG->dirroot . $dir;

if (empty($XMLDB->dbdirs)) {
return false;
}

if (!empty($XMLDB->editeddirs)) {
$editeddir = $XMLDB->editeddirs[$dirpath];
$structure = $editeddir->xml_file->getStructure();
}

$tableparam = required_param('table', PARAM_ALPHANUMEXT);

/** @var xmldb_table $table */
$table = $structure->getTable($tableparam);

$result = true;
// Launch postaction if exists (leave this here!)
if ($this->getPostAction() && $result) {
return $this->launch($this->getPostAction());
}

$confirm = optional_param('confirm', false, PARAM_BOOL);

$fields = ['usermodified', 'timecreated', 'timemodified'];
$existing = [];
foreach ($fields as $field) {
if ($table->getField($field)) {
$existing[] = $field;
}
}

$returnurl = new \moodle_url('/admin/tool/xmldb/index.php', [
'table' => $tableparam,
'dir' => $dir,
'action' => 'edit_table'
]);

$backbutton = html_writer::link($returnurl, '[' . $this->str['back'] . ']');
$actionbuttons = html_writer::tag('p', $backbutton, ['class' => 'centerpara buttons']);

if (!$confirm) {

if (!empty($existing)) {

$message = html_writer::span($this->str['persistentfieldsexist']);
$message .= html_writer::alist($existing);
$this->output .= $OUTPUT->notification($message);

if (count($existing) == count($fields)) {
$this->output .= $actionbuttons;
return true;
}
}

$confirmurl = new \moodle_url('/admin/tool/xmldb/index.php', [
'table' => $tableparam,
'dir' => $dir,
'action' => 'add_persistent_mandatory',
'sesskey' => sesskey(),
'confirm' => '1'
]);

$message = html_writer::span($this->str['persistentfieldsconfirm']);
$message .= html_writer::alist(array_diff($fields, $existing));
$this->output .= $OUTPUT->confirm($message, $confirmurl, $returnurl);

} else {

$fieldsadded = [];
foreach ($fields as $field) {
if (!in_array($field, $existing)) {
$fieldsadded[] = $field;
$table->add_field($field, XMLDB_TYPE_INTEGER, 10, null, XMLDB_NOTNULL, null, 0);
}
}

if (!$table->getKey('usermodified')) {
$table->add_key('usermodified', XMLDB_KEY_FOREIGN, ['usermodified'], 'user', ['id']);
}

$structure->setVersion(userdate(time(), '%Y%m%d', 99, false));
$structure->setChanged(true);

$message = html_writer::span($this->str['persistentfieldscomplete']);
$message .= html_writer::alist(array_diff($fields, $existing));
$this->output .= $OUTPUT->notification($message, 'success');

$this->output .= $actionbuttons;
}

return $result;
}

}
10 changes: 10 additions & 0 deletions admin/tool/xmldb/actions/edit_table/edit_table.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ function init() {

// Get needed strings
$this->loadStrings(array(
'addpersistent' => 'tool_xmldb',
'change' => 'tool_xmldb',
'vieworiginal' => 'tool_xmldb',
'viewedited' => 'tool_xmldb',
Expand Down Expand Up @@ -177,6 +178,15 @@ function invoke() {
$b .= '<a href="index.php?action=view_table_sql&amp;table=' . $tableparam . '&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $dirpath)) . '">[' .$this->str['viewsqlcode'] . ']</a>';
// The view php code button
$b .= '&nbsp;<a href="index.php?action=view_table_php&amp;table=' . $tableparam . '&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $dirpath)) . '">[' . $this->str['viewphpcode'] . ']</a>';
// The add persistent fields button.
$url = new \moodle_url('/admin/tool/xmldb/index.php', [
'action' => 'add_persistent_mandatory',
'sesskey' => sesskey(),
'table' => $tableparam,
'dir'=> str_replace($CFG->dirroot, '', $dirpath)
]);
$b .= '&nbsp;' . \html_writer::link($url, '[' . $this->str['addpersistent'] . ']');

// The save button (if possible)
if ($cansavenow) {
$b .= '&nbsp;<a href="index.php?action=save_xml_file&amp;sesskey=' . sesskey() . '&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $dirpath)) . '&amp;time=' . time() . '&amp;unload=false&amp;postaction=edit_table&amp;table=' . $tableparam . '&amp;dir=' . urlencode(str_replace($CFG->dirroot, '', $dirpath)) . '">[' . $this->str['save'] . ']</a>';
Expand Down
4 changes: 4 additions & 0 deletions admin/tool/xmldb/lang/en/tool_xmldb.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
*/

$string['actual'] = 'Actual';
$string['addpersistent'] = 'Add mandatory persistent fields';
$string['aftertable'] = 'After table:';
$string['back'] = 'Back';
$string['backtomainview'] = 'Back to main';
Expand Down Expand Up @@ -169,6 +170,9 @@
$string['pendingchanges'] = 'Note: You have performed changes to this file. They can be saved at any moment.';
$string['pendingchangescannotbesaved'] = 'There are changes in this file but they cannot be saved! Please verify that both the directory and the "install.xml" within it have write permissions for the web server.';
$string['pendingchangescannotbesavedreload'] = 'There are changes in this file but they cannot be saved! Please verify that both the directory and the "install.xml" within it have write permissions for the web server. Then reload this page and you should be able to save those changes.';
$string['persistentfieldsconfirm'] = 'Do you want to add the following fields: ';
$string['persistentfieldscomplete'] = 'The following fields have been added: ';
$string['persistentfieldsexist'] = 'The following fields already exist: ';
$string['pluginname'] = 'XMLDB editor';
$string['primarykeyonlyallownotnullfields'] = 'Primary keys cannot be null';
$string['reserved'] = 'Reserved';
Expand Down

0 comments on commit 0a828b5

Please sign in to comment.