Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_xmldb

Namespaces

namespace  tool_xmldb\privacy
  
 

Classes

class  add_persistent_mandatory
 Add the mandatory fields for persistent to the table. More...
 
class  check_bigints
 reporting about the ones not physically implemented as BIGINTs and providing one SQL script to fix all them. More...
 
class  check_defaults
 This class will check all the default values existing in the DB match those specified in the xml specs and providing one SQL script to fix all them. More...
 
class  check_foreign_keys
 This class will look for data in the database that violates the foreign key definitions found in the XMLDB definitions. More...
 
class  check_indexes
 This class will compare all the indexes found in the XMLDB definitions with the physical DB implementation, reporting about all the missing indexes to be created to be 100% ok. More...
 
class  check_oracle_semantics
 This class will check all the varchar2() columns in the Moodle installed DB, looking for incorrect (INT) length semanticas providing one SQL script to fix all them by changing to cross-db (CHAR) length semantics. More...
 
class  create_xml_file
 
class  delete_field
 This class will delete completely one field. More...
 
class  delete_index
 This class will delete completely one index. More...
 
class  delete_key
 This class will delete completely one key. More...
 
class  delete_table
 This class will delete completely one table. More...
 
class  delete_xml_file
 This class will delete completely one XML file. More...
 
class  edit_field
 This class will provide the interface for all the edit field actions. More...
 
class  edit_field_save
 This class verifies all the data introduced when editing a field for correctness, performing changes / displaying errors depending of the results. More...
 
class  edit_index
 This class will provide the interface for all the edit index actions. More...
 
class  edit_index_save
 This class verifies all the data introduced when editing an index for correctness, performing changes / displaying errors depending of the results. More...
 
class  edit_key
 This class will provide the interface for all the edit key actions. More...
 
class  edit_key_save
 This class verifies all the data introduced when editing a key for correctness, performing changes / displaying errors depending of the results. More...
 
class  edit_table
 This class provides the interface for all the edit table actions. More...
 
class  edit_table_save
 This class will save changes in table name and/or comments. More...
 
class  edit_xml_file
 This class will edit one loaded XML file. More...
 
class  edit_xml_file_save
 This class will save the changes performed to the comment of one file. More...
 
class  generate_all_documentation
 This class will produce the documentation for all the XMLDB files in the server, via XSL, performing the output in HTML format. More...
 
class  generate_documentation
 This class will produce XSL documentation for the loaded XML file. More...
 
class  get_db_directories
 This class will will check all the db directories existing under the current Moodle installation, sending them to the SESSION->dbdirs array. More...
 
class  load_xml_file
 This class will load one XML file to memory if necessary. More...
 
class  load_xml_files
 This class will load every XML file to memory if necessary. More...
 
class  main_view
 This class will show all the actions available under the XMLDB editor interface. More...
 
class  move_updown_field
 This class will will move one field up/down. More...
 
class  move_updown_index
 This class will will move one index up/down. More...
 
class  move_updown_key
 This class will will move one key up/down. More...
 
class  move_updown_table
 This class will will move table up/down. More...
 
class  new_field
 This class will create a new default field to be edited. More...
 
class  new_index
 This class will create a new default index to be edited. More...
 
class  new_key
 This class will create a new default key to be edited. More...
 
class  new_table
 This class will create a new default table to be edited. More...
 
class  new_table_from_mysql
 This class will ask and retrofit all the information from one mysql table present in the Moodle DB to one xmldb_table structure. More...
 
class  reconcile_files
 
class  revert_changes
 This class will revert changes (delete the editeddb) More...
 
class  save_xml_file
 This class will save one edited xml file. More...
 
class  template
 
class  tool_xmldb\privacy\provider
 Privacy Subsystem for tool_xmldb implementing null_provider. More...
 
class  tool_xmldb_external
 
class  unload_xml_file
 This class will unload one loaded file completely. More...
 
class  view_field_xml
 This class will display the XML for one field being edited. More...
 
class  view_index_xml
 This class will display the XML for one index being edited. More...
 
class  view_key_xml
 This class will display the XML for one key being edited. More...
 
class  view_reserved_words
 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. More...
 
class  view_structure_php
 This class will show the PHP needed (upgrade block) to perform the desired DDL action with the specified table. More...
 
class  view_structure_sql
 This class will show the SQL generated for the selected RDBMS for the entire XMLDB file. More...
 
class  view_structure_xml
 This class will display the XML for one structure. More...
 
class  view_table_php
 This class will show the PHP needed (upgrade block) to perform the desired DDL action with the specified field/key/index. More...
 
class  view_table_sql
 This class will show the SQL generated for the selected RDBMS for one table. More...
 
class  view_table_xml
 This class will display the XML for one table being edited. More...
 
class  view_xml
 This class will display one XML file. More...
 
class  XMLDBAction
 Main xmldb action clasee. More...
 
class  XMLDBCheckAction
 This is a base class for the various actions that interate over all the tables and check some aspect of their definition. More...
 

Variables

 $functions
 
 $plugin = 2023041800
 
$plugin component = 'tool_xmldb'
 
$plugin version = 2023042400
 

Detailed Description

Variable Documentation

◆ $functions

$functions
Initial value:
= [
'tool_xmldb_invoke_move_action' => [
'classname' => tool_xmldb_external::class,
'methodname' => 'invoke_move_action',
'description' => 'moves element up/down',
'type' => 'write',
'ajax' => true,
]
]