.
/**
* @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
*/
/**
* This class will show all the reserved words in a format suitable to
* be pasted to: http://docs.moodle.org/en/XMLDB_reserved_words and
* http://docs.moodle.org/en/Database_reserved_words
* Also, it introspects te DB looking for such words and informing about
*
* @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
*/
class view_reserved_words extends XMLDBAction {
/**
* Init method, every subclass will have its own
*/
function init() {
parent::init();
// Set own custom attributes
$this->sesskey_protected = false; // This action doesn't need sesskey protection
// Get needed strings
$this->loadStrings(array(
'listreservedwords' => 'tool_xmldb',
'wrongreservedwords' => 'tool_xmldb',
'table' => 'tool_xmldb',
'field' => 'tool_xmldb',
'back' => 'tool_xmldb'
));
}
/**
* Invoke method, every class will have its own
* returns true/false on completion, setting both
* errormsg and output as necessary
*/
function invoke() {
parent::invoke();
$result = true;
// Set own core attributes
$this->does_generate = ACTION_GENERATE_HTML;
// These are always here
global $CFG, $XMLDB, $DB;
// Calculate list of available SQL generators
require_once("$CFG->libdir/ddl/sql_generator.php");
$reserved_words = sql_generator::getAllReservedWords();
// Now, calculate, looking into current DB (with AdoDB Metadata), which fields are
// in the list of reserved words
$wronguses = array();
$dbtables = $DB->get_tables();
if ($dbtables) {
foreach ($dbtables as $table) {
if (array_key_exists($table, $reserved_words)) {
$wronguses[] = $this->str['table'] . ' - ' . $table . ' (' . implode(', ',$reserved_words[$table]) . ')';
}
$dbfields = $DB->get_columns($table);
if ($dbfields) {
foreach ($dbfields as $dbfield) {
if (array_key_exists($dbfield->name, $reserved_words)) {
$wronguses[] = $this->str['field'] . ' - ' . $table . '->' . $dbfield->name . ' (' . implode(', ',$reserved_words[$dbfield->name]) . ')';
}
}
}
}
}
// Sort the wrong uses
sort($wronguses);
// The back to edit table button
$b = ' ';
$b .= '[' . $this->str['back'] . ']';
$b .= '
';
$o = $b;
// The list of currently wrong field names
if ($wronguses) {
$o.= ' ';
}
// The textarea showing all the reserved words
$o.= ' ';
$this->output = $o;
// Launch postaction if exists (leave this here!)
if ($this->getPostAction() && $result) {
return $this->launch($this->getPostAction());
}
// Return ok if arrived here
return $result;
}
}