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

Class: MDB2_Driver_Datatype_mssql

Source Location: /MDB2-2.0.0alpha1/MDB2/Driver/Datatype/mssql.php

Class Overview

MDB2_Driver_Datatype_Common
   |
   --MDB2_Driver_Datatype_mssql

MDB2 MS SQL 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::getBLOBValue()
Convert a text value into a DBMS specific format that is suitable to compose query statements.
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::getBooleanValue()
Convert a text value into a DBMS specific format that is suitable to compose query statements.
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::getCLOBValue()
Convert a text value into a DBMS specific format that is suitable to compose query statements.
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::getDateValue()
Convert a text value into a DBMS specific format that is suitable to compose query statements.
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::getDecimalValue()
Convert a text value into a DBMS specific format that is suitable to compose query statements.
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::getFloatValue()
Convert a text value into a DBMS specific format that is suitable to compose query statements.
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::getIntegerValue()
Convert a text value into a DBMS specific format that is suitable to compose query statements.
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::getTextValue()
Convert a text value into a DBMS specific format that is suitable to compose query statements.
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::getTimestampValue()
Convert a text value into a DBMS specific format that is suitable to compose query statements.
MDB2_Driver_Datatype_Common::getTimeValue()
Convert a text value into a DBMS specific format that is suitable to compose query statements.
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::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 MS SQL driver


[ Top ]


Method Detail

MDB2_Driver_Datatype_mssql (Constructor)   [line 66]

MDB2_Driver_Datatype_mssql MDB2_Driver_Datatype_mssql( mixed $db_index)

Constructor

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

freeBLOBValue   [line 411]

void freeBLOBValue( string $blob, string $value)

free a binary large object
  • Access: public

Overrides MDB2_Driver_Datatype_Common::freeBLOBValue() (free a binary large object)

Parameters:

string   $blob     
string   $value     

[ Top ]

freeCLOBValue   [line 365]

void freeCLOBValue( string $clob, string $value)

free a character large object
  • Access: public

Overrides MDB2_Driver_Datatype_Common::freeCLOBValue() (free a character large object)

Parameters:

string   $clob     
string   $value     

[ Top ]

getBLOBDeclaration   [line 209]

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 ]

getBLOBValue   [line 383]

string getBLOBValue( $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::getBLOBValue() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

$blob   $blob     

[ Top ]

getBooleanDeclaration   [line 248]

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.

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


[ Top ]

getBooleanValue   [line 429]

string getBooleanValue( 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::getBooleanValue() (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 ]

getCLOBDeclaration   [line 166]

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 ]

getCLOBValue   [line 336]

string getCLOBValue( $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::getCLOBValue() (Convert a text value into a DBMS specific format that is suitable to compose query statements.)

Parameters:

$clob   $clob     

[ Top ]

getDecimalDeclaration   [line 314]

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 ]

getDecimalValue   [line 465]

string getDecimalValue( 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::getDecimalValue() (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 ]

getFloatDeclaration   [line 281]

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 ]

getFloatValue   [line 447]

string getFloatValue( 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::getFloatValue() (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 ]

getTextDeclaration   [line 130]

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 ]


Documentation generated on Sat, 1 May 2004 01:37:14 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.