check_indexes Class Reference

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...

Inheritance diagram for check_indexes:

Public Member Functions
	getDoesGenerate ()
	Returns the type of output of the file.
	getError ()
	getError method, returns the last error string.
	getOutput ()
	getOutput method, returns the output generated by the action.
	getPostAction ()
	getPostAction method, returns the action to launch after executing another one
	getTitle ()
	getTitle method returns the title of the action (that is part of the $str array attribute
	init ()
	Init method, every subclass will have its own.
	invoke ()
	Invoke method, every class will have its own returns true/false on completion, setting both errormsg and output as necessary.
	launch ($action)
	launch method, used to easily call invoke methods between actions
	loadStrings ($strings)
	loadStrings method, loads the required strings specified in the array parameter
	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.

Protected Member Functions
	check_table (xmldb_table $xmldb_table, array $metacolumns)
	Do the checks necessary on one particular table.
	display_results (array $missing_indexes)
	Display a list of the problems found.

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.
string	$introstr = ''
	This string is displayed with a yes/no choice before the report is run.
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

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.

Copyright

2003 onwards Eloy Lafuente (stronk7)

License

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

Member Function Documentation

check_table()

check_indexes::check_table ( xmldb_table  $xmldb_table, array  $metacolumns  )

protected

Do the checks necessary on one particular table.

Parameters

xmldb_table	$xmldb_table	the table definition from the install.xml file.
array	$metacolumns	the column information read from the database.

Return values

array

an array with two elements: First, some additional progress output, for example a list ( of the things check each with an one work ok/not ok summary. Second, an array giving the details of any problems found. These arrays for all tables will be aggregated, and then passed to

Reimplemented from XMLDBCheckAction.

display_results()

check_indexes::display_results ( array  $problems_found )

protected

Display a list of the problems found.

Parameters

array

$problems_found

an aggregation of all the problems found by all the check_table calls.

Return values

string

a display of all the problems found as HTML.

Reimplemented from XMLDBCheckAction.

getDoesGenerate()

XMLDBAction::getDoesGenerate ( )

inherited

Returns the type of output of the file.

Return values

bool

getError()

XMLDBAction::getError ( )

inherited

getError method, returns the last error string.

Used if the invoke() methods returns false

Return values

string

getOutput()

XMLDBAction::getOutput ( )

inherited

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 ( )

inherited

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

Return values

string

getTitle()

XMLDBAction::getTitle ( )

inherited

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()

check_indexes::init

(

)

Init method, every subclass will have its own.

Reimplemented from XMLDBCheckAction.

invoke()

XMLDBCheckAction::invoke ( )

inherited

Invoke method, every class will have its own returns true/false on completion, setting both errormsg and output as necessary.

Reimplemented from XMLDBAction.

launch()

XMLDBAction::launch (   $action )

inherited

launch method, used to easily call invoke methods between actions

Parameters

string

$action

Return values

mixed

loadStrings()

XMLDBAction::loadStrings (   $strings )

inherited

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

Parameters

string[]

$strings

upgrade_savepoint_php()

XMLDBAction::upgrade_savepoint_php (   $structure )

inherited

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_structure

structure object containing all the info

Return values

string

PHP code to be used to mark a reached savepoint

Member Data Documentation

$errormsg

string XMLDBAction::$errormsg

protectedinherited

Last Error produced.

Check when any invoke returns false, get with getError

$introstr

string XMLDBCheckAction::$introstr = ''

protectedinherited

This string is displayed with a yes/no choice before the report is run.

You must set this to the name of a lang string in xmldb.php before calling init.

---

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

• admin/tool/xmldb/actions/check_indexes/check_indexes.class.php