Docs For Class MDB2_Driver_Datatype

MDB2_Driver_Datatype_Common MDB2_Driver_Datatype_Common(

$db_index)

Constructor

Parameters:

$db_index —

[ Top ]

mixed convertResult(
mixed
$value, int
$type)

convert a value to a RDBMS indepdenant MDB2 type

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

Overridden in child classes as:

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

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

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

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

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

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

MDB2_Driver_Datatype_mssql::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 ]

mixed convertResultRow(

$types, array
$row, resource
$result)

convert a result row

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

Parameters:

resource	`$result`	—	result identifier
array	`$row`	—	array with data
	`$types`	—

[ Top ]

integer createLOB(
array
$arguments)

Create a handler object of a specified class with functions to retrieve data from a large object data stream.

Return: handle value that should be passed as argument insubsequent calls to functions that retrieve data from the large object input stream.
Access: public

Parameters:

array

$arguments

—

An associative array with parameters to create the handler object. The array indexes are the names of the parameters and the array values are the respective parameter values.

Some parameters are specific of the class of each type of handler object that is created. The following parameters are common to all handler object classes:

type

Name of the type of the built-in supported class that will be used to create the handler object. There are currently four built-in types of handler object classes: data, resultlob, inputfile and outputfile.

The data handler class is the default class. It simply reads data from a given data string.

The resultlob handler class is meant to read data from a large object retrieved from a query result. This class is not used directly by applications.

The inputfile handler class is meant to read data from a file to use in prepared queries with large object field parameters.

The outputfile handler class is meant to write to a file data from result columns with large object fields. The functions to read from this type of large object do not return any data. Instead, the data is just written to the output file with the data retrieved from a specified large object handle.

class

Name of the class of the handler object that will be created if the Type argument is not specified. This argument should be used when you need to specify a custom handler class.

database

Database object as returned by MDB2::connect. This is an option argument needed by some handler classes like resultlob.

The following arguments are specific of the inputfile handler class:

file

Integer handle value of a file already opened for writing.

file_name

Name of a file to be opened for writing if the File argument is not specified.

The following arguments are specific of the outputfile handler class:

file

Integer handle value of a file already opened for writing.

file_name

Name of a file to be opened for writing if the File argument is not specified.

buffer_length

Integer value that specifies the length of a buffer that will be used to read from the specified large object.

LOB

Integer handle value that specifies a large object from which the data to be stored in the output file will be written.

result

Integer handle value as returned by the function MDB2::query() or MDB2::execute() that specifies the result set that contains the large object value to be retrieved. If the LOB argument is specified, this argument is ignored.

row

Integer value that specifies the number of the row of the result set that contains the large object value to be retrieved. If the LOB argument is specified, this argument is ignored.

field

Integer or string value that specifies the number or the name of the column of the result set that contains the large object value to be retrieved. If the LOB argument is specified, this argument is ignored.

binary

Boolean value that specifies whether the large object column to be retrieved is of binary type (blob) or otherwise is of character type (clob). If the LOB argument is specified, this argument is ignored.

The following argument is specific of the data handler class:

data

String of data that will be returned by the class when it requested with the readLOB() method.

The following argument is specific of the resultlob handler class:

resultLOB

Integer handle value of a large object result row field.

[ Top ]

void destroyLOB(
integer
$lob)

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

Access: public

Parameters:

integer $lob — argument handle that is returned by the MDB2::createLOB() method.

[ Top ]

boolean endOfLOB(
integer
$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: flag that indicates whether it was reached the end of the large object input stream
Access: public

Parameters:

integer $lob — argument handle that is returned by the MDB2::createLOB() method.

[ Top ]

void freeBLOBValue(
int
$blob)

free a binary large object

Access: public

Parameters:

int $blob — lob index

[ Top ]

void freeCLOBValue(
int
$clob)

free a character large object

Access: public

Parameters:

int $clob — lob index

[ Top ]

string getBLOBDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an 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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::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_mysql::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_fbsql::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_oci8::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_pgsql::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_sqlite::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_mssql::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.

string

$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 ]

string getBooleanDeclaration(
string
$name, string
$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: public

Overridden in child classes as:

MDB2_Driver_Datatype_fbsql::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_pgsql::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_mssql::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.

string

$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 ]

string getCLOBDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an 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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::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_mysql::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_fbsql::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_oci8::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_pgsql::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_sqlite::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_mssql::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.

string

$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 ]

string getDateDeclaration(
string
$name, string
$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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::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_mysql::getDateDeclaration(): Obtain DBMS specific SQL code portion needed to declare an date type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_fbsql::getDateDeclaration(): Obtain DBMS specific SQL code portion needed to declare an date type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_oci8::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_pgsql::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_sqlite::getDateDeclaration(): Obtain DBMS specific SQL code portion needed to declare an date type field to be used in statements like CREATE TABLE.

Parameters:

string $name — name the field to be declared.

string

$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 ]

string getDecimalDeclaration(
string
$name, string
$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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::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_mysql::getDecimalDeclaration(): Obtain DBMS specific SQL code portion needed to declare an decimal type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_fbsql::getDecimalDeclaration(): Obtain DBMS specific SQL code portion needed to declare an decimal type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_oci8::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_pgsql::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_sqlite::getDecimalDeclaration(): Obtain DBMS specific SQL code portion needed to declare an decimal type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_mssql::getDecimalDeclaration(): Obtain DBMS specific SQL code portion needed to declare an decimal type field to be used in statements like CREATE TABLE.

Parameters:

string $name — name the field to be declared.

string

$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 ]

string getFloatDeclaration(
string
$name, string
$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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::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_mysql::getFloatDeclaration(): Obtain DBMS specific SQL code portion needed to declare an float type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_fbsql::getFloatDeclaration(): Obtain DBMS specific SQL code portion needed to declare an float type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_oci8::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_pgsql::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_sqlite::getFloatDeclaration(): Obtain DBMS specific SQL code portion needed to declare an float type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_mssql::getFloatDeclaration(): Obtain DBMS specific SQL code portion needed to declare an float type field to be used in statements like CREATE TABLE.

Parameters:

string $name — name the field to be declared.

string

$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 ]

string getIntegerDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an integer 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: public

Overridden in child classes as:

MDB2_Driver_Datatype_mysql::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_fbsql::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_oci8::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_sqlite::getIntegerDeclaration(): Obtain DBMS specific SQL code portion needed to declare an integer type field to be used in statements like CREATE TABLE.

Parameters:

string $name — name the field to be declared.

string

$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:

unsigned Boolean flag that indicates whether the field should be declared as unsigned integer if possible.

default Integer 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 ]

string getTextDeclaration(
string
$name, string
$field)

Obtain DBMS specific SQL code portion needed to declare an 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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::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_fbsql::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_oci8::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_pgsql::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_mssql::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.

string

$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 ]

string getTimeDeclaration(
string
$name, string
$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: public

Overridden in child classes as:

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

MDB2_Driver_Datatype_mysql::getTimeDeclaration(): Obtain DBMS specific SQL code portion needed to declare an time type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_fbsql::getTimeDeclaration(): Obtain DBMS specific SQL code portion needed to declare an time type field to be used in statements like CREATE TABLE.

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

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

MDB2_Driver_Datatype_sqlite::getTimeDeclaration(): Obtain DBMS specific SQL code portion needed to declare an time type field to be used in statements like CREATE TABLE.

Parameters:

string $name — name the field to be declared.

string

$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 ]

string getTimestampDeclaration(
string
$name, string
$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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::getTimestampDeclaration(): Obtain DBMS specific SQL code portion needed to declare an timestamp type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_mysql::getTimestampDeclaration(): Obtain DBMS specific SQL code portion needed to declare an timestamp type field to be used in statements like CREATE TABLE.

MDB2_Driver_Datatype_fbsql::getTimestampDeclaration(): Obtain DBMS specific SQL code portion needed to declare an timestamp type field to be used in statements like CREATE TABLE.

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

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

MDB2_Driver_Datatype_sqlite::getTimestampDeclaration(): Obtain DBMS specific SQL code portion needed to declare an timestamp type field to be used in statements like CREATE TABLE.

Parameters:

string $name — name the field to be declared.

string

$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 ]

string implodeArray(
array
$array, [string
$type = false])

apply a type to all values of an array and return as a comma seperated string useful for generating IN statements

Return: comma seperated values
Access: public

Parameters:

array	`$array`	—	data array
string	`$type`	—	determines type of the field

[ Top ]

string quoteBLOB(

$blob, resource
$prepared_query, $parameter
1, $blob
2)

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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::quoteBLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_mysql::quoteBLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_fbsql::quoteBLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_oci8::quoteBLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_pgsql::quoteBLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_sqlite::quoteBLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_mssql::quoteBLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

Parameters:

resource	`$prepared_query`	—	query handle from prepare()
$parameter	`1`	—
$blob	`2`	—
	`$blob`	—

[ Top ]

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: public

Overridden in child classes as:

MDB2_Driver_Datatype_fbsql::quoteBoolean(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_pgsql::quoteBoolean(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_mssql::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 ]

string quoteCLOB(

$clob, resource
$prepared_query, $parameter
1, $clob
2)

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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::quoteCLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_mysql::quoteCLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_fbsql::quoteCLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_oci8::quoteCLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_pgsql::quoteCLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_sqlite::quoteCLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_mssql::quoteCLOB(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

Parameters:

resource	`$prepared_query`	—	query handle from prepare()
$parameter	`1`	—
$clob	`2`	—
	`$clob`	—

[ Top ]

string quoteDate(
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: public

Overridden in child classes as:

MDB2_Driver_Datatype_fbsql::quoteDate(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_oci8::quoteDate(): 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 ]

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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::quoteDecimal(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_mysql::quoteDecimal(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_fbsql::quoteDecimal(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_oci8::quoteDecimal(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_pgsql::quoteDecimal(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_sqlite::quoteDecimal(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_mssql::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 ]

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: public

Overridden in child classes as:

MDB2_Driver_Datatype_ibase::quoteFloat(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_mysql::quoteFloat(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_fbsql::quoteFloat(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_oci8::quoteFloat(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_pgsql::quoteFloat(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_sqlite::quoteFloat(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_mssql::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 ]

string quoteInteger(
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: public

Parameters:

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

[ Top ]

string quoteText(
string
$value)

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

Return: text string that already contains any DBMS specific escaped character sequences.
Access: public

Parameters:

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

[ Top ]

string quoteTime(
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: public

Overridden in child classes as:

MDB2_Driver_Datatype_fbsql::quoteTime(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_oci8::quoteTime(): 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 ]

string quoteTimestamp(
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: public

Overridden in child classes as:

MDB2_Driver_Datatype_fbsql::quoteTimestamp(): Convert a text value into a DBMS specific format that is suitable to compose query statements.

MDB2_Driver_Datatype_oci8::quoteTimestamp(): 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 ]

mixed readLOB(
integer
$lob, 
&$data, integer
$length, string
$data)

Read data from large object input stream.

Return: the effective number of bytes read from the large object input stream on sucess or an MDB2 error object.
See: MDB2_Driver_Datatype_Common::endOfLOB()
Access: public

Parameters:

integer	`$lob`	—	argument handle that is returned by the MDB2::createLOB() method.
string	`$data`	—	reference to a variable that will hold data to be read from the large object input stream
integer	`$length`	—	value that indicates the largest ammount ofdata to be read from the large object input stream.
	`&$data`	—

[ Top ]

mixed setResultTypes(

&$result, string
$types, resource
$result)

Define the list of types to be associated with the columns of a given result set.

This function may be called before invoking fetch(), fetchRow(), fetchCol() and fetchAll() so that the necessary data type conversions are performed on the data to be retrieved by them. If this function is not called, the type of all result set columns is assumed to be text, thus leading to not perform any conversions.

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

Parameters:

resource	`$result`	—	result identifier
string	`$types`	—	array variable that lists the data types to be expected in the result set columns. If this array contains less types than the number of columns that are returned in the result set, the remaining columns are assumed to be of the type text. Currently, the types clob and blob are not fully supported.
	`&$result`	—

[ Top ]

Class: MDB2_Driver_Datatype_Common

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$db_index =

Method Detail

MDB2_Driver_Datatype_Common (Constructor) [line 96]

Parameters:

convertResult [line 204]

Parameters:

convertResultRow [line 221]

Parameters:

createLOB [line 937]

Parameters:

destroyLOB [line 1144]

Parameters:

endOfLOB [line 1109]

Parameters:

freeBLOBValue [line 680]

Parameters:

freeCLOBValue [line 644]

Parameters:

getBLOBDeclaration [line 384]

Parameters:

getBooleanDeclaration [line 414]

Parameters:

getCLOBDeclaration [line 352]

Parameters:

getDateDeclaration [line 445]

Parameters:

getDecimalDeclaration [line 569]

Parameters:

getFloatDeclaration [line 538]

Parameters:

getIntegerDeclaration [line 279]

Parameters:

getTextDeclaration [line 318]

Parameters:

getTimeDeclaration [line 507]

Parameters:

getTimestampDeclaration [line 476]

Parameters:

implodeArray [line 1165]

Parameters:

quoteBLOB [line 664]

Parameters:

quoteBoolean [line 698]

Parameters:

quoteCLOB [line 628]

Parameters:

quoteDate [line 716]

Parameters:

quoteDecimal [line 788]

Parameters:

quoteFloat [line 770]

Parameters:

quoteInteger [line 590]

Parameters:

quoteText [line 608]

Parameters:

quoteTime [line 752]

Parameters:

quoteTimestamp [line 734]

Parameters:

readLOB [line 1070]

Parameters:

setResultTypes [line 124]

Parameters: