Class: DB_dbase

Source Location: /DB-1.7.0RC1/DB/dbase.php

Class Overview

PEAR
   |
   --DB_common
      |
      --DB_dbase

The methods PEAR DB uses to interact with PHP's dbase extension for interacting with dBase databases

Author(s):

Daniel Convissor <mailto:danielc at php.net>
Tomas V.V. Cox <mailto:cox at idecnet.com>

Version:

Release: @package_version@

Copyright:

1997-2005 The PHP Group

Variables

Methods

Inherited Variables

Class: DB_common

DB_common::$fetchmode
DB_common::$fetchmode_object_class
DB_common::$last_parameters
DB_common::$last_query
DB_common::$options
DB_common::$prepared_queries
DB_common::$prepare_tokens
DB_common::$prepare_types

Inherited Methods

Class: DB_common

DB_common::DB_common(): This constructor calls $this->PEAR('DB_Error')
DB_common::affectedRows(): Determines the number of rows affected by a data maniuplation query
DB_common::autoCommit(): Enables or disables automatic commits
DB_common::autoExecute(): Automaticaly generates an insert or update query and call prepare() and execute() with it
DB_common::autoPrepare(): Automaticaly generates an insert or update query and pass it to prepare()
DB_common::buildManipSQL(): Produces an SQL query string for autoPrepare()
DB_common::commit(): Commits the current transaction
DB_common::createSequence(): Creates a new sequence
DB_common::dropSequence(): Deletes a sequence
DB_common::errorCode(): Maps native error codes to DB's portable ones
DB_common::errorMessage(): Maps a DB error code to a textual message
DB_common::errorNative(): Gets the DBMS' native error code produced by the last query
DB_common::escapeSimple(): Escapes a string according to the current DBMS's standards
DB_common::execute(): Executes a DB statement prepared with prepare()
DB_common::executeEmulateQuery(): Emulates executing prepared statements if the DBMS not support them
DB_common::executeMultiple(): Performs several execute() calls on the same statement handle
DB_common::freePrepared(): Frees the internal resources associated with a prepared query
DB_common::getAll(): Fetches all of the rows from a query result
DB_common::getAssoc(): Fetches an entire query result and returns it as an associative array using the first column as the key
DB_common::getCol(): Fetches a single column from a query result and returns it as an indexed array
DB_common::getListOf(): Lists internal database information
DB_common::getOne(): Fetches the first column of the first row from a query result
DB_common::getOption(): Returns the value of an option
DB_common::getRow(): Fetches the first row of data returned from a query result
DB_common::getSequenceName(): Generates the name used inside the database for a sequence
DB_common::getSpecialQuery(): Obtains the query string needed for listing a given type of objects
DB_common::getTables(): Lists the tables in the current database
DB_common::limitQuery(): Generates and executes a LIMIT query
DB_common::modifyLimitQuery(): Adds LIMIT clauses to a query string according to current DBMS standards
DB_common::modifyQuery(): Changes a query string for various DBMS specific reasons
DB_common::nextId(): Returns the next free id in a sequence
DB_common::numRows(): Determines the number of rows in a query result
DB_common::prepare(): Prepares a query for multiple execution with execute()
DB_common::provides(): Tells whether the present driver supports a given feature
DB_common::query(): Sends a query to the database server
DB_common::quote(): DEPRECATED: Quotes a string so it can be safely used in a query
DB_common::quoteIdentifier(): Quotes a string so it can be safely used as a table or column name
DB_common::quoteSmart(): Formats input so it can be safely used in a query
DB_common::quoteString(): DEPRECATED: Quotes a string so it can be safely used within string delimiters in a query
DB_common::raiseError(): Communicates an error and invoke error callbacks, etc
DB_common::rollback(): Reverts the current transaction
DB_common::setFetchMode(): Sets the fetch mode that should be used by default for query results
DB_common::setOption(): Sets run-time configuration options for PEAR DB
DB_common::tableInfo(): Returns information about a table or a result set
DB_common::toString(): DEPRECATED: String conversion method
DB_common::_convertNullArrayValuesToEmpty(): Converts all null values in an array to empty strings
DB_common::_rtrimArrayValues(): Right-trims all strings in an array

Class Details

[line 47]
The methods PEAR DB uses to interact with PHP's dbase extension for interacting with dBase databases

These methods overload the ones declared in DB_common.

Version: Release: @package_version@
Link: http://pear.php.net/package/DB
License: PHP License 3.0
Copyright: 1997-2005 The PHP Group
Author: Daniel Convissor <mailto:danielc@php.net>
Author: Tomas V.V. Cox <mailto:cox@idecnet.com>

[ Top ]

Class Variables

$connection =

[line 97]

The raw database connection created by PHP

Type:

resource

[ Top ]

$dbsyntax = 'dbase'

[line 61]

The database syntax variant to be used (db2, access, etc.), if any

Type:

string

[ Top ]

$dsn = array()

[line 103]

The DSN information for connecting to a database

Type:

array

[ Top ]

$errorcode_map = array(
)

[line 90]

A mapping of native error codes to DB error codes

Type:

array

[ Top ]

$features = array(
        'limit'         => false,
        'new_link'      => false,
        'numrows'       => true,
        'pconnect'      => false,
        'prepare'       => false,
        'ssl'           => false,
        'transactions'  => false,
    )

[line 76]

The capabilities of this DB implementation

The 'new_link' element contains the PHP version that first provided new_link support for this DBMS. Contains false if it's unsupported.

Meaning of the 'limit' element:

'emulate' = emulate with fetch row by number
'alter' = alter the query
false = skip rows

Type:

array

[ Top ]

$phptype = 'dbase'

[line 55]

The DB driver type (mysql, oci8, odbc, etc.)

Type:

string

[ Top ]

$result = 0

[line 119]

The quantity of results so far

For emulating result resources.

Type:

integer

[ Top ]

$res_row = array()

[line 110]

A means of emulating result resources

Type:

array

[ Top ]

$types = array(
        'C' => 'character',
        'D' => 'date',
        'L' => 'boolean',
        'M' => 'memo',
        'N' => 'number',
    )

[line 130]

Maps dbase data type id's to human readable strings

The human readable values are based on the output of PHP's dbase_get_header_info() function.

Since: Property available since Release 1.7.0

Type:

array

[ Top ]

Method Detail

DB_dbase (Constructor) [line 147]

void DB_dbase(
)

This constructor calls $this->DB_common()

[ Top ]

connect [line 202]

int connect(
array
$dsn, [bool
$persistent = false])

Connect to the database and create it if it doesn't exist

Don't call this method directly. Use DB::connect() instead.

PEAR DB's dbase driver supports the following extra DSN options:

mode An integer specifying the read/write mode to use (0 = read only, 1 = write only, 2 = read/write). Available since PEAR DB 1.7.0.
fields An array of arrays that PHP's dbase_create() function needs to create a new database. This information is used if the dBase file specified in the "database" segment of the DSN does not exist. For more info, see the PHP manual's dbase_create() page. Available since PEAR DB 1.7.0.

Example of how to connect and establish a new dBase file if necessary:


1     require_once 'DB.php';
2     
3      $dsn = array(
4          'phptype'  => 'dbase',
5          'database' => '/path/and/name/of/dbase/file',
6          'mode'     => 2,
7          'fields'   => array(
8              array('a', 'N', 5, 0),
9              array('b', 'C', 40),
10             array('c', 'C', 255),
11             array('d', 'C', 20),
12         ),
13     );
14     $options = array(
15         'debug'       => 2,
16         'portability' => DB_PORTABILITY_ALL,
17     );
18    
19     $db =& DB::connect($dsn, $options);
20     if (PEAR::isError($db)) {
21         die($db->getMessage());
22     }

Return: DB_OK on success. A DB_Error object on failure.

Parameters:

array	`$dsn`	—	the data source name
bool	`$persistent`	—	should the connection be persistent?

[ Top ]

disconnect [line 262]

bool disconnect(
)

Disconnects from the database server

Return: TRUE on success, FALSE on failure

[ Top ]

fetchInto [line 303]

mixed fetchInto(
resource
$result, array
&$arr, int
$fetchmode, [int
$rownum = null])

Places a row from the result set into the given array

Formating of the array and the data therein are configurable. See DB_result::fetchInto() for more information.

This method is not meant to be called directly. Use DB_result::fetchInto() instead. It can't be declared "protected" because DB_result is a separate object.

Return: DB_OK on success, NULL when the end of a result set is reached or on failure
See: DB_result::fetchInto()

Parameters:

resource	`$result`	—	the query result resource
array	`$arr`	—	the referenced array to put the data in
int	`$fetchmode`	—	how the resulting array should be indexed
int	`$rownum`	—	the row number to fetch (0 = first row)

[ Top ]

numCols [line 344]

int numCols(
mixed
$foo, resource
$result)

Gets the number of columns in a result set

This method is not meant to be called directly. Use DB_result::numCols() instead. It can't be declared "protected" because DB_result is a separate object.

Return: the number of columns. A DB_Error object on failure.
See: DB_result::numCols()

Parameters:

resource $result — PHP's query result resource

[ Top ]

numRows [line 365]

int numRows(
mixed
$foo, resource
$result)

Gets the number of rows in a result set

This method is not meant to be called directly. Use DB_result::numRows() instead. It can't be declared "protected" because DB_result is a separate object.

Return: the number of rows. A DB_Error object on failure.
See: DB_result::numRows()

Overrides DB_common::numRows() (Determines the number of rows in a query result)

Parameters:

resource $result — PHP's query result resource

[ Top ]

query [line 272]

void &query(
[mixed
$query = null])

Overrides DB_common::query() (Sends a query to the database server)

[ Top ]

quoteSmart [line 393]

mixed quoteSmart(
mixed
$in)

Formats input so it can be safely used in a query

Return: the formatted data. The format depends on the input's PHP type:
- null = the string NULL
- boolean = T if true or F if false. Use the Logical data type.
- integer or double = the unquoted number
- other (including strings and numeric strings) = the data with single quotes escaped by preceeding single quotes then the whole string is encapsulated between single quotes
Since: Method available since Release 1.6.0
See: DB_common::quoteSmart()

Overrides DB_common::quoteSmart() (Formats input so it can be safely used in a query)

Parameters:

mixed $in — the data to be formatted

[ Top ]

tableInfo [line 422]

array tableInfo(
[mixed
$result = null], [int
$mode = null])

Returns information about the current database

Return: an associative array with the information requested. A DB_Error object on failure.
Since: Method available since Release 1.7.0
See: DB_common::tableInfo()

Overrides DB_common::tableInfo() (Returns information about a table or a result set)

Parameters:

mixed	`$result`	—	THIS IS UNUSED IN DBASE. The current database is examined regardless of what is provided here.
int	`$mode`	—	a valid tableInfo mode

[ Top ]

Class: DB_dbase

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: DB_common

Inherited Methods

Class: DB_common

Class Details

Class Variables

$connection =

$dbsyntax = 'dbase'

$dsn = array()

$errorcode_map = array( )

$features = array( 'limit' => false, 'new_link' => false, 'numrows' => true, 'pconnect' => false, 'prepare' => false, 'ssl' => false, 'transactions' => false, )

$phptype = 'dbase'

$result = 0

$res_row = array()

$types = array( 'C' => 'character', 'D' => 'date', 'L' => 'boolean', 'M' => 'memo', 'N' => 'number', )

Method Detail

DB_dbase (Constructor) [line 147]

connect [line 202]

Parameters:

disconnect [line 262]

fetchInto [line 303]

Parameters:

numCols [line 344]

Parameters:

numRows [line 365]

Parameters:

query [line 272]

quoteSmart [line 393]

Parameters:

tableInfo [line 422]

Parameters:

$errorcode_map = array(
)

$features = array(
'limit' => false,
'new_link' => false,
'numrows' => true,
'pconnect' => false,
'prepare' => false,
'ssl' => false,
'transactions' => false,
)

$types = array(
'C' => 'character',
'D' => 'date',
'L' => 'boolean',
'M' => 'memo',
'N' => 'number',
)