view_table_php Class Reference

Inheritance diagram for view_table_php:

Collaboration diagram for view_table_php:

Public Member Functions
	init ()
	invoke ()
	add_field_php ($structure, $table, $field)
	drop_field_php ($structure, $table, $field)
	rename_field_php ($structure, $table, $field)
	change_field_type_php ($structure, $table, $field)
	change_field_precision_php ($structure, $table, $field)
	change_field_unsigned_php ($structure, $table, $field)
	change_field_notnull_php ($structure, $table, $field)
	drop_enum_from_field_php ($structure, $table, $field)
	change_field_default_php ($structure, $table, $field)
	add_key_php ($structure, $table, $key)
	drop_key_php ($structure, $table, $key)
	rename_key_php ($structure, $table, $key)
	add_index_php ($structure, $table, $index)
	drop_index_php ($structure, $table, $index)
	rename_index_php ($structure, $table, $index)

---

Detailed Description

Definition at line 33 of file view_table_php.class.php.

---

Member Function Documentation

add_field_php	(	$	structure,
		$	table,
		$	field
	)

This function will generate all the PHP code needed to create one field using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	field field name to be created

Returns:

string PHP code to be used to create the field

Definition at line 316 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

add_index_php	(	$	structure,
		$	table,
		$	index
	)

This function will generate all the PHP code needed to create one index using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	index index name to be created

Returns:

string PHP code to be used to create the index

Definition at line 901 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

add_key_php	(	$	structure,
		$	table,
		$	key
	)

This function will generate all the PHP code needed to create one key using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	key key name to be created

Returns:

string PHP code to be used to create the key

Definition at line 760 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

change_field_default_php	(	$	structure,
		$	table,
		$	field
	)

This function will generate all the PHP code needed to change the default of one field using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	field field name to change null/not null

Definition at line 711 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

change_field_notnull_php	(	$	structure,
		$	table,
		$	field
	)

This function will generate all the PHP code needed to change the nullability of one field using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	field field name to change null/not null

Definition at line 612 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

change_field_precision_php	(	$	structure,
		$	table,
		$	field
	)

This function will generate all the PHP code needed to change the precision of one field using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	field field name to change precision

Definition at line 512 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

change_field_type_php	(	$	structure,
		$	table,
		$	field
	)

This function will generate all the PHP code needed to change the type of one field using XMLDB objects and functions. Currently these conversions are supported: integer to char char to integer number to char char to number float to char char to float

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	field field name to change precision

Definition at line 464 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

change_field_unsigned_php	(	$	structure,
		$	table,
		$	field
	)

This function will generate all the PHP code needed to change the unsigned/signed of one field using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	field field name to change unsigned/signed

Definition at line 564 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

drop_enum_from_field_php	(	$	structure,
		$	table,
		$	field
	)

This function will generate all the PHP code needed to drop the enum values (check constraint) of one field using XMLDB objects and functions

Note this function is here as part of the process of dropping enums completely from Moodle 2.0: MDL-18577 and will be out in Moodle 2.1 TODO: Moodle 2.1 - Drop drop_enum_from_field_php

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	field field name to change its enum

Definition at line 666 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

drop_field_php	(	$	structure,
		$	table,
		$	field
	)

This function will generate all the PHP code needed to drop one field using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	field field name to be dropped

Returns:

string PHP code to be used to drop the field

Definition at line 364 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

drop_index_php	(	$	structure,
		$	table,
		$	index
	)

This function will generate all the PHP code needed to drop one index using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	index index name to be dropped

Returns:

string PHP code to be used to drop the index

Definition at line 949 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

drop_key_php	(	$	structure,
		$	table,
		$	key
	)

This function will generate all the PHP code needed to drop one key using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	key key name to be dropped

Returns:

string PHP code to be used to drop the key

Definition at line 806 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

init

(

)

Init method, every subclass will have its own

Reimplemented from XMLDBAction.

Definition at line 38 of file view_table_php.class.php.

Here is the call graph for this function:

invoke

(

)

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

Reimplemented from XMLDBAction.

Definition at line 64 of file view_table_php.class.php.

Here is the call graph for this function:

rename_field_php	(	$	structure,
		$	table,
		$	field
	)

This function will generate all the PHP code needed to rename one field using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	field field name to be renamed

Returns:

string PHP code to be used to rename the field

Definition at line 412 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

rename_index_php	(	$	structure,
		$	table,
		$	index
	)

This function will generate all the PHP code needed to rename one index using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	index index name to be renamed

Returns:

string PHP code to be used to rename the index

Definition at line 997 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

rename_key_php	(	$	structure,
		$	table,
		$	key
	)

This function will generate all the PHP code needed to rename one key using XMLDB objects and functions

Parameters:

xmldb_structure	structure object containing all the info
string	table table name
string	key key name to be renamed

Returns:

string PHP code to be used to rename the key

Definition at line 852 of file view_table_php.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• C:/xampp/htdocs/moodle/admin/tool/xmldb/actions/view_table_php/view_table_php.class.php