PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of PreparableInterface.php

Part of the Joomla Framework Database Package

Copyright:	Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
License:	GNU General Public License version 2 or later; see LICENSE
File Size:	72 lines (3 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

PreparableInterface:: (3 methods):
  bind()
  unbind()
  getBounded()

Interface: PreparableInterface - X-Ref

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.

bind($key, &$value, $dataType = ParameterType::STRING, $length = 0, $driverOptions = []) X-Ref

Method to add a variable to an internal array that will be bound to a prepared SQL statement before query execution.

param: array|string|integer  $key            The key that will be used in your SQL query to reference the value. Usually of
param: mixed                 $value          The value that will be bound. It can be an array, in this case it has to be
param: array|string          $dataType       Constant corresponding to a SQL datatype. It can be an array, in this case it
param: integer               $length         The length of the variable. Usually required for OUTPUT parameters.
param: array                 $driverOptions  Optional driver options to be used.
return: $this

unbind($key) X-Ref

Method to unbind a bound variable.

param: array|string|integer $key The key or array of keys to unbind.
return: $this

getBounded($key = null) X-Ref

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

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/vendor/joomla/database/src/Query/ -> PreparableInterface.php (summary)

Defines 1 class