Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Référence de la classe FOFDatabaseQueryPostgresql
+ Graphe d'héritage de FOFDatabaseQueryPostgresql:

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)
 
 regexp ($value)
 
 Rand ()
 
- Fonctions membres publiques hérités de FOFDatabaseQuery
 __call ($method, $args)
 
 __construct (FOFDatabaseDriver $db=null)
 
 __toString ()
 
 __get ($name)
 
 call ($columns)
 
 castAsChar ($value)
 
 charLength ($field, $operator=null, $condition=null)
 
 clear ($clause=null)
 
 columns ($columns)
 
 concatenate ($values, $separator=null)
 
 currentTimestamp ()
 
 dateFormat ()
 
 dump ()
 
 delete ($table=null)
 
 escape ($text, $extra=false)
 
 exec ($columns)
 
 from ($tables, $subQueryAlias=null)
 
 year ($date)
 
 month ($date)
 
 day ($date)
 
 hour ($date)
 
 minute ($date)
 
 second ($date)
 
 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)
 
 dateAdd ($date, $interval, $datePart)
 
 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 hérités de FOFDatabaseQuery
 $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

Query Building Class.

Depuis
11.3

Documentation des fonctions membres

◆ __toString()

__toString ( )

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

Renvoie
string The completed query.
Depuis
11.3

Références $query.

◆ castAsChar()

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éférences $value.

◆ clear()

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
FOFDatabaseQueryPostgresql Returns this object to allow chaining.
Depuis
11.3

Références null.

◆ concatenate()

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éférences $separator.

◆ currentTimestamp()

currentTimestamp ( )

Gets the current date and time.

Renvoie
string Return string used in query to obtain
Depuis
11.3

◆ dateAdd()

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éférences $date.

◆ day()

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éférences $date.

◆ forShare()

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
FOFDatabaseQueryPostgresql FOR SHARE query element
Depuis
11.3

◆ forUpdate()

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
FOFDatabaseQueryPostgresql FOR UPDATE query element
Depuis
11.3

◆ hour()

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éférences $date.

◆ limit()

limit (   $limit = 0)

Set the LIMIT clause to the query

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

Références $limit.

◆ minute()

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éférences $date.

◆ month()

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éférences $date.

◆ noWait()

noWait ( )

Sets the NOWAIT lock on select's output row

Renvoie
FOFDatabaseQueryPostgresql NO WAIT query element
Depuis
11.3

Références null.

◆ offset()

offset (   $offset = 0)

Set the OFFSET clause to the query

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

Références $offset.

◆ processLimit()

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.

Références $limit, $offset, et $query.

◆ Rand()

Rand ( )

Return correct rand() function for Postgresql.

Ensure that the rand() function is Postgresql compatible.

Usage: $query->Rand();

Renvoie
string The correct rand function.
Depuis
3.5

◆ regexp()

regexp (   $value)

Return correct regexp operator for Postgresql.

Ensure that the regexp operator is Postgresql compatible.

Usage: $query->where('field ' . $query->regexp($search));

Paramètres
string$valueThe regex pattern.
Renvoie
string Returns the regex operator.
Depuis
11.3

Références $value.

◆ returning()

returning (   $pkCol)

Add the RETURNING element to INSERT INTO statement.

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

◆ second()

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éférences $date.

◆ setLimit()

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
FOFDatabaseQueryPostgresql Returns this object to allow chaining.
Depuis
12.1

Implémente JDatabaseQueryLimitable.

Références $limit, et $offset.

◆ year()

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éférences $date.

Documentation des champs

◆ $forShare

$forShare = null
protected

◆ $forUpdate

$forUpdate = null
protected

◆ $limit

$limit = null
protected

◆ $noWait

$noWait = null
protected

◆ $offset

$offset = null
protected

◆ $returning

$returning = null
protected

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