first commit

administrator/components/com_akeebabackup/engine/Driver/Query/Preparable.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * Akeeba Engine
+ *
+ * @package   akeebaengine
+ * @copyright Copyright (c)2006-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
+ * @license   GNU General Public License version 3, or later
+ */
+
+namespace Akeeba\Engine\Driver\Query;
+
+defined('AKEEBAENGINE') || die();
+
+use PDO;
+
+/**
+ * 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.
+ *
+ * @since  1.0
+ *
+ * @codeCoverageIgnore
+ */
+interface Preparable
+{
+	/**
+	 * 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  Preparable
+	 *
+	 * @since   1.0
+	 */
+	public function bind($key = null, &$value = null, $dataType = PDO::PARAM_STR, $length = 0, $driverOptions = []);
+
+	/**
+	 * 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   1.0
+	 */
+	public function &getBounded($key = null);
+}