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

Class: DB_dbase

Source Location: /DB-1.7.14/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):

Version:

  • Release: 1.7.14

Copyright:

  • 1997-2007 The PHP Group

Variables

Methods


Inherited Variables

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::nextQueryIsManip()
Sets (or unsets) a flag indicating that the next query will be a manipulation query, regardless of the usual DB::isManip() heuristics.
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::quoteBoolean()
Formats a boolean value for use within a query in a locale-independent manner.
DB_common::quoteFloat()
Formats a float value for use within a query in a locale-independent manner.
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::_checkManip()
Checks if the given query is a manipulation query. This also takes into account the _next_query_manip flag and sets the _last_query_manip flag (and resets _next_query_manip) according to the result.
DB_common::_convertNullArrayValuesToEmpty()
Converts all null values in an array to empty strings
DB_common::_rtrimArrayValues()
Right-trims all strings in an array
DB_common::__sleep()
Automatically indicates which properties should be saved when PHP's serialize() function is called
DB_common::__toString()
Automatic string conversion for PHP 5
DB_common::__wakeup()
Automatically reconnects to the database when PHP's unserialize() function is called

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.



[ 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'50),
  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, &$arr, int $fetchmode, [int $rownum = null], array $arr)

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)
   &$arr     

[ Top ]

freeResult   [line 343]

bool freeResult( resource $result)

Deletes the result set and frees the memory occupied by the result set.

This method is a no-op for dbase, as there aren't result resources in the same sense as most other database backends.


Parameters:

resource   $result     PHP's query result resource

[ Top ]

numCols   [line 364]

int numCols( $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.


Parameters:

resource   $result     PHP's query result resource
   $foo     

[ Top ]

numRows   [line 385]

int numRows( $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.


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

Parameters:

resource   $result     PHP's query result resource
   $foo     

[ Top ]

query   [line 272]

void &query( [ $query = null])


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

Parameters:

   $query     

[ Top ]

quoteBoolean   [line 402]

string quoteBoolean( boolean $boolean)

Formats a boolean value for use within a query in a locale-independent manner.

Overrides DB_common::quoteBoolean() (Formats a boolean value for use within a query in a locale-independent manner.)

Parameters:

boolean   $boolean     the boolean value to be quoted.

[ 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.
  • See: DB_common::tableInfo()
  • Since: Method available since Release 1.7.0

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 ]


Documentation generated on Sat, 27 Aug 2011 14:00:08 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.