Spaces:
Sleeping
Sleeping
File size: 6,190 Bytes
07c3cdd | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | <?php
/*
* $Id: CallableStatement.php,v 1.7 2004/03/20 04:16:49 hlellelid Exp $
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information please see
* <http://creole.phpdb.org>.
*/
require_once 'creole/PreparedStatement.php';
/**
* Interface for callable statements.
*
* @author Hans Lellelid <hans@xmpl.org>
* @version $Revision: 1.7 $
* @package creole
*/
interface CallableStatement extends PreparedStatement {
/**
* Register a parameter as an output param.
* @param string $paramIndex The stored procedure param name (e.g. @val1).
* @param int $sqlType The type of the parameter (e.g. Type::BIT)
* @param int $maxLength The maximum expected length (size) of output parameter.
*/
public function registerOutParameter($paramIndex, $sqlType, $maxLength = null);
/**
*
* @param mixed $paramIndex Parameter name (e.g. "@var1").
* @return array
* @throws SQLException if $paramIndex was not bound as output variable.
*/
public function getArray($paramIndex);
/**
*
* @param mixed $paramIndex Parameter name (e.g. "@var1").
* @return boolean
* @throws SQLException if $paramIndex was not bound as output variable.
*/
public function getBoolean($paramIndex);
/**
*
* @param mixed $paramIndex Parameter name (e.g. "@var1").
* @return Blob blob object
* @throws SQLException if $paramIndex was not bound as output variable.
*/
public function getBlob($paramIndex);
/**
* @param mixed $paramIndex Column name (string) or index (int).
* @return Clob clob object.
*/
public function getClob($paramIndex);
/**
* 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.
*
* @param mixed $column Column name (string) or index (int) starting with 1 (if ResultSet::FETCHMODE_NUM was used).
* @param 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).
* @return mixed Formatted date, or integer unix timestamp (using 00:00:00 for time) if $format was null.
* @throws SQLException - If the column specified is not a valid key in current field array.
*/
public function getDate($column, $format = '%x');
/**
* @param mixed $paramIndex Column name (string) or index (int).
* @return float
*/
public function getFloat($paramIndex);
/**
* @param mixed $paramIndex Column name (string) or index (int).
* @return int
*/
public function getInt($paramIndex);
/**
* @param mixed $paramIndex Column name (string) or index (int).
* @return string
*/
public function getString($paramIndex);
/**
* 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.
*
* @param mixed $column Column name (string) or index (int) starting with 1 (if ResultSet::FETCHMODE_NUM was used).
* @param 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).
* @return mixed Formatted time, or integer unix timestamp (using today's date) if $format was null.
* @throws SQLException - If the column specified is not a valid key in current field array.
*/
public function getTime($column, $format = '%X');
/**
* 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.
*
* @param mixed $column Column name (string) or index (int) starting with 1 (if ResultSet::FETCHMODE_NUM was used).
* @param 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).
* @return mixed Formatted timestamp, or integer unix timestamp (if $format was null)
* @throws SQLException - If the column specified is not a valid key in current field array.
*/
public function getTimestamp($column, $format = 'Y-m-d H:i:s');
}
|