1 <?php
2 /**
3 * @package FrameworkOnFramework
4 * @subpackage database
5 * @copyright Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
6 * @license GNU General Public License version 2 or later; see LICENSE.txt
7 *
8 * This file is adapted from the Joomla! Platform. It is used to iterate a database cursor returning FOFTable objects
9 * instead of plain stdClass objects
10 */
11
12 // Protect from unauthorized access
13 defined('FOF_INCLUDED') or die;
14
15 if (!interface_exists('JDatabaseQueryPreparable'))
16 {
17 /**
18 * Joomla Database Query Preparable Interface.
19 * Adds bind/unbind methods as well as a getBounded() method
20 * to retrieve the stored bounded variables on demand prior to
21 * query execution.
22 *
23 * @since 12.1
24 */
25 interface JDatabaseQueryPreparable
26 {
27 /**
28 * Method to add a variable to an internal array that will be bound to a prepared SQL statement before query execution. Also
29 * removes a variable that has been bounded from the internal bounded array when the passed in value is null.
30 *
31 * @param string|integer $key The key that will be used in your SQL query to reference the value. Usually of
32 * the form ':key', but can also be an integer.
33 * @param mixed &$value The value that will be bound. The value is passed by reference to support output
34 * parameters such as those possible with stored procedures.
35 * @param integer $dataType Constant corresponding to a SQL datatype.
36 * @param integer $length The length of the variable. Usually required for OUTPUT parameters.
37 * @param array $driverOptions Optional driver options to be used.
38 *
39 * @return FOFDatabaseQuery
40 *
41 * @since 12.1
42 */
43 public function bind($key = null, &$value = null, $dataType = PDO::PARAM_STR, $length = 0, $driverOptions = array());
44
45 /**
46 * Retrieves the bound parameters array when key is null and returns it by reference. If a key is provided then that item is
47 * returned.
48 *
49 * @param mixed $key The bounded variable key to retrieve.
50 *
51 * @return mixed
52 *
53 * @since 12.1
54 */
55 public function &getBounded($key = null);
56 }
57 }
58
59 interface FOFDatabaseQueryPreparable extends JDatabaseQueryPreparable
60 {
61
62 }