Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/admin/tool/xmldb/actions/view_structure_php/ -> view_structure_php.class.php (source)

[Source view]

(no description)

Copyright: 2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 314 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

view_structure_php:: (5 methods):
  init()
  invoke()
  create_table_php()
  drop_table_php()
  rename_table_php()


Class: view_structure_php  - X-Ref

This class will show the PHP needed (upgrade block) to perform
the desired DDL action with the specified table

init()   X-Ref
Init method, every subclass will have its own


invoke()   X-Ref
Invoke method, every class will have its own
returns true/false on completion, setting both
errormsg and output as necessary


create_table_php($structure, $table)   X-Ref
This function will generate all the PHP code needed to
create one table using XMLDB objects and functions

param: xmldb_structure structure object containing all the info
param: string table table code to be created
return: string PHP code to be used to create the table

drop_table_php($structure, $table)   X-Ref
This function will generate all the PHP code needed to
drop one table using XMLDB objects and functions

param: xmldb_structure structure object containing all the info
param: string table table code to be dropped
return: string PHP code to be used to drop the table

rename_table_php($structure, $table)   X-Ref
This function will generate all the PHP code needed to
rename one table using XMLDB objects and functions

param: xmldb_structure structure object containing all the info
param: string table table code to be renamed
return: string PHP code to be used to rename the table