Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Attributs protégés
Référence de la classe JDatabaseQueryPostgresql
+ Graphe d'héritage de JDatabaseQueryPostgresql:
+ Graphe de collaboration de JDatabaseQueryPostgresql:

Liste de tous les membres

Fonctions membres publiques

 __toString ()
 clear ($clause=null)
 castAsChar ($value)
 concatenate ($values, $separator=null)
 currentTimestamp ()
 forUpdate ($table_name, $glue= ',')
 forShare ($table_name, $glue= ',')
 year ($date)
 month ($date)
 day ($date)
 hour ($date)
 minute ($date)
 second ($date)
 noWait ()
 limit ($limit=0)
 offset ($offset=0)
 returning ($pkCol)
 setLimit ($limit=0, $offset=0)
 processLimit ($query, $limit, $offset=0)
 dateAdd ($date, $interval, $datePart)
- Fonctions membres publiques inherited from JDatabaseQuery
 __call ($method, $args)
 __construct (JDatabaseDriver $db=null)
 __get ($name)
 call ($columns)
 charLength ($field, $operator=null, $condition=null)
 columns ($columns)
 dateFormat ()
 dump ()
 delete ($table=null)
 escape ($text, $extra=false)
 exec ($columns)
 from ($tables, $subQueryAlias=null)
 group ($columns)
 having ($conditions, $glue= 'AND')
 innerJoin ($condition)
 insert ($table, $incrementField=false)
 join ($type, $conditions)
 leftJoin ($condition)
 length ($value)
 nullDate ($quoted=true)
 order ($columns)
 outerJoin ($condition)
 quote ($text, $escape=true)
 quoteName ($name, $as=null)
 rightJoin ($condition)
 select ($columns)
 set ($conditions, $glue= ',')
 setQuery ($sql)
 update ($table)
 values ($values)
 where ($conditions, $glue= 'AND')
 __clone ()
 union ($query, $distinct=false, $glue= '')
 unionDistinct ($query, $glue= '')
 format ($format)
 unionAll ($query, $distinct=false, $glue= '')

Attributs protégés

 $forUpdate = null
 $forShare = null
 $noWait = null
 $limit = null
 $offset = null
 $returning = null
- Attributs protégés inherited from JDatabaseQuery
 $db = null
 $sql = null
 $type = ''
 $element = null
 $select = null
 $delete = null
 $update = null
 $insert = null
 $from = null
 $join = null
 $set = null
 $where = null
 $group = null
 $having = null
 $columns = null
 $values = null
 $order = null
 $autoIncrementField = null
 $call = null
 $exec = null
 $union = null
 $unionAll = null

Description détaillée

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

Documentation des fonctions membres

JDatabaseQueryPostgresql::__toString ( )

Magic function to convert the query to a string, only for postgresql specific query

Renvoie:
string The completed query.
Depuis:
11.3

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

Définition à la ligne 64 du fichier postgresql.php.

{
$query = '';
switch ($this->type)
{
case 'select':
$query .= (string) $this->select;
$query .= (string) $this->from;
if ($this->join)
{
// Special case for joins
foreach ($this->join as $join)
{
$query .= (string) $join;
}
}
if ($this->where)
{
$query .= (string) $this->where;
}
if ($this->group)
{
$query .= (string) $this->group;
}
if ($this->having)
{
$query .= (string) $this->having;
}
if ($this->order)
{
$query .= (string) $this->order;
}
if ($this->forUpdate)
{
$query .= (string) $this->forUpdate;
}
else
{
if ($this->forShare)
{
$query .= (string) $this->forShare;
}
}
if ($this->noWait)
{
$query .= (string) $this->noWait;
}
break;
case 'update':
$query .= (string) $this->update;
$query .= (string) $this->set;
if ($this->join)
{
$onWord = ' ON ';
// Workaround for special case of JOIN with UPDATE
foreach ($this->join as $join)
{
$joinElem = $join->getElements();
$joinArray = explode($onWord, $joinElem[0]);
$this->from($joinArray[0]);
$this->where($joinArray[1]);
}
$query .= (string) $this->from;
}
if ($this->where)
{
$query .= (string) $this->where;
}
break;
case 'insert':
$query .= (string) $this->insert;
if ($this->values)
{
if ($this->columns)
{
$query .= (string) $this->columns;
}
$elements = $this->values->getElements();
if (!($elements[0] instanceof $this))
{
$query .= ' VALUES ';
}
$query .= (string) $this->values;
if ($this->returning)
{
$query .= (string) $this->returning;
}
}
break;
default:
$query = parent::__toString();
break;
}
if ($this instanceof JDatabaseQueryLimitable)
{
$query = $this->processLimit($query, $this->limit, $this->offset);
}
return $query;
}
JDatabaseQueryPostgresql::castAsChar (   $value)

Casts a value to a char.

Ensure that the value is properly quoted before passing to the method.

Usage: $query->select($query->castAsChar('a'));

Paramètres:
string$valueThe value to cast as a char.
Renvoie:
string Returns the cast value.
Depuis:
11.3

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

Définition à la ligne 273 du fichier postgresql.php.

{
return $value . '::text';
}
JDatabaseQueryPostgresql::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:
JDatabaseQueryPostgresql Returns this object to allow chaining.
Depuis:
11.3

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

Définition à la ligne 200 du fichier postgresql.php.

{
switch ($clause)
{
case 'limit':
$this->limit = null;
break;
case 'offset':
$this->offset = null;
break;
case 'forUpdate':
$this->forUpdate = null;
break;
case 'forShare':
$this->forShare = null;
break;
case 'noWait':
$this->noWait = null;
break;
case 'returning':
$this->returning = null;
break;
case 'select':
case 'update':
case 'delete':
case 'insert':
case 'from':
case 'join':
case 'set':
case 'where':
case 'group':
case 'having':
case 'order':
case 'columns':
case 'values':
parent::clear($clause);
break;
default:
$this->type = null;
$this->limit = null;
$this->offset = null;
$this->forUpdate = null;
$this->forShare = null;
$this->noWait = null;
$this->returning = null;
parent::clear($clause);
break;
}
return $this;
}
JDatabaseQueryPostgresql::concatenate (   $values,
  $separator = null 
)

Concatenates an array of column names or values.

Usage: $query->select($query->concatenate(array('a', 'b')));

Paramètres:
array$valuesAn array of values to concatenate.
string$separatorAs separator to place between each value.
Renvoie:
string The concatenated values.
Depuis:
11.3

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

Définition à la ligne 291 du fichier postgresql.php.

{
if ($separator)
{
return implode(' || ' . $this->quote($separator) . ' || ', $values);
}
else
{
return implode(' || ', $values);
}
}
JDatabaseQueryPostgresql::currentTimestamp ( )

Gets the current date and time.

Renvoie:
string Return string used in query to obtain
Depuis:
11.3

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

Définition à la ligne 310 du fichier postgresql.php.

{
return 'NOW()';
}
JDatabaseQueryPostgresql::dateAdd (   $date,
  $interval,
  $datePart 
)

Add to the current date and time in Postgresql. Usage: $query->select($query->dateAdd()); Prefixing the interval with a - (negative sign) will cause subtraction to be used.

Paramètres:
datetime$dateThe date to add to
string$intervalThe string representation of the appropriate number of units
string$datePartThe part of the date to perform the addition on
Renvoie:
string The string with the appropriate sql for addition of dates
Depuis:
13.1
Note:
Not all drivers support all units. Check appropriate references http://www.postgresql.org/docs/9.0/static/functions-datetime.html.

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

Définition à la ligne 613 du fichier postgresql.php.

{
if (substr($interval, 0, 1) != '-')
{
return "timestamp '" . $date . "' + interval '" . $interval . " " . $datePart . "'";
}
else
{
return "timestamp '" . $date . "' - interval '" . ltrim($interval, '-') . " " . $datePart . "'";
}
}
JDatabaseQueryPostgresql::day (   $date)

Used to get a string to extract day from date column.

Usage: $query->select($query->day($query->quoteName('dateColumn')));

Paramètres:
string$dateDate column containing day to be extracted.
Renvoie:
string Returns string to extract day from a date.
Depuis:
12.1

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

Définition à la ligne 415 du fichier postgresql.php.

{
return 'EXTRACT (DAY FROM ' . $date . ')';
}
JDatabaseQueryPostgresql::forShare (   $table_name,
  $glue = ',' 
)

Sets the FOR SHARE lock on select's output row

Paramètres:
string$table_nameThe table to lock
string$glueThe glue by which to join the conditions. Defaults to ',' .
Renvoie:
JDatabaseQueryPostgresql FOR SHARE query element
Depuis:
11.3

Définition à la ligne 352 du fichier postgresql.php.

{
$this->type = 'forShare';
if (is_null($this->forShare))
{
$glue = strtoupper($glue);
$this->forShare = new JDatabaseQueryElement('FOR SHARE', 'OF ' . $table_name, "$glue ");
}
else
{
$this->forShare->append($table_name);
}
return $this;
}
JDatabaseQueryPostgresql::forUpdate (   $table_name,
  $glue = ',' 
)

Sets the FOR UPDATE lock on select's output row

Paramètres:
string$table_nameThe table to lock
string$glueThe glue by which to join the conditions. Defaults to ',' .
Renvoie:
JDatabaseQueryPostgresql FOR UPDATE query element
Depuis:
11.3

Définition à la ligne 325 du fichier postgresql.php.

{
$this->type = 'forUpdate';
if (is_null($this->forUpdate))
{
$glue = strtoupper($glue);
$this->forUpdate = new JDatabaseQueryElement('FOR UPDATE', 'OF ' . $table_name, "$glue ");
}
else
{
$this->forUpdate->append($table_name);
}
return $this;
}
JDatabaseQueryPostgresql::hour (   $date)

Used to get a string to extract hour from date column.

Usage: $query->select($query->hour($query->quoteName('dateColumn')));

Paramètres:
string$dateDate column containing hour to be extracted.
Renvoie:
string Returns string to extract hour from a date.
Depuis:
12.1

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

Définition à la ligne 432 du fichier postgresql.php.

{
return 'EXTRACT (HOUR FROM ' . $date . ')';
}
JDatabaseQueryPostgresql::limit (   $limit = 0)

Set the LIMIT clause to the query

Paramètres:
integer$limitAn int of how many row will be returned
Renvoie:
JDatabaseQueryPostgresql Returns this object to allow chaining.
Depuis:
11.3

Définition à la ligne 499 du fichier postgresql.php.

{
if (is_null($this->limit))
{
$this->limit = new JDatabaseQueryElement('LIMIT', (int) $limit);
}
return $this;
}
JDatabaseQueryPostgresql::minute (   $date)

Used to get a string to extract minute from date column.

Usage: $query->select($query->minute($query->quoteName('dateColumn')));

Paramètres:
string$dateDate column containing minute to be extracted.
Renvoie:
string Returns string to extract minute from a date.
Depuis:
12.1

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

Définition à la ligne 449 du fichier postgresql.php.

{
return 'EXTRACT (MINUTE FROM ' . $date . ')';
}
JDatabaseQueryPostgresql::month (   $date)

Used to get a string to extract month from date column.

Usage: $query->select($query->month($query->quoteName('dateColumn')));

Paramètres:
string$dateDate column containing month to be extracted.
Renvoie:
string Returns string to extract month from a date.
Depuis:
12.1

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

Définition à la ligne 398 du fichier postgresql.php.

{
return 'EXTRACT (MONTH FROM ' . $date . ')';
}
JDatabaseQueryPostgresql::noWait ( )

Sets the NOWAIT lock on select's output row

Renvoie:
JDatabaseQueryPostgresql NO WAIT query element
Depuis:
11.3

Définition à la ligne 478 du fichier postgresql.php.

{
$this->type = 'noWait';
if (is_null($this->noWait))
{
$this->noWait = new JDatabaseQueryElement('NOWAIT', null);
}
return $this;
}
JDatabaseQueryPostgresql::offset (   $offset = 0)

Set the OFFSET clause to the query

Paramètres:
integer$offsetAn int for skipping row
Renvoie:
JDatabaseQueryPostgresql Returns this object to allow chaining.
Depuis:
11.3

Définition à la ligne 518 du fichier postgresql.php.

{
if (is_null($this->offset))
{
$this->offset = new JDatabaseQueryElement('OFFSET', (int) $offset);
}
return $this;
}
JDatabaseQueryPostgresql::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.

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 582 du fichier postgresql.php.

{
if ($limit > 0)
{
$query .= ' LIMIT ' . $limit;
}
if ($offset > 0)
{
$query .= ' OFFSET ' . $offset;
}
return $query;
}
JDatabaseQueryPostgresql::returning (   $pkCol)

Add the RETURNING element to INSERT INTO statement.

Paramètres:
mixed$pkColThe name of the primary key column.
Renvoie:
JDatabaseQueryPostgresql Returns this object to allow chaining.
Depuis:
11.3

Définition à la ligne 537 du fichier postgresql.php.

{
if (is_null($this->returning))
{
$this->returning = new JDatabaseQueryElement('RETURNING', $pkCol);
}
return $this;
}
JDatabaseQueryPostgresql::second (   $date)

Used to get a string to extract seconds from date column.

Usage: $query->select($query->second($query->quoteName('dateColumn')));

Paramètres:
string$dateDate column containing second to be extracted.
Renvoie:
string Returns string to extract second from a date.
Depuis:
12.1

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

Définition à la ligne 466 du fichier postgresql.php.

{
return 'EXTRACT (SECOND FROM ' . $date . ')';
}
JDatabaseQueryPostgresql::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:
JDatabaseQueryPostgresql Returns this object to allow chaining.
Depuis:
12.1

Implémente JDatabaseQueryLimitable.

Définition à la ligne 561 du fichier postgresql.php.

{
$this->limit = (int) $limit;
$this->offset = (int) $offset;
return $this;
}
JDatabaseQueryPostgresql::year (   $date)

Used to get a string to extract year from date column.

Usage: $query->select($query->year($query->quoteName('dateColumn')));

Paramètres:
string$dateDate column containing year to be extracted.
Renvoie:
string Returns string to extract year from a date.
Depuis:
12.1

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

Définition à la ligne 381 du fichier postgresql.php.

{
return 'EXTRACT (YEAR FROM ' . $date . ')';
}

Documentation des données membres

JDatabaseQueryPostgresql::$forShare = null
protected

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

JDatabaseQueryPostgresql::$forUpdate = null
protected

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

JDatabaseQueryPostgresql::$limit = null
protected

Définition à la ligne 43 du fichier postgresql.php.

JDatabaseQueryPostgresql::$noWait = null
protected

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

JDatabaseQueryPostgresql::$offset = null
protected

Définition à la ligne 49 du fichier postgresql.php.

JDatabaseQueryPostgresql::$returning = null
protected

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

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