moodle/admin/tool/xmldb
Eloy Lafuente (stronk7) ebd0f69daa MDL-73764 tool_xmldb: New report to show all xml files needing reconcile
People uses to edit the install.xml files manually, here and there. That
uses to come with small mistakes, like wrong white-space indentation,
some attributes out of order...

While none of them are critical, they add a lot of noise when somebody
is correctly editing a file with the XMLDB Editor because it, correctly,
overwrites the whole file and then diffs show a lot of unrelated changes.

So, this report will inform us about any file needing to be regenerated
because it has been manually edited (in a different way than the way
the editor has).

Note that the report is very basic, with minimal ouput, manually
generating the HTML, like the rest of the XMLDB Editor actions do. We
are not using renderers neither templates here.

Also note that it includes a commented line of code that, once
uncommented, enables the report to, also, fix the wrong files. Useful
for developers.
2022-02-08 19:25:02 +01:00
..
actions MDL-73764 tool_xmldb: New report to show all xml files needing reconcile 2022-02-08 19:25:02 +01:00
amd MDL-62497 javascript: build AMD modules with new transpiler 2019-07-19 14:12:49 +08:00
classes MDL-63648 tool_xmldb: missing capability check 2018-10-19 11:36:40 +02:00
db MDL-63648 tool_xmldb: drag and drop sorting 2018-10-13 14:03:46 +02:00
lang/en MDL-73764 tool_xmldb: New report to show all xml files needing reconcile 2022-02-08 19:25:02 +01:00
tests/behat MDL-65251 tool_xmldb: Create behat tests for mandatory persistent fields 2019-04-04 11:29:18 +08:00
index.php MDL-29895 core: removed require_login() when not needed 2018-09-10 11:22:50 +02:00
README.txt
settings.php MDL-32003 fix xmldb editor code indentations, phpdocs and PHP4-isms 2012-06-17 22:56:29 +02:00
styles_boost.css MDL-63648 tool_xmldb: drag and drop sorting 2018-10-13 14:03:46 +02:00
styles_bootstrapbase.css MDL-46618 tool_xmldb: added styles_bootstrapbase.css 2014-11-20 10:40:32 +01:00
version.php MDL-71583 versions: Add all the missing full-stops to version/requires 2021-05-11 20:11:07 +02:00

XMLDB - Base classes and edition interface.

Complete Documentation:

  http://docs.moodle.org/en/XMLDB_Defining_one_XML_structure

Ciao, Eloy Lafuente (stronk7)

========== ========== ========== ========== ==========
========== ==========   HISTORY  ========== ==========
========== ========== ========== ========== ==========

2006-08-07 - Editor working on production

The editor has been used succesfully to build
a bunch of install.xml files and everything
seems to be working properly.

========== ========== ========== ========== ==========

2006-07-11 - PHP4 compatible release

Now everything seems to be working under PHP 4. What
a horrible OOP implementation!

Note that write permissions to */db dirs are required.

Now working in the 3 missing forms, to manually edit
fields, keys and indexes.

Ciao, Eloy Lafuente (stronk7)

========== ========== ========== ========== ==========

2006-07-11 - Important notes

I've just discovered this some seconds ago, in order
to test properly the XMLDB classes and editor:

1.- PHP 5 required for now. Will change this soon.
2.- Perms to "apache" user needed in */db
    dirs in order to allow the XMDBD interface
    to write files.

Ciao, Eloy Lafuente (stronk7)

========== ========== ========== ========== ==========

2006-07-11 - Initial commit

This directory contains the XMLDB classes to be used
under Moodle > 1.7 to store all the DB info in a
neutral form (classes dir). Also it contains one simple
interface to edit all those structures.

To install and test it, simply copy the whole xmldb directory
under your moodle/admin dir and point your browser (as admin)
to http://your.server/moodle/admin/xmldb

The edition interface isn't completed yet (it laks 3 more forms
to edit fields, keys and indexes) and there isn't any lang file
(although I hope everything is really clear).

The edition interface includes one reverse-engineering tool that
provides an easy way to retroffit and to generate any table from
MySQL to the new XMLDB format.

Once the XMLDB format was approved, we'll be able to build all the
"generators" needed in order to use it to create Moodle DB structures
for each RDBMS flavour.

Once the interface was finished (2-3 days from now) related documentation
will be sent to http://docs.moodle.org/en/XML_database_schema in order
to comment/modify/approve the final XML format.

All the code is, obviously GPL, with its copyrights and so on...

Ciao, Eloy Lafuente (stronk7) :-)