phpDocumentor CYap
[ Back ] [ class tree: CYap ] [ index: CYap ] [ all elements ]

Class: CYap_MsSQL

Source Location: /CYap_Mssql.php

Class CYap_MsSQL

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From CYapDB

CYapDB::$CurrentRow
CYapDB::$DbConn
CYapDB::$Dbresult
CYapDB::$Db_Open
CYapDB::$LastQuery
CYapDB::$txtError

Inherited From CYapDB

CYapDB::CYapDB()
CYapDB::DbaddSql()
From an array of values, made the sql for adding the row
CYapDB::DbError()
Return the error descritpion from last command
CYapDB::DbEscape()
Escape the string using the db functions, if provided It don't apply the escape string if magic_quotes_gpc is enabled
CYapDB::DbExecSql()
Execute the given query
CYapDB::DbFetchField()
Get column information from a result and return as an object
CYapDB::DbFieldFlags()
Get the flags associated with the specified field in a result
CYapDB::DbFreeResult()
Free the given result
CYapDB::DbGetNumFields()
Retrieve the number of fields retrieved by the given result
CYapDB::DbGetNumRow()
Retrieve the number of rows retrieved by the given result
CYapDB::DbmodifySql()
From an array of values, made the sql for modify the row
CYapDB::DbRegexCond()
Build the condition string for the $FieldName using the pattern matching
CYapDB::OpenDB()
Open the database connection
CYapDB::QueryLimit()
Perform a select statement using range to limits the
CYapDB::SelectDb()

[ Top ]
Property Summary
array   $LastRow   Memorize the last row retruned for each result.
integer   $LimitEnd   If UseLimit set to true, this var 'remember' the end limit
integer   $LimitStart   If UseLimit set to true, this var 'remember' the start limit
integer   $LimitToEnd   If UseLimit set to true, this var counts down how many rows left to
mixed   $SavePasswd  
mixed   $SaveUser  
boolean   $UseLimit   Tracks if the last query is a query with limit. Used to mimic the mysql's limit

[ Top ]
Method Summary
CYap_MsSQL   CYap_MsSQL()  
void   DbaddSql()   From an array of values, make the sql for adding the row
string   DbEscape()   Escape the string using the db functions, if provided It don't apply the escape string if magic_quotes_gpc is enabled
mixed   DbExecSql()   Execute the given query
object DbMeta   DbFetchField()   Get column information from a result and return as an object
string   DbFieldFlags()   Get the flags associated with the specified field in a result
bool   DbFreeResult()   Free the given result
integer   DbGetNumFields()   Retrieve the number of fields retrieved by the given result
integer   DbGetNumRow()   Retrieve the number of rows retrieved by the given result
array   DbGetValue()   Return the current row as associative array
void   DbmodifySql()   From an array of values, made the sql for modify the row
string   DbRegexCond()   Build the condition string for the $FieldName using the pattern matching
bool   Db_Close()   Close the connection to the database
bool   OpenDb()   Open the database connection
bool   QueryLimit()   Perform a select statement using range to limits the
bool   SelectDb()   database selection. Always true, the ODBC function don't allow to

[ Top ]
Properties
array   $LastRow [line 66]

Memorize the last row retruned for each result.

Used to track the columns type and number for query


[ Top ]
integer   $LimitEnd [line 60]

If UseLimit set to true, this var 'remember' the end limit


[ Top ]
integer   $LimitStart [line 55]

If UseLimit set to true, this var 'remember' the start limit


[ Top ]
integer   $LimitToEnd [line 50]

If UseLimit set to true, this var counts down how many rows left to

the limit end


[ Top ]
mixed   $SavePasswd [line 76]
API Tags:
See:  CYap_MsSQL::SelectDb()


[ Top ]
mixed   $SaveUser [line 71]
API Tags:
See:  CYap_MsSQL::SelectDb()


[ Top ]
boolean   $UseLimit [line 44]

Tracks if the last query is a query with limit. Used to mimic the mysql's limit

statement


[ Top ]
Methods
Constructor CYap_MsSQL  [line 78]

  CYap_MsSQL CYap_MsSQL( )



[ Top ]
DbaddSql  [line 341]

  void DbaddSql( array $row, array $fieldsType, string $KeyField  )

From an array of values, make the sql for adding the row

Parameters:
array   $row:  array of values. The key is the field name
array   $fieldsType:  type of each fields
string   $KeyField:  name of the key field

API Tags:
Access:  public


Redefinition of:
CYapDB::DbaddSql()
From an array of values, made the sql for adding the row

[ Top ]
DbEscape  [line 407]

  string DbEscape( string $value  )

Escape the string using the db functions, if provided It don't apply the escape string if magic_quotes_gpc is enabled

Parameters:
string   $value:  sql statement

API Tags:
Return:  the escaped string
Access:  public


Redefinition of:
CYapDB::DbEscape()
Escape the string using the db functions, if provided It don't apply the escape string if magic_quotes_gpc is enabled

[ Top ]
DbExecSql  [line 137]

  mixed DbExecSql( string $sql  )

Execute the given query

Parameters:
string   $sql:  sql statement

API Tags:
Return:  the result id, false on failure


Redefinition of:
CYapDB::DbExecSql()
Execute the given query

[ Top ]
DbFetchField  [line 217]

  object DbMeta DbFetchField( integer $result, integer $FieldNo  )

Get column information from a result and return as an object

Parameters:
integer   $result: 
integer   $FieldNo: 


Redefinition of:
CYapDB::DbFetchField()
Get column information from a result and return as an object

[ Top ]
DbFieldFlags  [line 264]

  string DbFieldFlags( resource $result, integer $FieldNo  )

Get the flags associated with the specified field in a result

Parameters:
resource   $result: 
integer   $FieldNo: 


Redefinition of:
CYapDB::DbFieldFlags()
Get the flags associated with the specified field in a result

[ Top ]
DbFreeResult  [line 281]

  bool DbFreeResult( resource $result  )

Free the given result

Parameters:
resource   $result: 

API Tags:
Return:  true on success, false on failure


Redefinition of:
CYapDB::DbFreeResult()
Free the given result

[ Top ]
DbGetNumFields  [line 206]

  integer DbGetNumFields( integer $result  )

Retrieve the number of fields retrieved by the given result

Parameters:
integer   $result: 


Redefinition of:
CYapDB::DbGetNumFields()
Retrieve the number of fields retrieved by the given result

[ Top ]
DbGetNumRow  [line 189]

  integer DbGetNumRow( integer $result  )

Retrieve the number of rows retrieved by the given result

Parameters:
integer   $result: 


Redefinition of:
CYapDB::DbGetNumRow()
Retrieve the number of rows retrieved by the given result

[ Top ]
DbGetValue  [line 293]

  array DbGetValue( resource $result  )

Return the current row as associative array

Parameters:
resource   $result: 

API Tags:
Return:  row data or false on failure


[ Top ]
DbmodifySql  [line 373]

  void DbmodifySql( array $row, array $fieldsType  )

From an array of values, made the sql for modify the row

Parameters:
array   $row:  array of values. The key is the field name
array   $fieldsType:  type of each fields

API Tags:
Access:  public


Redefinition of:
CYapDB::DbmodifySql()
From an array of values, made the sql for modify the row

[ Top ]
DbRegexCond  [line 394]

  string DbRegexCond( string $FieldName, string $pattern  )

Build the condition string for the $FieldName using the pattern matching

syntax

Parameters:
string   $FieldName: 
string   $pattern: 

API Tags:
Access:  public


Redefinition of:
CYapDB::DbRegexCond()
Build the condition string for the $FieldName using the pattern matching

[ Top ]
Db_Close  [line 320]

  bool Db_Close( )

Close the connection to the database


API Tags:
Return:  true


[ Top ]
OpenDb  [line 93]

  bool OpenDb( mixed $DBSystem, [mixed $DBUser = ""], [mixed $DBPasswd = ""], string $server, string $User, string $Password  )

Open the database connection

Parameters:
string   $server:  database server
string   $User:  username
string   $Password:  User password

API Tags:
Return:  true on success, false on failure


[ Top ]
QueryLimit  [line 165]

  bool QueryLimit( string $select, [integer $start = 0], [integer $many = -1]  )

Perform a select statement using range to limits the

rows to return

Parameters:
string   $select:  select statement
integer   $start:  no. rows to start
integer   $many:  how many rows sholud be returned

API Tags:
Return:  true on success, false on failure


Redefinition of:
CYapDB::QueryLimit()
Perform a select statement using range to limits the

[ Top ]
SelectDb  [line 117]

  bool SelectDb( string $DBname  )

database selection. Always true, the ODBC function don't allow to

select any database

Parameters:
string   $DBname:  database name

API Tags:
Return:  true on success, false on failure


Redefinition of:
CYapDB::SelectDb()

[ Top ]

Documentation generated on Sat, 26 Feb 2005 14:10:01 +0100 by phpDocumentor 1.3.0RC3