CallableStatement Interface Reference

Inheritance diagram for CallableStatement:

PreparedStatement MSSQLCallableStatement

List of all members.

Public Member Functions

 registerOutParameter ($paramIndex, $sqlType, $maxLength=null)
 Register a parameter as an output param.
 getArray ($paramIndex)
 getBoolean ($paramIndex)
 getBlob ($paramIndex)
 getClob ($paramIndex)
 getDate ($column, $format= '%x')
 Return a formatted date.
 getFloat ($paramIndex)
 getInt ($paramIndex)
 getString ($paramIndex)
 getTime ($column, $format= '%X')
 Return a formatted time.
 getTimestamp ($column, $format= 'Y-m-d H:i:s')
 Return a formatted timestamp.


Detailed Description

Definition at line 31 of file CallableStatement.php.


Member Function Documentation

CallableStatement::getArray ( paramIndex  ) 

Parameters:
mixed $paramIndex Parameter name (e.g. "@var1").
Returns:
array
Exceptions:
SQLException if $paramIndex was not bound as output variable.

Implemented in MSSQLCallableStatement.

CallableStatement::getBlob ( paramIndex  ) 

Parameters:
mixed $paramIndex Parameter name (e.g. "@var1").
Returns:
Blob blob object
Exceptions:
SQLException if $paramIndex was not bound as output variable.

Implemented in MSSQLCallableStatement.

CallableStatement::getBoolean ( paramIndex  ) 

Parameters:
mixed $paramIndex Parameter name (e.g. "@var1").
Returns:
boolean
Exceptions:
SQLException if $paramIndex was not bound as output variable.

Implemented in MSSQLCallableStatement.

CallableStatement::getClob ( paramIndex  ) 

Parameters:
mixed $paramIndex Column name (string) or index (int).
Returns:
Clob clob object.

Implemented in MSSQLCallableStatement.

CallableStatement::getDate ( column,
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.

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).
Returns:
mixed Formatted date, or integer unix timestamp (using 00:00:00 for time) if $format was null.
Exceptions:
SQLException - If the column specified is not a valid key in current field array.

Implemented in MSSQLCallableStatement.

CallableStatement::getFloat ( paramIndex  ) 

Parameters:
mixed $paramIndex Column name (string) or index (int).
Returns:
float

Implemented in MSSQLCallableStatement.

CallableStatement::getInt ( paramIndex  ) 

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

Implemented in MSSQLCallableStatement.

CallableStatement::getString ( paramIndex  ) 

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

Implemented in MSSQLCallableStatement.

CallableStatement::getTime ( column,
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.

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).
Returns:
mixed Formatted time, or integer unix timestamp (using today's date) if $format was null.
Exceptions:
SQLException - If the column specified is not a valid key in current field array.

Implemented in MSSQLCallableStatement.

CallableStatement::getTimestamp ( column,
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.

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).
Returns:
mixed Formatted timestamp, or integer unix timestamp (if $format was null)
Exceptions:
SQLException - If the column specified is not a valid key in current field array.

Implemented in MSSQLCallableStatement.

CallableStatement::registerOutParameter ( paramIndex,
sqlType,
maxLength = null 
)

Register a parameter as an output param.

Parameters:
string $paramIndex The stored procedure param name (e.g. ).
int $sqlType The type of the parameter (e.g. Type::BIT)
int $maxLength The maximum expected length (size) of output parameter.

Implemented in MSSQLCallableStatement.


The documentation for this interface was generated from the following file:

Generated on Wed May 6 23:10:49 2009 for fareofficelib by  doxygen 1.5.8