Docs For Class MDB2_Driver_Datatype

Class: MDB2_Driver_Datatype_Common

MDB2_Driver_Datatype_Common::__construct(): Constructor
MDB2_Driver_Datatype_Common::MDB2_Driver_Datatype_Common()
MDB2_Driver_Datatype_Common::compareDefinition(): Obtain an array of changes that may need to applied
MDB2_Driver_Datatype_Common::convertResult(): convert a value to a RDBMS indepdenant MDB2 type
MDB2_Driver_Datatype_Common::convertResultRow(): convert a result row
MDB2_Driver_Datatype_Common::createLOB(): Create a handler object of a specified class with functions to retrieve data from a large object data stream.
MDB2_Driver_Datatype_Common::destroyLOB(): Free any resources allocated during the lifetime of the large object handler object.
MDB2_Driver_Datatype_Common::endOfLOB(): Determine whether it was reached the end of the large object and therefore there is no more data to be read for the its input stream.
MDB2_Driver_Datatype_Common::freeBLOBValue(): free a binary large object
MDB2_Driver_Datatype_Common::freeCLOBValue(): free a character large object
MDB2_Driver_Datatype_Common::getDeclaration(): Obtain DBMS specific SQL code portion needed to declare of the given type
MDB2_Driver_Datatype_Common::implodeArray(): apply a type to all values of an array and return as a comma seperated string useful for generating IN statements
MDB2_Driver_Datatype_Common::quote(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::readLOB(): Read data from large object input stream.
MDB2_Driver_Datatype_Common::setLOBFile(): retrieve LOB from the database
MDB2_Driver_Datatype_Common::setResultTypes(): Define the list of types to be associated with the columns of a given result set.
MDB2_Driver_Datatype_Common::_baseConvertResult(): general type conversion method
MDB2_Driver_Datatype_Common::_compareBLOBDefinition(): Obtain an array of changes that may need to applied to an BLOB field
MDB2_Driver_Datatype_Common::_compareBooleanDefinition(): Obtain an array of changes that may need to applied to an boolean field
MDB2_Driver_Datatype_Common::_compareCLOBDefinition(): Obtain an array of changes that may need to applied to an CLOB field
MDB2_Driver_Datatype_Common::_compareDateDefinition(): Obtain an array of changes that may need to applied to an date field
MDB2_Driver_Datatype_Common::_compareDecimalDefinition(): Obtain an array of changes that may need to applied to an decimal field
MDB2_Driver_Datatype_Common::_compareFloatDefinition(): Obtain an array of changes that may need to applied to an float field
MDB2_Driver_Datatype_Common::_compareIntegerDefinition(): Obtain an array of changes that may need to applied to an integer field
MDB2_Driver_Datatype_Common::_compareTextDefinition(): Obtain an array of changes that may need to applied to an text field
MDB2_Driver_Datatype_Common::_compareTimeDefinition(): Obtain an array of changes that may need to applied to an time field
MDB2_Driver_Datatype_Common::_compareTimestampDefinition(): Obtain an array of changes that may need to applied to an timestamp field
MDB2_Driver_Datatype_Common::_destroyResultLOB(): Free any resources allocated during the lifetime of the large object handler object.
MDB2_Driver_Datatype_Common::_endOfResultLOB(): Determine whether it was reached the end of the large object and therefore there is no more data to be read for the its input stream.
MDB2_Driver_Datatype_Common::_getBLOBDeclaration(): Obtain DBMS specific SQL code portion needed to declare an binary large object type field to be used in statements like CREATE TABLE.
MDB2_Driver_Datatype_Common::_getBooleanDeclaration(): Obtain DBMS specific SQL code portion needed to declare a boolean type field to be used in statements like CREATE TABLE.
MDB2_Driver_Datatype_Common::_getCLOBDeclaration(): Obtain DBMS specific SQL code portion needed to declare an character large object type field to be used in statements like CREATE TABLE.
MDB2_Driver_Datatype_Common::_getDateDeclaration(): Obtain DBMS specific SQL code portion needed to declare a date type field to be used in statements like CREATE TABLE.
MDB2_Driver_Datatype_Common::_getDecimalDeclaration(): Obtain DBMS specific SQL code portion needed to declare a decimal type field to be used in statements like CREATE TABLE.
MDB2_Driver_Datatype_Common::_getFloatDeclaration(): Obtain DBMS specific SQL code portion needed to declare a float type field to be used in statements like CREATE TABLE.
MDB2_Driver_Datatype_Common::_getIntegerDeclaration(): Obtain DBMS specific SQL code portion needed to declare an integer type field to be used in statements like CREATE TABLE.
MDB2_Driver_Datatype_Common::_getTextDeclaration(): Obtain DBMS specific SQL code portion needed to declare an text type field to be used in statements like CREATE TABLE.
MDB2_Driver_Datatype_Common::_getTimeDeclaration(): Obtain DBMS specific SQL code portion needed to declare a time field to be used in statements like CREATE TABLE.
MDB2_Driver_Datatype_Common::_getTimestampDeclaration(): Obtain DBMS specific SQL code portion needed to declare a timestamp field to be used in statements like CREATE TABLE.
MDB2_Driver_Datatype_Common::_quoteBLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_quoteBoolean(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_quoteCLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_quoteDate(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_quoteDecimal(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_quoteFloat(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_quoteInteger(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_quoteLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_quoteText(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_quoteTime(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_quoteTimestamp(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_readFile(): Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::_readResultLOB(): Read data from large object input stream.
MDB2_Driver_Datatype_Common::_retrieveLOB(): retrieve LOB from the database

convertResult [line 68]

mixed convertResult(
mixed
$value, int
$type)

convert a value to a RDBMS independent MDB2 type

Return: converted value or a MDB2 error on failure
Access: public

Overrides MDB2_Driver_Datatype_Common::convertResult() (convert a value to a RDBMS indepdenant MDB2 type)

Parameters:

mixed	`$value`	—	value to be converted
int	`$type`	—	constant that specifies which type to convert to

[ Top ]

mapNativeDatatype [line 666]

array mapNativeDatatype(
array
$field)

Maps a native array description of a field to a MDB2 datatype and length

Return: containing the various possible types and the length
Access: public

Parameters:

array $field — native field description

[ Top ]

_destroyResultLOB [line 642]

void _destroyResultLOB(
int
$lob)

Free any resources allocated during the lifetime of the large object handler object.

Access: protected

Overrides MDB2_Driver_Datatype_Common::_destroyResultLOB() (Free any resources allocated during the lifetime of the large object handler object.)

Parameters:

int $lob — handle to a lob created by the createLOB() function

[ Top ]

_endOfResultLOB [line 591]

mixed _endOfResultLOB(
int
$lob)

Determine whether it was reached the end of the large object and therefore there is no more data to be read for the its input stream.

Return: true or false on success, a MDB2 error on failure
Access: protected

Overrides MDB2_Driver_Datatype_Common::_endOfResultLOB() (Determine whether it was reached the end of the large object and therefore there is no more data to be read for the its input stream.)

Parameters:

int $lob — handle to a lob created by the createLOB() function

[ Top ]

_getBLOBDeclaration [line 182]

string _getBLOBDeclaration(
string
$name, array
$field)

Obtain DBMS specific SQL code portion needed to declare a binary large object type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_getBLOBDeclaration() (Obtain DBMS specific SQL code portion needed to declare an binary large object type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

array

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

length Integer value that determines the maximum length of the large object field. If this argument is missing the field should be declared to have the longest length allowed by the DBMS.

notnull Boolean flag that indicates whether this field is constrained to not be set to null.

[ Top ]

_getBooleanDeclaration [line 211]

string _getBooleanDeclaration(
string
$name, array
$field)

Obtain DBMS specific SQL code portion needed to declare a boolean type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_getBooleanDeclaration() (Obtain DBMS specific SQL code portion needed to declare a boolean type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

array

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Boolean value to be used as default for this field.

notnullL Boolean flag that indicates whether this field is constrained to not be set to null.

[ Top ]

_getCLOBDeclaration [line 151]

string _getCLOBDeclaration(
string
$name, array
$field)

Obtain DBMS specific SQL code portion needed to declare a character large object type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_getCLOBDeclaration() (Obtain DBMS specific SQL code portion needed to declare an character large object type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

array

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

length Integer value that determines the maximum length of the large object field. If this argument is missing the field should be declared to have the longest length allowed by the DBMS.

notnull Boolean flag that indicates whether this field is constrained to not be set to null.

[ Top ]

_getDateDeclaration [line 242]

string _getDateDeclaration(
string
$name, array
$field)

Obtain DBMS specific SQL code portion needed to declare a date type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_getDateDeclaration() (Obtain DBMS specific SQL code portion needed to declare a date type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

array

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Date value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to null.

[ Top ]

_getDecimalDeclaration [line 366]

string _getDecimalDeclaration(
string
$name, array
$field)

Obtain DBMS specific SQL code portion needed to declare a decimal type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_getDecimalDeclaration() (Obtain DBMS specific SQL code portion needed to declare a decimal type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

array

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Decimal value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to null.

[ Top ]

_getFloatDeclaration [line 335]

string _getFloatDeclaration(
string
$name, array
$field)

Obtain DBMS specific SQL code portion needed to declare a float type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_getFloatDeclaration() (Obtain DBMS specific SQL code portion needed to declare a float type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

array

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Float value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to null.

[ Top ]

_getTextDeclaration [line 117]

string _getTextDeclaration(
string
$name, array
$field)

Obtain DBMS specific SQL code portion needed to declare a text type field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_getTextDeclaration() (Obtain DBMS specific SQL code portion needed to declare an text type field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

array

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

length Integer value that determines the maximum length of the text field. If this argument is missing the field should be declared to have the longest length allowed by the DBMS.

default Text value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to null.

[ Top ]

_getTimeDeclaration [line 273]

string _getTimeDeclaration(
string
$name, array
$field)

Obtain DBMS specific SQL code portion needed to declare a time field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_getTimeDeclaration() (Obtain DBMS specific SQL code portion needed to declare a time field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

array

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Time value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to null.

[ Top ]

_getTimestampDeclaration [line 304]

string _getTimestampDeclaration(
string
$name, array
$field)

Obtain DBMS specific SQL code portion needed to declare a timestamp field to be used in statements like CREATE TABLE.

Return: DBMS specific SQL code portion that should be used to declare the specified field.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_getTimestampDeclaration() (Obtain DBMS specific SQL code portion needed to declare a timestamp field to be used in statements like CREATE TABLE.)

Parameters:

string $name — name the field to be declared.

array

$field

—

associative array with the name of the properties of the field being declared as array indexes. Currently, the types of supported field properties are as follows:

default Timestamp value to be used as default for this field.

notnull Boolean flag that indicates whether this field is constrained to not be set to null.

[ Top ]

_quoteBLOB [line 484]

string _quoteBLOB(
$value
$value)

Convert a text value into a DBMS specific format that is suitable to compose query statements.

Return: text string that represents the given argument value in a DBMS specific format.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_quoteBLOB() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

$value $value —

[ Top ]

_quoteBoolean [line 501]

string _quoteBoolean(
string
$value)

Convert a text value into a DBMS specific format that is suitable to compose query statements.

Return: text string that represents the given argument value in a DBMS specific format.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_quoteBoolean() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

string $value — text string value that is intended to be converted.

[ Top ]

_quoteCLOB [line 467]

string _quoteCLOB(
$value
$value)

Convert a text value into a DBMS specific format that is suitable to compose query statements.

Return: text string that represents the given argument value in a DBMS specific format.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_quoteCLOB() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

$value $value —

[ Top ]

_quoteDecimal [line 536]

string _quoteDecimal(
string
$value)

Convert a text value into a DBMS specific format that is suitable to compose query statements.

Return: text string that represents the given argument value in a DBMS specific format.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_quoteDecimal() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

string $value — text string value that is intended to be converted.

[ Top ]

_quoteFloat [line 518]

string _quoteFloat(
string
$value)

Convert a text value into a DBMS specific format that is suitable to compose query statements.

Return: text string that represents the given argument value in a DBMS specific format.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_quoteFloat() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

string $value — text string value that is intended to be converted.

[ Top ]

_quoteLOB [line 387]

string _quoteLOB(
$value
$value)

Convert a text value into a DBMS specific format that is suitable to compose query statements.

Return: text string that represents the given argument value in a DBMS specific format.
Access: protected

Overrides MDB2_Driver_Datatype_Common::_quoteLOB() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

$value $value —

[ Top ]

_readResultLOB [line 615]

mixed _readResultLOB(
int
$lob, 
&$data, int
$length, blob
$data)

Read data from large object input stream.

Return: length on success, a MDB2 error on failure
Access: protected

Overrides MDB2_Driver_Datatype_Common::_readResultLOB() (Read data from large object input stream.)

Parameters:

int	`$lob`	—	handle to a lob created by the createLOB() function
blob	`$data`	—	reference to a variable that will hold data to be read from the large object input stream
int	`$length`	—	integer value that indicates the largest ammount of data to be read from the large object input stream.
	`&$data`	—

[ Top ]

_retrieveLOB [line 552]

mixed _retrieveLOB(
int
$lob)

retrieve LOB from the database

Return: MDB2_OK on success, a MDB2 error on failure
Access: protected

Overrides MDB2_Driver_Datatype_Common::_retrieveLOB() (retrieve LOB from the database)

Parameters:

int $lob — handle to a lob created by the createLOB() function

[ Top ]

Class: MDB2_Driver_Datatype_pgsql

Class Overview

Author(s):

Methods

Inherited Variables

Class: MDB2_Driver_Datatype_Common

Inherited Methods

Class: MDB2_Driver_Datatype_Common

Class Details

Method Detail

convertResult [line 68]

Parameters:

mapNativeDatatype [line 666]

Parameters:

_destroyResultLOB [line 642]

Parameters:

_endOfResultLOB [line 591]

Parameters:

_getBLOBDeclaration [line 182]

Parameters:

_getBooleanDeclaration [line 211]

Parameters:

_getCLOBDeclaration [line 151]

Parameters:

_getDateDeclaration [line 242]

Parameters:

_getDecimalDeclaration [line 366]

Parameters:

_getFloatDeclaration [line 335]

Parameters:

_getTextDeclaration [line 117]

Parameters:

_getTimeDeclaration [line 273]

Parameters:

_getTimestampDeclaration [line 304]

Parameters:

_quoteBLOB [line 484]

Parameters:

_quoteBoolean [line 501]

Parameters:

_quoteCLOB [line 467]

Parameters:

_quoteDecimal [line 536]

Parameters:

_quoteFloat [line 518]

Parameters:

_quoteLOB [line 387]

Parameters:

_readResultLOB [line 615]

Parameters:

_retrieveLOB [line 552]

Parameters: