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

Element index for package creole

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

_

__construct
in file SQLException.php, method SQLException::__construct()
    Constructs a SQLException.
__construct
in file ResultSetIterator.php, method ResultSetIterator::__construct()
    Construct the iterator.
__construct
in file DataSet.php, method DataSetIterator::__construct()
top

a

$affixMap
in file CreoleTypes.php, variable CreoleTypes::$affixMap
    Map of Creole type integers to the setter/getter affix.
absolute
in file ResultSet.php, method ResultSet::absolute()
    Moves the cursor to an absolute cursor position and fetches the row at that position.
afterLast
in file ResultSet.php, method ResultSet::afterLast()
    Sets cursort to after the last record. This does not actually seek(), but simply sets the cursor pos to last + 1.
applyLimit
in file Connection.php, method Connection::applyLimit()
    If RDBMS supports native LIMIT/OFFSET then query SQL is modified so that no emulation is performed in ResultSet.
DATE
in file CreoleTypes.php, class constant CreoleTypes::DATE
VARBINARY
in file CreoleTypes.php, class constant CreoleTypes::VARBINARY
VARCHAR
in file CreoleTypes.php, class constant CreoleTypes::VARCHAR
top

b

beforeFirst
in file ResultSet.php, method ResultSet::beforeFirst()
    Sets cursort to before first record. This does not actually seek(), but simply sets cursor pos to 0.
top

c

$creoleTypeMap
in file CreoleTypes.php, variable CreoleTypes::$creoleTypeMap
    Map of Creole type integers to their textual name.
CallableStatement
in file CallableStatement.php, class CallableStatement
    Interface for callable statements.
close
in file ResultSet.php, method ResultSet::close()
    Frees the resources allocated for this result set.
close
in file Statement.php, method Statement::close()
    Free resources associated with this statement.
close
in file Connection.php, method Connection::close()
    Free the db resources.
close
in file PreparedStatement.php, method PreparedStatement::close()
    Free resources associated with this statement.
commit
in file Connection.php, method Connection::commit()
    Commits statements in a transaction.
connect
in file Connection.php, method Connection::connect()
    Connect to a database and log in as the specified user.
Connection
in file Connection.php, class Connection
    Connection is an abstract base class for DB dialect implementations, and must be inherited by all such.
createStatement
in file Connection.php, method Connection::createStatement()
    Creates a new empty Statement.
Creole
in file Creole.php, class Creole
    This is the class that manages the database drivers.
CreoleTypes
in file CreoleTypes.php, class CreoleTypes
    Generic Creole types modeled on JDBC types.
CallableStatement.php
procedural page CallableStatement.php
Connection.php
procedural page Connection.php
CreoleTypes.php
procedural page CreoleTypes.php
Creole.php
procedural page Creole.php
current
in file DataSet.php, method DataSetIterator::current()
current
in file ResultSetIterator.php, method ResultSetIterator::current()
    Returns the row (assoc array) at current cursor pos.
top

d

DataSetIterator
in file DataSet.php, class DataSetIterator
    The Iterator returned by DataSet::getIterator() that loops through the records.
deregisterDriver
in file Creole.php, method Creole::deregisterDriver()
    Removes the driver for a PHP type. Note that this will remove user-registered drivers _and_ the default drivers.
top

e

DECIMAL
in file CreoleTypes.php, class constant CreoleTypes::DECIMAL
execute
in file Statement.php, method Statement::execute()
    Generic execute() function has to check to see whether SQL is an update or select query.
executeQuery
in file Connection.php, method Connection::executeQuery()
    Executes the SQL query in this PreparedStatement object and returns the resultset.
executeQuery
in file PreparedStatement.php, method PreparedStatement::executeQuery()
    Executes the SQL query in this PreparedStatement object and returns the resultset generated by the query.
executeQuery
in file Statement.php, method Statement::executeQuery()
    Executes the SQL query in this PreparedStatement object and returns the resultset generated by the query.
executeUpdate
in file PreparedStatement.php, method PreparedStatement::executeUpdate()
    Executes the SQL INSERT, UPDATE, or DELETE statement in this PreparedStatement object.
executeUpdate
in file Statement.php, method Statement::executeUpdate()
    Executes the SQL INSERT, UPDATE, or DELETE statement in this PreparedStatement object.
executeUpdate
in file Connection.php, method Connection::executeUpdate()
    Executes the SQL INSERT, UPDATE, or DELETE statement.
FETCHMODE_ASSOC
in file ResultSet.php, class constant ResultSet::FETCHMODE_ASSOC
    Index result set by field name.
FETCHMODE_NUM
in file ResultSet.php, class constant ResultSet::FETCHMODE_NUM
    Index result set numerically.
PERSISTENT
in file Creole.php, class constant Creole::PERSISTENT
    Constant that indicates a connection object should be used.
REAL
in file CreoleTypes.php, class constant CreoleTypes::REAL
SEQUENCE
in file IdGenerator.php, class constant IdGenerator::SEQUENCE
    SEQUENCE id generator type
TEXT
in file CreoleTypes.php, class constant CreoleTypes::TEXT
YEAR
in file CreoleTypes.php, class constant CreoleTypes::YEAR
top

f

first
in file ResultSet.php, method ResultSet::first()
    Move cursor to beginning of recordset.
top

g

get
in file ResultSet.php, method ResultSet::get()
    A generic get method returns unformatted (=string) value.
getAffix
in file CreoleTypes.php, method CreoleTypes::getAffix()
    Gets the "affix" to use for ResultSet::get*() and PreparedStatement::set*() methods.
getArray
in file ResultSet.php, method ResultSet::getArray()
    Reads a column as an array.
getArray
in file CallableStatement.php, method CallableStatement::getArray()
getAutoCommit
in file Connection.php, method Connection::getAutoCommit()
    Get auto-commit status.
getBlob
in file CallableStatement.php, method CallableStatement::getBlob()
getBlob
in file ResultSet.php, method ResultSet::getBlob()
    Returns Blob with contents of column value.
getBoolean
in file CallableStatement.php, method CallableStatement::getBoolean()
getBoolean
in file ResultSet.php, method ResultSet::getBoolean()
    Returns value translated to boolean.
getClob
in file ResultSet.php, method ResultSet::getClob()
    Returns Clob with contents of column value.
getClob
in file CallableStatement.php, method CallableStatement::getClob()
getConnection
in file Statement.php, method Statement::getConnection()
    Gets the db Connection that created this statement.
getConnection
in file Creole.php, method Creole::getConnection()
    Create a new DB connection object and connect to the specified database
getConnection
in file PreparedStatement.php, method PreparedStatement::getConnection()
    Gets the db Connection that created this statement.
getCreoleCode
in file CreoleTypes.php, method CreoleTypes::getCreoleCode()
    Given the name of a type (e.g. 'VARCHAR') this method will return the corresponding integer.
getCreoleName
in file CreoleTypes.php, method CreoleTypes::getCreoleName()
    Given the integer type, this method will return the corresponding type name.
getCursorPos
in file ResultSet.php, method ResultSet::getCursorPos()
    Returns the current cursor position.
getDatabaseInfo
in file Connection.php, method Connection::getDatabaseInfo()
    Gets a DatabaseInfo class for the current database.
getDate
in file CallableStatement.php, method CallableStatement::getDate()
    Return a formatted date.
getDate
in file ResultSet.php, method ResultSet::getDate()
    Return a formatted date.
getDriver
in file Creole.php, method Creole::getDriver()
    Returns the class path to the driver registered for specified type.
getDSN
in file Connection.php, method Connection::getDSN()
    Get the DSN array used by connect() method to connect to database.
getFetchmode
in file ResultSet.php, method ResultSet::getFetchmode()
    Gets the fetchmode used to retrieve results.
getFlags
in file Connection.php, method Connection::getFlags()
    Get any flags that were passed to connection.
getFloat
in file ResultSet.php, method ResultSet::getFloat()
    Returns value cast as a float (in PHP this is same as double).
getFloat
in file CallableStatement.php, method CallableStatement::getFloat()
getId
in file IdGenerator.php, method IdGenerator::getId()
    Get the autoincrement or sequence id given the current connection and any additional needed info (e.g. sequence name for sequences).
getIdGenerator
in file Connection.php, method Connection::getIdGenerator()
    Loads and returns an IdGenerator object for current RDBMS.
getIdMethod
in file IdGenerator.php, method IdGenerator::getIdMethod()
    Get the preferred type / style for generating ids for RDBMS.
getInt
in file CallableStatement.php, method CallableStatement::getInt()
getInt
in file ResultSet.php, method ResultSet::getInt()
    Returns value cast as integer.
getLimit
in file PreparedStatement.php, method PreparedStatement::getLimit()
    Returns the maximum number of rows to return or 0 for all.
getLimit
in file Statement.php, method Statement::getLimit()
    Returns the maximum number of rows to return or 0 for all.
getMoreResults
in file Statement.php, method Statement::getMoreResults()
    Gets next result set (if this behavior is supported by driver).
getMoreResults
in file PreparedStatement.php, method PreparedStatement::getMoreResults()
    Gets next result set (if this behavior is supported by driver).
getNativeError
in file SQLException.php, method SQLException::getNativeError()
    Gets driver native error message.
getNativeType
in file CreoleTypes.php, method CreoleTypes::getNativeType()
    This method will return a native type that corresponds to the specified Creole (JDBC-like) type.
getOffset
in file Statement.php, method Statement::getOffset()
    Returns the start row.
getOffset
in file PreparedStatement.php, method PreparedStatement::getOffset()
    Returns the start row.
getRecordCount
in file ResultSet.php, method ResultSet::getRecordCount()
    Get the number of rows in a result set.
getResource
in file Connection.php, method Connection::getResource()
    Get the PHP native resource for the database connection/link.
getResource
in file PreparedStatement.php, method PreparedStatement::getResource()
    Get the PHP native resource for the statement (if supported).
getResource
in file ResultSet.php, method ResultSet::getResource()
    Get the PHP native resource for the result.
getResultSet
in file Statement.php, method Statement::getResultSet()
    Get result set.
getResultSet
in file PreparedStatement.php, method PreparedStatement::getResultSet()
    Get result set.
getRow
in file ResultSet.php, method ResultSet::getRow()
    Gets current fields (assoc array).
getString
in file CallableStatement.php, method CallableStatement::getString()
getString
in file ResultSet.php, method ResultSet::getString()
    Returns value cast as string.
getTime
in file CallableStatement.php, method CallableStatement::getTime()
    Return a formatted time.
getTime
in file ResultSet.php, method ResultSet::getTime()
    Return a formatted time.
getTimestamp
in file CallableStatement.php, method CallableStatement::getTimestamp()
    Return a formatted timestamp.
getTimestamp
in file ResultSet.php, method ResultSet::getTimestamp()
    Return a formatted timestamp.
getType
in file CreoleTypes.php, method CreoleTypes::getType()
    This method returns the generic Creole (JDBC-like) type when given the native db type.
getUpdateCount
in file Statement.php, method Statement::getUpdateCount()
    Get update count.
getUpdateCount
in file Connection.php, method Connection::getUpdateCount()
    Gets the number of rows affected by the data manipulation query.
getUpdateCount
in file PreparedStatement.php, method PreparedStatement::getUpdateCount()
    Get update count.
getUserInfo
in file SQLException.php, method SQLException::getUserInfo()
    Returns the additional / debug information for this error.
top

h

CHAR
in file CreoleTypes.php, class constant CreoleTypes::CHAR
top

i

BIGINT
in file CreoleTypes.php, class constant CreoleTypes::BIGINT
BINARY
in file CreoleTypes.php, class constant CreoleTypes::BINARY
IdGenerator.php
procedural page IdGenerator.php
IdGenerator
in file IdGenerator.php, class IdGenerator
    Interface for classes that provide functionality to get SEQUENCE or AUTO-INCREMENT ids from the database.
import
in file Creole.php, method Creole::import()
    Include once a file specified in DOT notation.
isAfterInsert
in file IdGenerator.php, method IdGenerator::isAfterInsert()
    Convenience method that returns TRUE if id is generated after an INSERT statement. This is the same as checking whether the generator type is AUTOINCREMENT.
isAfterLast
in file ResultSet.php, method ResultSet::isAfterLast()
    Checks whether cursor is after the last record.
isBeforeFirst
in file ResultSet.php, method ResultSet::isBeforeFirst()
    Checks whether cursor is before the first record.
isBeforeInsert
in file IdGenerator.php, method IdGenerator::isBeforeInsert()
    Convenience method that returns TRUE if id is generated before an INSERT statement. This is the same as checking whether the generator type is SEQUENCE.
isIgnoreAssocCase
in file ResultSet.php, method ResultSet::isIgnoreAssocCase()
    Whether assoc result keys get left alone -- as opposed to converted to lowercase.
TIME
in file CreoleTypes.php, class constant CreoleTypes::TIME
TIMESTAMP
in file CreoleTypes.php, class constant CreoleTypes::TIMESTAMP
TINYINT
in file CreoleTypes.php, class constant CreoleTypes::TINYINT
top

k

key
in file ResultSetIterator.php, method ResultSetIterator::key()
    Returns the cursor position.
key
in file DataSet.php, method DataSetIterator::key()
top

l

BLOB
in file CreoleTypes.php, class constant CreoleTypes::BLOB
CLOB
in file CreoleTypes.php, class constant CreoleTypes::CLOB
FLOAT
in file CreoleTypes.php, class constant CreoleTypes::FLOAT
last
in file ResultSet.php, method ResultSet::last()
    Move cursor to end of recordset.
top

m

SMALLINT
in file CreoleTypes.php, class constant CreoleTypes::SMALLINT
top

n

$nativeError
in file SQLException.php, variable SQLException::$nativeError
    Native RDBMS error string
INTEGER
in file CreoleTypes.php, class constant CreoleTypes::INTEGER
next
in file ResultSetIterator.php, method ResultSetIterator::next()
    This method does not actually do anything since we have already advanced the cursor pos in valid().
next
in file ResultSet.php, method ResultSet::next()
    Moves the internal cursor to the next position and fetches the row at that position.
next
in file DataSet.php, method DataSetIterator::next()
top

o

BOOLEAN
in file CreoleTypes.php, class constant CreoleTypes::BOOLEAN
DOUBLE
in file CreoleTypes.php, class constant CreoleTypes::DOUBLE
LONGVARBINARY
in file CreoleTypes.php, class constant CreoleTypes::LONGVARBINARY
LONGVARCHAR
in file CreoleTypes.php, class constant CreoleTypes::LONGVARCHAR
NO_ASSOC_LOWER
in file Creole.php, class constant Creole::NO_ASSOC_LOWER
    Flag to pass to the connection to indicate that no case conversions should be performed by ResultSet on keys of fetched rows.
top

p

PreparedStatement.php
procedural page PreparedStatement.php
parseDSN
in file Creole.php, method Creole::parseDSN()
    Parse a data source name.
prepareCall
in file Connection.php, method Connection::prepareCall()
    Creates a CallableStatement object for calling database stored procedures.
PreparedStatement
in file PreparedStatement.php, class PreparedStatement
    Interface for a pre-compiled SQL statement.
prepareStatement
in file Connection.php, method Connection::prepareStatement()
    Prepares a query for multiple execution with execute().
previous
in file ResultSet.php, method ResultSet::previous()
    Moves the internal cursor to the previous position and fetches the row at that position.
top

r

ARR
in file CreoleTypes.php, class constant CreoleTypes::ARR
    this is "ARRAY" from JDBC types
ResultSetIterator.php
procedural page ResultSetIterator.php
ResultSet.php
procedural page ResultSet.php
registerDriver
in file Creole.php, method Creole::registerDriver()
    Register your own RDBMS driver class.
registerOutParameter
in file CallableStatement.php, method CallableStatement::registerOutParameter()
    Register a parameter as an output param.
relative
in file ResultSet.php, method ResultSet::relative()
    Moves the cursor a relative number of rows, either positive or negative and fetches the row at that position.
ResultSet
in file ResultSet.php, class ResultSet
    This is the interface for classes the wrap db results.
ResultSetIterator
in file ResultSetIterator.php, class ResultSetIterator
    Basic ResultSet Iterator.
rewind
in file ResultSetIterator.php, method ResultSetIterator::rewind()
    If not at start of resultset, this method will call seek(0).
rewind
in file DataSet.php, method DataSetIterator::rewind()
rollback
in file Connection.php, method Connection::rollback()
    Rollback changes in a transaction.
top

s

SQLException.php
procedural page SQLException.php
Statement.php
procedural page Statement.php
seek
in file ResultSet.php, method ResultSet::seek()
    Moves cursor position WITHOUT FETCHING ROW AT THAT POSITION.
set
in file PreparedStatement.php, method PreparedStatement::set()
    A generic set method.
setArray
in file PreparedStatement.php, method PreparedStatement::setArray()
    Sets an array.
setAutoCommit
in file Connection.php, method Connection::setAutoCommit()
    Enable/disable automatic commits.
setBlob
in file PreparedStatement.php, method PreparedStatement::setBlob()
setBoolean
in file PreparedStatement.php, method PreparedStatement::setBoolean()
    Sets a boolean value.
setClob
in file PreparedStatement.php, method PreparedStatement::setClob()
setDate
in file PreparedStatement.php, method PreparedStatement::setDate()
setFetchmode
in file ResultSet.php, method ResultSet::setFetchmode()
    Sets the fetchmode used to retrieve results.
setFloat
in file PreparedStatement.php, method PreparedStatement::setFloat()
setInt
in file PreparedStatement.php, method PreparedStatement::setInt()
setLimit
in file Statement.php, method Statement::setLimit()
    Sets the maximum number of rows to return from db.
setLimit
in file PreparedStatement.php, method PreparedStatement::setLimit()
    Sets the maximum number of rows to return from db.
setNativeError
in file SQLException.php, method SQLException::setNativeError()
    Sets driver native error message.
setNull
in file PreparedStatement.php, method PreparedStatement::setNull()
setOffset
in file PreparedStatement.php, method PreparedStatement::setOffset()
    Sets the start row.
setOffset
in file Statement.php, method Statement::setOffset()
    Sets the start row.
setString
in file PreparedStatement.php, method PreparedStatement::setString()
setTime
in file PreparedStatement.php, method PreparedStatement::setTime()
setTimestamp
in file PreparedStatement.php, method PreparedStatement::setTimestamp()
setUserInfo
in file SQLException.php, method SQLException::setUserInfo()
    Sets additional user / debug information for this error.
SQLException
in file SQLException.php, class SQLException
    A class for handling database-related errors.
Statement
in file Statement.php, class Statement
    Class that represents a SQL statement.
top

t

OTHER
in file CreoleTypes.php, class constant CreoleTypes::OTHER
toString
in file SQLException.php, method SQLException::toString()
top

u

$userInfo
in file SQLException.php, variable SQLException::$userInfo
    Information that provides additional information for context of Exception (e.g. SQL statement or DSN).
AUTOINCREMENT
in file IdGenerator.php, class constant IdGenerator::AUTOINCREMENT
    AUTO INCREMENT id generator type
NUMERIC
in file CreoleTypes.php, class constant CreoleTypes::NUMERIC
top

v

valid
in file ResultSetIterator.php, method ResultSetIterator::valid()
    This method checks to see whether there are more results by advancing the cursor position.
valid
in file DataSet.php, method DataSetIterator::valid()
top

Documentation generated on Mon, 23 Aug 2004 21:50:55 -0400 by phpDocumentor 1.3.0RC3