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

Class: MDB2_Driver_Datatype_mssql

Source Location: /MDB2_Driver_mssql-1.5.0b4/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 Details

[line 59]
MDB2 MS SQL driver


[ Top ]


Method Detail

getTypeDeclaration   [line 137]

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 ]

matchPattern   [line 356]

string matchPattern( array $pattern, [string $operator = null], [string $field = null])

build a pattern matching string
  • Return: SQL pattern
  • Access: public

Parameters:

array   $pattern     even keys are strings, odd are patterns (% and _)
string   $operator     optional pattern operator (LIKE, ILIKE and maybe others in the future)
string   $field     optional field name that is being matched against (might be required when emulating ILIKE)

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

_getBLOBDeclaration   [line 306]

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 ]

_getCLOBDeclaration   [line 270]

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 ]

_getIntegerDeclaration   [line 216]

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

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 ]

_mapNativeDatatype   [line 410]

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 ]

_quoteBLOB   [line 332]

string _quoteBLOB( 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 ]


Documentation generated on Tue, 23 Oct 2012 18:30:27 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.