database_column_info Class Reference

Public Member Functions
	__construct ($data)
Data Fields
	$name
	$type
	$max_length
	$scale
	$enums
	$not_null
	$primary_key
	$auto_increment
	$binary
	$unsigned
	$has_default
	$default_value
	$unique
	$meta_type

---

Detailed Description

Detail database field information. Based on ADOFieldObject.

Definition at line 34 of file database_column_info.php.

---

Constructor & Destructor Documentation

__construct

(

$

data

)

Constructor

Parameters:

$data

mixed object or array with properties

Definition at line 134 of file database_column_info.php.

---

Field Documentation

$auto_increment

True if filed autoincrementing (usually 'id' only)

Definition at line 88 of file database_column_info.php.

$binary

True if binary

Definition at line 93 of file database_column_info.php.

$default_value

Default value if defined

Definition at line 109 of file database_column_info.php.

$enums

Enumerated field options, null if not enum type

For performance reasons this field is optional! You can use DDL sql_generator::getCheckConstraintsFromDB() if needed.

Definition at line 71 of file database_column_info.php.

$has_default

True if default value defined

Definition at line 104 of file database_column_info.php.

$max_length

Max length: character type - number of characters blob - number of bytes integer - number of digits float - digits left from floating point boolean - 1 enums - null

Definition at line 55 of file database_column_info.php.

$meta_type

Standardised one character column type, uppercase R - counter (integer primary key) I - integers N - numbers (floats) C - characters and strings X - texts B - binary blobs L - boolean (1 bit) T - timestamp - unsupported D - date - unsupported

Definition at line 128 of file database_column_info.php.

$name

Name of column - lowercase

Definition at line 38 of file database_column_info.php.

$not_null

True if not null, false otherwise

Definition at line 76 of file database_column_info.php.

$primary_key

True if column is primary key. (usually 'id').

Definition at line 82 of file database_column_info.php.

$scale

Scale float - decimal points other - null

Definition at line 62 of file database_column_info.php.

$type

Driver dependent native data type Not standardised - used to find meta_type

Definition at line 44 of file database_column_info.php.

$unique

True if field values unique, false if not

Definition at line 114 of file database_column_info.php.

$unsigned

True if integer unsigned, false if signed. Null for other types

Definition at line 99 of file database_column_info.php.

---

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

• C:/xampp/htdocs/moodle/lib/dml/database_column_info.php