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

Class: MDB2_Driver_Datatype_ibase

Source Location: /MDB2_Driver_ibase-1.5.0b5/MDB2/Driver/Datatype/ibase.php

Class Overview

MDB2_Driver_Datatype_Common
   |
   --MDB2_Driver_Datatype_ibase

MDB2 Firebird/Interbase driver


Author(s):

Methods


Inherited Variables

Inherited Methods


Class Details

[line 59]
MDB2 Firebird/Interbase driver


[ Top ]


Method Detail

getTypeDeclaration   [line 168]

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 ]

patternEscapeString   [line 346]

string patternEscapeString( )

build string to define escape pattern string
  • Return: define escape pattern
  • Access: public

[ Top ]

_baseConvertResult   [line 72]

object a _baseConvertResult( mixed $value, string $type, [boolean $rtrim = true])

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

Parameters:

mixed   $value     refernce to a value to be converted
string   $type     specifies which type to convert to
boolean   $rtrim     [optional] when TRUE [default], apply rtrim() to text

[ Top ]

_destroyLOB   [line 328]

void _destroyLOB( &$lob, array $lob)

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

Parameters:

array   $lob     array
   &$lob     

[ Top ]

_mapNativeDatatype   [line 365]

array _mapNativeDatatype( array $field)

Maps a native array description of a field to a MDB2 datatype and length
  • Return: containing the various possible types, length, sign, fixed
  • Access: public

Parameters:

array   $field     native field description

[ Top ]

_quoteLOB   [line 219]

string _quoteLOB( string $value, bool $quote, bool $escape_wildcards)

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
bool   $escape_wildcards     if to escape escape wildcards

[ Top ]

_readLOB   [line 303]

mixed _readLOB( &$lob, int $length, array $lob, blob $data)

Read data from large object input stream.
  • Return: length on success, a MDB2 error on failure
  • Access: protected

Parameters:

array   $lob     array
blob   $data     reference to a variable that will hold data to be read from the large object input stream
int   $length     integer value that indicates the largest ammount of data to be read from the large object input stream.
   &$lob     

[ Top ]

_retrieveLOB   [line 263]

mixed _retrieveLOB( &$lob, array $lob)

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

Parameters:

array   $lob     array
   &$lob     

[ Top ]


Documentation generated on Mon, 29 Oct 2012 16:00:22 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.