Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JDatabaseQueryOracle
+ Graphe d'héritage de JDatabaseQueryOracle:
+ Graphe de collaboration de JDatabaseQueryOracle:

Liste de tous les membres

Fonctions membres publiques

 bind ($key=null, &$value=null, $dataType=PDO::PARAM_STR, $length=0, $driverOptions=array())
getBounded ($key=null)
 clear ($clause=null)
 processLimit ($query, $limit, $offset=0)
 setLimit ($limit=0, $offset=0)

Attributs protégés

 $offset
 $limit
 $bounded = array()

Description détaillée

Définition à la ligne 19 du fichier oracle.php.


Documentation des fonctions membres

JDatabaseQueryOracle::bind (   $key = null,
$value = null,
  $dataType = PDO::PARAM_STR,
  $length = 0,
  $driverOptions = array() 
)

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ètres:
string | integer$keyThe key that will be used in your SQL query to reference the value. Usually of the form ':key', but can also be an integer.
mixed&$valueThe value that will be bound. The value is passed by reference to support output parameters such as those possible with stored procedures.
integer$dataTypeConstant corresponding to a SQL datatype.
integer$lengthThe length of the variable. Usually required for OUTPUT parameters.
array$driverOptionsOptional driver options to be used.
Renvoie:
JDatabaseQueryOracle
Depuis:
12.1

Implémente JDatabaseQueryPreparable.

Définition à la ligne 55 du fichier oracle.php.

{
// Case 1: Empty Key (reset $bounded array)
if (empty($key))
{
$this->bounded = array();
return $this;
}
// Case 2: Key Provided, null value (unset key from $bounded array)
if (is_null($value))
{
if (isset($this->bounded[$key]))
{
unset($this->bounded[$key]);
}
return $this;
}
$obj = new stdClass;
$obj->value = &$value;
$obj->dataType = $dataType;
$obj->length = $length;
$obj->driverOptions = $driverOptions;
// Case 3: Simply add the Key/Value into the bounded array
$this->bounded[$key] = $obj;
return $this;
}
JDatabaseQueryOracle::clear (   $clause = null)

Clear data from the query or a specific clause of the query.

Paramètres:
string$clauseOptionally, the name of the clause to clear, or nothing to clear the whole query.
Renvoie:
JDatabaseQueryOracle Returns this object to allow chaining.
Depuis:
12.1

Réimplémentée à partir de JDatabaseQuery.

Définition à la ligne 123 du fichier oracle.php.

{
switch ($clause)
{
case null:
$this->bounded = array();
break;
}
parent::clear($clause);
return $this;
}
& JDatabaseQueryOracle::getBounded (   $key = null)

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ètres:
mixed$keyThe bounded variable key to retrieve.
Renvoie:
mixed
Depuis:
12.1

Implémente JDatabaseQueryPreparable.

Définition à la ligne 99 du fichier oracle.php.

{
if (empty($key))
{
}
else
{
if (isset($this->bounded[$key]))
{
return $this->bounded[$key];
}
}
}
JDatabaseQueryOracle::processLimit (   $query,
  $limit,
  $offset = 0 
)

Method to modify a query already in string format with the needed additions to make the query limited to a particular number of results, or start at a particular offset. This method is used automatically by the __toString() method if it detects that the query implements the JDatabaseQueryLimitable interface.

Paramètres:
string$queryThe query in string format
integer$limitThe limit for the result set
integer$offsetThe offset for the result set
Renvoie:
string
Depuis:
12.1

Implémente JDatabaseQueryLimitable.

Définition à la ligne 152 du fichier oracle.php.

{
// Check if we need to mangle the query.
if ($limit || $offset)
{
$query = "SELECT joomla2.*
FROM (
SELECT joomla1.*, ROWNUM AS joomla_db_rownum
FROM (
" . $query . "
) joomla1
) joomla2";
// Check if the limit value is greater than zero.
if ($limit > 0)
{
$query .= ' WHERE joomla2.joomla_db_rownum BETWEEN ' . ($offset + 1) . ' AND ' . ($offset + $limit);
}
else
{
// Check if there is an offset and then use this.
if ($offset)
{
$query .= ' WHERE joomla2.joomla_db_rownum > ' . ($offset + 1);
}
}
}
return $query;
}
JDatabaseQueryOracle::setLimit (   $limit = 0,
  $offset = 0 
)

Sets the offset and limit for the result set, if the database driver supports it.

Usage: $query->setLimit(100, 0); (retrieve 100 rows, starting at first record) $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th record)

Paramètres:
integer$limitThe limit for the result set
integer$offsetThe offset for the result set
Renvoie:
JDatabaseQueryOracle Returns this object to allow chaining.
Depuis:
12.1

Implémente JDatabaseQueryLimitable.

Définition à la ligne 197 du fichier oracle.php.

{
$this->limit = (int) $limit;
$this->offset = (int) $offset;
return $this;
}

Documentation des données membres

JDatabaseQueryOracle::$bounded = array()
protected

Définition à la ligne 37 du fichier oracle.php.

JDatabaseQueryOracle::$limit
protected

Définition à la ligne 31 du fichier oracle.php.

JDatabaseQueryOracle::$offset
protected

Définition à la ligne 25 du fichier oracle.php.


La documentation de cette classe a été générée à partir du fichier suivant :