SelectQuery::addField
public function SelectQuery::addField
public SelectQuery::addField($table_alias, $field, $alias = NULL)
Adds a field to the list to be SELECTed.
Parameters
$table_alias: The name of the table from which the field comes, as an alias. Generally you will want to use the return value of join() here to ensure that it is valid.
$field: The name of the field.
$alias: The alias for this field. If not specified, one will be generated automatically based on the $table_alias and $field. The alias will be checked for uniqueness, so the requested alias may not be the alias that is assigned in all cases.
Return value
The unique alias that was assigned for this field.
Overrides SelectQueryInterface::addField
File
- includes/database/select.inc, line 1273
Class
- SelectQuery
- Query builder for SELECT statements.
Code
public function addField($table_alias, $field, $alias = NULL) { // If no alias is specified, first try the field name itself. if (empty($alias)) { $alias = $field; } // If that's already in use, try the table name and field name. if (!empty($this->fields[$alias])) { $alias = $table_alias . '_' . $field; } // If that is already used, just add a counter until we find an unused alias. $alias_candidate = $alias; $count = 2; while (!empty($this->fields[$alias_candidate])) { $alias_candidate = $alias . '_' . $count++; } $alias = $alias_candidate; $this->fields[$alias] = array( 'field' => $field, 'table' => $table_alias, 'alias' => $alias, ); return $alias; }
© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/includes!database!select.inc/function/SelectQuery::addField/7.x