Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Attributes | List of all members
XMLDBAction Class Reference

Main xmldb action clasee. More...

Inheritance diagram for XMLDBAction:
XMLDBCheckAction add_persistent_mandatory create_xml_file delete_field delete_index delete_key delete_table delete_xml_file edit_field edit_field_save edit_index edit_index_save edit_key edit_key_save edit_table edit_table_save edit_xml_file edit_xml_file_save generate_all_documentation generate_documentation get_db_directories load_xml_file load_xml_files main_view move_updown_field move_updown_index move_updown_key move_updown_table new_field new_index new_key new_table new_table_from_mysql revert_changes save_xml_file template unload_xml_file view_field_xml view_index_xml view_key_xml view_reserved_words view_structure_php view_structure_sql view_structure_xml view_table_php view_table_sql view_table_xml view_xml

Public Member Functions

 __construct ()
 Constructor.
 
 getDoesGenerate ()
 Returns the type of output of the file. More...
 
 getError ()
 getError method, returns the last error string. More...
 
 getOutput ()
 getOutput method, returns the output generated by the action. More...
 
 getPostAction ()
 getPostAction method, returns the action to launch after executing another one More...
 
 getTitle ()
 getTitle method returns the title of the action (that is part of the $str array attribute More...
 
 init ()
 Init method, every subclass will have its own, always calling the parent one. More...
 
 invoke ()
 main invoke method, it sets the postaction attribute if possible and checks sesskey_protected if needed More...
 
 launch ($action)
 launch method, used to easily call invoke methods between actions More...
 
 loadStrings ($strings)
 loadStrings method, loads the required strings specified in the array parameter More...
 
 upgrade_savepoint_php ($structure)
 This function will generate the PHP code needed to implement the upgrade_xxxx_savepoint() php calls in upgrade code generated from the editor. More...
 

Protected Attributes

bool $does_generate
 Type of value returned by the invoke method, ACTION_GENERATE_HTML have contents to show, set by each specialized invoke.
 
string $errormsg
 Last Error produced. More...
 
string $output
 Output of the action, set by each specialized invoke, get with getOutput.
 
string $postaction
 Action to execute at the end of the invoke script.
 
bool $sesskey_protected
 Actions must be protected by sesskey mechanism.
 
string $str
 Strings used by the action set by each specialized init, calling loadStrings.
 
string $title
 Title of the Action (class name, by default), set by parent init automatically.
 

Detailed Description

Main xmldb action clasee.

Main xmldb action class. It implements all the basic functionalities to be shared by each action.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ getDoesGenerate()

XMLDBAction::getDoesGenerate ( )

Returns the type of output of the file.

Return values
bool

◆ getError()

XMLDBAction::getError ( )

getError method, returns the last error string.

Used if the invoke() methods returns false

Return values
string

◆ getOutput()

XMLDBAction::getOutput ( )

getOutput method, returns the output generated by the action.

Used after execution of the invoke() methods if they return true

Return values
string

◆ getPostAction()

XMLDBAction::getPostAction ( )

getPostAction method, returns the action to launch after executing another one

Return values
string

◆ getTitle()

XMLDBAction::getTitle ( )

getTitle method returns the title of the action (that is part of the $str array attribute

Return values
string

Reimplemented in add_persistent_mandatory.

◆ init()

XMLDBAction::init ( )

◆ invoke()

XMLDBAction::invoke ( )

◆ launch()

XMLDBAction::launch (   $action)

launch method, used to easily call invoke methods between actions

Parameters
string$action
Return values
mixed

◆ loadStrings()

XMLDBAction::loadStrings (   $strings)

loadStrings method, loads the required strings specified in the array parameter

Parameters
string[]$strings

◆ upgrade_savepoint_php()

XMLDBAction::upgrade_savepoint_php (   $structure)

This function will generate the PHP code needed to implement the upgrade_xxxx_savepoint() php calls in upgrade code generated from the editor.

It's used by the view_structure_php and view_table_php actions

Parameters
xmldb_structurestructure object containing all the info
Return values
stringPHP code to be used to mark a reached savepoint

Member Data Documentation

◆ $errormsg

string XMLDBAction::$errormsg
protected

Last Error produced.

Check when any invoke returns false, get with getError


The documentation for this class was generated from the following file: