MDB2
[ class tree: MDB2 ] [ index: MDB2 ] [ all elements ]

Class: MDB2_Driver_Datatype_fbsql

Source Location: /MDB2-2.0.0beta2/MDB2/Driver/Datatype/fbsql.php

Class Overview

MDB2_Driver_Datatype_Common
   |
   --MDB2_Driver_Datatype_fbsql

MDB2 FrontbaseSQL driver


Author(s):

Methods


Inherited Variables

Inherited Methods

Class: MDB2_Driver_Datatype_Common

MDB2_Driver_Datatype_Common::MDB2_Driver_Datatype_Common()
Constructor
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::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::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::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::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::readLOB()
Read data from large object input stream.
MDB2_Driver_Datatype_Common::setResultTypes()
Define the list of types to be associated with the columns of a given result set.

Class Details

[line 58]
MDB2 FrontbaseSQL driver


[ Top ]


Method Detail

MDB2_Driver_Datatype_fbsql (Constructor)   [line 66]

MDB2_Driver_Datatype_fbsql MDB2_Driver_Datatype_fbsql( $db_index)

Constructor

Parameters:

   $db_index   — 

[ Top ]

convertResult   [line 82]

mixed convertResult( mixed $value, int $type)

convert a value to a RDBMS indepdenant MDB2 type
  • Return: converted value
  • 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 ]

getBLOBDeclaration   [line 236]

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

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

getBooleanDeclaration   [line 263]

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

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

getCLOBDeclaration   [line 205]

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

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

getDateDeclaration   [line 295]

string getDateDeclaration( string $name, string $field)

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

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

getDecimalDeclaration   [line 426]

string getDecimalDeclaration( string $name, string $field)

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

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

getFloatDeclaration   [line 393]

string getFloatDeclaration( string $name, string $field)

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

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

getIntegerDeclaration   [line 129]

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

Overrides 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.)

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 ]

getTextDeclaration   [line 169]

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

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

getTimeDeclaration   [line 360]

string getTimeDeclaration( string $name, string $field)

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

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

getTimestampDeclaration   [line 328]

string getTimestampDeclaration( string $name, string $field)

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

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.
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 stamp 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 479]

string quoteBLOB( $blob $blob)

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

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

Parameters:

$blob   $blob   — 

[ Top ]

quoteBoolean   [line 510]

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

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

string quoteCLOB( $clob $clob)

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

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

Parameters:

$clob   $clob   — 

[ Top ]

quoteDate   [line 528]

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

Overrides MDB2_Driver_Datatype_Common::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 ]

quoteDecimal   [line 600]

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

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

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

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 ]

quoteTime   [line 564]

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

Overrides MDB2_Driver_Datatype_Common::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 ]

quoteTimestamp   [line 546]

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

Overrides MDB2_Driver_Datatype_Common::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 ]


Documentation generated on Mon, 11 Mar 2019 10:15:46 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.