54 lines
2.0 KiB
PHP
54 lines
2.0 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* @package Joomla.Platform
|
||
|
|
* @subpackage Database
|
||
|
|
*
|
||
|
|
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
|
||
|
|
* @license GNU General Public License version 2 or later; see LICENSE
|
||
|
|
*/
|
||
|
|
|
||
|
|
defined('JPATH_PLATFORM') or die;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Joomla Database Query Preparable Interface.
|
||
|
|
* Adds bind/unbind methods as well as a getBounded() method
|
||
|
|
* to retrieve the stored bounded variables on demand prior to
|
||
|
|
* query execution.
|
||
|
|
*
|
||
|
|
* @package Joomla.Platform
|
||
|
|
* @subpackage Database
|
||
|
|
* @since 12.1
|
||
|
|
*/
|
||
|
|
interface JDatabaseQueryPreparable
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Method to add a variable to an internal array that will be bound to a prepared SQL statement before query execution. Also
|
||
|
|
* removes a variable that has been bounded from the internal bounded array when the passed in value is null.
|
||
|
|
*
|
||
|
|
* @param string|integer $key The key that will be used in your SQL query to reference the value. Usually of
|
||
|
|
* the form ':key', but can also be an integer.
|
||
|
|
* @param mixed &$value The value that will be bound. The value is passed by reference to support output
|
||
|
|
* parameters such as those possible with stored procedures.
|
||
|
|
* @param integer $dataType Constant corresponding to a SQL datatype.
|
||
|
|
* @param integer $length The length of the variable. Usually required for OUTPUT parameters.
|
||
|
|
* @param array $driverOptions Optional driver options to be used.
|
||
|
|
*
|
||
|
|
* @return JDatabaseQuery
|
||
|
|
*
|
||
|
|
* @since 12.1
|
||
|
|
*/
|
||
|
|
public function bind($key = null, &$value = null, $dataType = PDO::PARAM_STR, $length = 0, $driverOptions = array());
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieves the bound parameters array when key is null and returns it by reference. If a key is provided then that item is
|
||
|
|
* returned.
|
||
|
|
*
|
||
|
|
* @param mixed $key The bounded variable key to retrieve.
|
||
|
|
*
|
||
|
|
* @return mixed
|
||
|
|
*
|
||
|
|
* @since 12.1
|
||
|
|
*/
|
||
|
|
public function &getBounded($key = null);
|
||
|
|
}
|