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


Classes:
MDB2
MDB2_Datatype_xxx
MDB2_Date
MDB2_Driver_Common
MDB2_Driver_Datatype_Common
MDB2_Driver_Function_Common
MDB2_Driver_Manager_Common
MDB2_Driver_Manager_xxx
MDB2_Driver_Reverse_Common
MDB2_Error
MDB2_Extended
MDB2_Iterator
MDB2_LOB
MDB2_Native_xxx
MDB2_Reverse_xxx
MDB2_xxx
MDB2
   MDB2_BufferedIterator
Files:
clitest.php
Common.php
Common.php
Common.php
Common.php
config.php
Console_TestListener.php
Date.php
Driver_Datatype_skeleton.php
Driver_Manager_skeleton.php
Driver_Native_skeleton.php
Driver_Reverse_skeleton.php
Driver_skeleton.php
example.php
Extended.php
HTML_TestListener.php
Iterator.php
LOB.php
MDB2.php
MDB2_api_testcase.php
MDB2_bugs_testcase.php
MDB2_Connect_Test.php
MDB2_datatype_testcase.php
MDB2_function_testcase.php
MDB2_manager_testcase.php
MDB2_native_testcase.php
MDB2_reverse_testcase.php
MDB2_testcase.php
MDB2_usage_testcase.php
test.php
testchoose.php
testUtils.php

Class: MDB2_Driver_Datatype_Common

Source Location: /MDB2-2.0.0/MDB2/Driver/Datatype/Common.php

Class Overview

MDB2_Module_Common
   |
   --MDB2_Driver_Datatype_Common

MDB2_Driver_Common: Base class that is extended by each MDB2 driver


Author(s):

Variables

Methods

Inherited Variables

Class: MDB2_Module_Common

MDB2_Module_Common::$db_index

Inherited Methods

Class: MDB2_Module_Common

MDB2_Module_Common::MDB2_Module_Common()
MDB2_Module_Common::getDBInstance()
get the instance of MDB2 associated with the module instance

Class Details

[line 62]
MDB2_Driver_Common: Base class that is extended by each MDB2 driver


[ Top ]

Class Variables

$lobs = array()

[line 82]

contains all LOB objects created with this MDB2 instance
  • Access: protected

Type:   array


[ Top ]

$valid_types = array(
        'text'      => '',
        'boolean'   => true,
        'integer'   => 0,
        'decimal'   => 0.0,
        'float'     => 0.0,
        'date'      => '0000-00-00 00:00:00',
        'time'      => '00:00:00',
        'timestamp' => '0000-00-00',
        'clob'      => '',
        'blob'      => '',
    )

[line 64]


Type:   mixed


[ Top ]


Method Detail

checkResultTypes   [line 106]

mixed checkResultTypes( string $types)

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

This function may be called before invoking fetchRow(), fetchOne() fetchCole() 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:

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.

[ Top ]

compareDefinition   [line 687]

array compareDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied
  • Return: containg all changes that will need to be applied
  • Access: public

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

convertResult   [line 189]

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

Parameters:

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

[ Top ]

convertResultRow   [line 208]

mixed convertResultRow( mixed $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

[ Top ]

destroyLOB   [line 1336]

void destroyLOB( resource $lob)

Free any resources allocated during the lifetime of the large object handler object.
  • Access: public

Parameters:

resource   $lob   —   stream handle

[ Top ]

getDeclaration   [line 252]

string getDeclaration( string $type, string $name, string $field)

Obtain DBMS specific SQL code portion needed to declare of the given type
  • Return: DBMS specific SQL code portion that should be used to declare the specified field.
  • Access: public

Parameters:

string   $type   —   type to which the value should be converted to
string   $name   —   name the field to be declared.
string   $field   —   definition of the field

[ Top ]

getTypeDeclaration   [line 291]

string getTypeDeclaration( array $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

Parameters:

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 ]

implodeArray   [line 1377]

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 ]

quote   [line 919]

string quote( string $value, [string $type = null], [bool $quote = true])

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.
string   $type   —   type to which the value should be converted to
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

writeLOBToFile   [line 1250]

mixed writeLOBToFile( resource $lob, string $file)

retrieve LOB from the database
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: protected

Parameters:

resource   $lob   —   stream handle
string   $file   —   name of the file into which the LOb should be fetched

[ Top ]

_baseConvertResult   [line 134]

object a _baseConvertResult( mixed $value, int $type)

general type conversion method
  • Return: MDB2 error on failure
  • Access: protected

Parameters:

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

[ Top ]

_compareBLOBDefinition   [line 804]

array _compareBLOBDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied to an BLOB field
  • Return: containg all changes that will need to be applied
  • Access: protected

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

_compareBooleanDefinition   [line 868]

array _compareBooleanDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied to an boolean field
  • Return: containg all changes that will need to be applied
  • Access: protected

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

_compareCLOBDefinition   [line 788]

array _compareCLOBDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied to an CLOB field
  • Return: containg all changes that will need to be applied
  • Access: protected

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

_compareDateDefinition   [line 820]

array _compareDateDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied to an date field
  • Return: containg all changes that will need to be applied
  • Access: protected

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

_compareDecimalDefinition   [line 900]

array _compareDecimalDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied to an decimal field
  • Return: containg all changes that will need to be applied
  • Access: protected

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

_compareFloatDefinition   [line 884]

array _compareFloatDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied to an float field
  • Return: containg all changes that will need to be applied
  • Access: protected

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

_compareIntegerDefinition   [line 739]

array _compareIntegerDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied to an integer field
  • Return: containg all changes that will need to be applied
  • Access: protected

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

_compareTextDefinition   [line 766]

array _compareTextDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied to an text field
  • Return: containg all changes that will need to be applied
  • Access: protected

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

_compareTimeDefinition   [line 836]

array _compareTimeDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied to an time field
  • Return: containg all changes that will need to be applied
  • Access: protected

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

_compareTimestampDefinition   [line 852]

array _compareTimestampDefinition( array $current, array $previous)

Obtain an array of changes that may need to applied to an timestamp field
  • Return: containg all changes that will need to be applied
  • Access: protected

Parameters:

array   $current   —   new definition
array   $previous   —   old definition

[ Top ]

_endOfLOB   [line 1321]

mixed _endOfLOB( resource $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

Parameters:

resource   $lob   —   stream handle

[ Top ]

_getBLOBDeclaration   [line 502]

string _getBLOBDeclaration( string $name, array $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: protected

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

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

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

string _getCLOBDeclaration( string $name, array $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

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

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

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

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

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 ]

_getDeclaration   [line 350]

string _getDeclaration( string $name, array $field)

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

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 ]

_getFloatDeclaration   [line 644]

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

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 ]

_getIntegerDeclaration   [line 397]

string _getIntegerDeclaration( string $name, array $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: protected

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:

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

string _getTextDeclaration( string $name, array $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: protected

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

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

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

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

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

string _quoteBLOB( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_quoteBoolean   [line 1128]

string _quoteBoolean( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_quoteCLOB   [line 1092]

string _quoteCLOB( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_quoteDate   [line 1146]

string _quoteDate( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_quoteDecimal   [line 1226]

string _quoteDecimal( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_quoteFloat   [line 1200]

string _quoteFloat( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_quoteInteger   [line 987]

string _quoteInteger( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_quoteLOB   [line 1073]

string _quoteLOB( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_quoteText   [line 1005]

string _quoteText( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_quoteTime   [line 1182]

string _quoteTime( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_quoteTimestamp   [line 1164]

string _quoteTimestamp( string $value, bool $quote)

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

Parameters:

string   $value   —   text string value that is intended to be converted.
bool   $quote   —   determines if the value should be quoted and escaped

[ Top ]

_readFile   [line 1030]

string _readFile( 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

Parameters:

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

[ Top ]

_readLOB   [line 1305]

mixed _readLOB( resource $lob, 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: endOfLOB()
  • Access: public

Parameters:

resource   $lob   —   stream handle
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.

[ Top ]

_retrieveLOB   [line 1281]

mixed _retrieveLOB( resource &$lob)

retrieve LOB from the database
  • Return: MDB2_OK on success, a MDB2 error on failure
  • Access: protected

Parameters:

resource   $lob   —   stream handle

[ Top ]
Documentation generated on Thu, 09 Feb 2006 09:34:15 -0500 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.