public function SelectQueryExtender::addTag in Drupal 7

Adds a tag to a query.

Tags are strings that identify a query. A query may have any number of tags. Tags are used to mark a query so that alter hooks may decide if they wish to take action. Tags should be all lower-case and contain only letters, numbers, and underscore, and start with a letter. That is, they should follow the same rules as PHP identifiers in general.

Parameters

$tag: The tag to add.

Return value

QueryAlterableInterface The called object.

Overrides QueryAlterableInterface::addTag

3 calls to SelectQueryExtender::addTag()

PagerDefault::__construct in includes/pager.inc

SearchQuery::searchExpression in modules/search/search.extender.inc

Sets up the search query expression.

TableSort::__construct in includes/tablesort.inc

File

includes/database/select.inc, line 584

Class

SelectQueryExtender

The base extender class for Select queries.

Code

public function addTag($tag) {
  $this->query
    ->addTag($tag);
  return $this;
}