Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
database_column_info Class Reference

Detailed database field information. More...

Public Member Functions

 __construct ($data)
 Constructor.
 
 __get ($variablename)
 Magic get function.
 
 __isset ($variablename)
 Magic isset function.
 
 __set ($name, $value)
 Magic set function.
 

Protected Attributes

array $data
 The internal storage of column data.
 

Detailed Description

Detailed database field information.

It is based on the adodb library's ADOFieldObject object. 'column' does mean 'the field' here.

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

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

Standardised one character column type, uppercased and enumerated as follows: 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

Constructor & Destructor Documentation

◆ __construct()

database_column_info::__construct ( $data)

Constructor.

Parameters
mixed$dataobject or array with properties

Member Function Documentation

◆ __get()

database_column_info::__get ( $variablename)

Magic get function.

Parameters
string$variablenamevariable name to return the value of.
Return values
mixedThe variable contents.
Exceptions
coding_exceptionYou cannot request a variable that is not allowed.

◆ __isset()

database_column_info::__isset ( $variablename)

Magic isset function.

Parameters
string$variablenameThe name of the property to test if isset().
Return values
boolWhether the value is set or not.

◆ __set()

database_column_info::__set ( $name,
$value )

Magic set function.

This is a read only object and you aren't allowed to write to any variables.

Parameters
string$nameignored.
mixed$valueignored.
Exceptions
coding_exceptionYou are not allowed to set data on database_column_info

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