creole
[ class tree: creole ] [ index: creole ] [ all elements ]
Packages:
creole
creole.common
creole.drivers.mssql
creole.drivers.mssql.metadata
creole.drivers.mysql
creole.drivers.mysql.metadata
creole.drivers.odbc
creole.drivers.odbc.metadata
creole.drivers.oracle
creole.drivers.oracle.metadata
creole.drivers.pgsql
creole.drivers.pgsql.metadata
creole.drivers.sqlite
creole.drivers.sqlite.metadata
creole.metadata
creole.util
creole.util.sql
jargon


Files:
CallableStatement.php
Connection.php
Creole.php
CreoleTypes.php
IdGenerator.php
PreparedStatement.php
ResultSet.php
ResultSetIterator.php
SQLException.php
Statement.php

Classes:
CallableStatement
Connection
Creole
CreoleTypes
DataSetIterator
IdGenerator
PreparedStatement
ResultSet
ResultSetIterator
SQLException
Statement

Class: CallableStatement

Source Location: /creole/CallableStatement.php

Interface Overview

PreparedStatement
   |
   --CallableStatement

Interface for callable statements.


Author(s):

Version:

  • $Revision: 1.7 $

Methods

Inherited Methods

Class: PreparedStatement

PreparedStatement::close()
Free resources associated with this statement.
PreparedStatement::executeQuery()
Executes the SQL query in this PreparedStatement object and returns the resultset generated by the query.
PreparedStatement::executeUpdate()
Executes the SQL INSERT, UPDATE, or DELETE statement in this PreparedStatement object.
PreparedStatement::getConnection()
Gets the db Connection that created this statement.
PreparedStatement::getLimit()
Returns the maximum number of rows to return or 0 for all.
PreparedStatement::getMoreResults()
Gets next result set (if this behavior is supported by driver).
PreparedStatement::getOffset()
Returns the start row.
PreparedStatement::getResource()
Get the PHP native resource for the statement (if supported).
PreparedStatement::getResultSet()
Get result set.
PreparedStatement::getUpdateCount()
Get update count.
PreparedStatement::set()
A generic set method.
PreparedStatement::setArray()
Sets an array.
PreparedStatement::setBlob()
PreparedStatement::setBoolean()
Sets a boolean value.
PreparedStatement::setClob()
PreparedStatement::setDate()
PreparedStatement::setFloat()
PreparedStatement::setInt()
PreparedStatement::setLimit()
Sets the maximum number of rows to return from db.
PreparedStatement::setNull()
PreparedStatement::setOffset()
Sets the start row.
PreparedStatement::setString()
PreparedStatement::setTime()
PreparedStatement::setTimestamp()

Class Details

[line 31]
Interface for callable statements.



Tags:

version:  $Revision: 1.7 $
author:  Hans Lellelid <hans@xmpl.org>


[ Top ]

Class Methods

method getArray [line 46]

array getArray( mixed $paramIndex)



Tags:

access:  public
throws:  SQLException if $paramIndex was not bound as output variable.


Parameters:

mixed   $paramIndex   Parameter name (e.g. "@var1").

[ Top ]

method getBlob [line 62]

Blob getBlob( mixed $paramIndex)



Tags:

return:  blob object
access:  public
throws:  SQLException if $paramIndex was not bound as output variable.


Parameters:

mixed   $paramIndex   Parameter name (e.g. "@var1").

[ Top ]

method getBoolean [line 54]

boolean getBoolean( mixed $paramIndex)



Tags:

access:  public
throws:  SQLException if $paramIndex was not bound as output variable.


Parameters:

mixed   $paramIndex   Parameter name (e.g. "@var1").

[ Top ]

method getClob [line 68]

Clob getClob( mixed $paramIndex)



Tags:

return:  clob object.
access:  public


Parameters:

mixed   $paramIndex   Column name (string) or index (int).

[ Top ]

method getDate [line 83]

mixed getDate( mixed $column, [string $format = '%x'])

Return a formatted date.

The default format for dates returned is preferred (in your locale, as specified using setlocale()) format w/o time (i.e. strftime("%x", $val)). Override this by specifying a format second parameter. You can also specify a date()-style formatter; if you do, make sure there are no "%" symbols in your format string.




Tags:

return:  Formatted date, or integer unix timestamp (using 00:00:00 for time) if $format was null.
access:  public
throws:  SQLException - If the column specified is not a valid key in current field array.


Parameters:

mixed   $column   Column name (string) or index (int) starting with 1 (if ResultSet::FETCHMODE_NUM was used).
string   $format   Date formatter for use w/ strftime() or date() (it will choose based on examination of format string) If format is NULL, then the integer unix timestamp will be returned (no formatting performed).

[ Top ]

method getFloat [line 89]

float getFloat( mixed $paramIndex)



Tags:

access:  public


Parameters:

mixed   $paramIndex   Column name (string) or index (int).

[ Top ]

method getInt [line 95]

int getInt( mixed $paramIndex)



Tags:

access:  public


Parameters:

mixed   $paramIndex   Column name (string) or index (int).

[ Top ]

method getString [line 101]

string getString( mixed $paramIndex)



Tags:

access:  public


Parameters:

mixed   $paramIndex   Column name (string) or index (int).

[ Top ]

method getTime [line 116]

mixed getTime( mixed $column, [string $format = '%X'])

Return a formatted time.

The default format for times returned is preferred (in your locale, as specified using setlocale()) format w/o date (i.e. strftime("%X", $val)). Override this by specifying a format second parameter. You can also specify a date()-style formatter; if you do, make sure there are no "%" symbols in your format string.




Tags:

return:  Formatted time, or integer unix timestamp (using today's date) if $format was null.
access:  public
throws:  SQLException - If the column specified is not a valid key in current field array.


Parameters:

mixed   $column   Column name (string) or index (int) starting with 1 (if ResultSet::FETCHMODE_NUM was used).
string   $format   Date formatter for use w/ strftime() or date() (it will choose based on examination of format string) If format is NULL, then the integer unix timestamp will be returned (no formatting performed).

[ Top ]

method getTimestamp [line 132]

mixed getTimestamp( mixed $column, [string $format = 'Y-m-d H:i:s'])

Return a formatted timestamp.

The default format for timestamp is ISO standard YYYY-MM-DD HH:MM:SS (i.e. date('Y-m-d H:i:s', $val). Override this by specifying a format second parameter. You can also specify a strftime()-style formatter.

Hint: if you want to get the unix timestamp use the "U" formatter string.




Tags:

return:  Formatted timestamp, or integer unix timestamp (if $format was null)
access:  public
throws:  SQLException - If the column specified is not a valid key in current field array.


Parameters:

mixed   $column   Column name (string) or index (int) starting with 1 (if ResultSet::FETCHMODE_NUM was used).
string   $format   Date formatter for use w/ strftime() or date() (it will choose based on examination of format string) If format is NULL, then the integer unix timestamp will be returned (no formatting performed).

[ Top ]

method registerOutParameter [line 38]

void registerOutParameter( string $paramIndex, int $sqlType)

Register a parameter as an output param.



Tags:

access:  public


Parameters:

string   $paramIndex   The stored procedure param name (e.g. @val1).
int   $sqlType   The type of the parameter (e.g. Type::BIT) .

[ Top ]

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