1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Database
  7. \
  8. Query
  9. \
  10. AlterableInterface

AlterableInterface

interface AlterableInterface (View source)

Interface for a query that can be manipulated via an alter hook.

Methods

$this
addTag($tag)

Adds a tag to a query.

true
hasTag($tag)

Determines if a given query has a given tag.

true
hasAllTags()

Determines if a given query has all specified tags.

true
hasAnyTag()

Determines if a given query has any specified tag.

$this
addMetaData($key, $object)

Adds additional metadata to the query.

The
getMetaData($key)

Retrieves a given piece of metadata.

Details

at line 25
$this addTag($tag)

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

$this

The called object.

at line 36
true hasTag($tag)

Determines if a given query has a given tag.

Parameters

$tag

The tag to check.

Return Value

true

if this query has been marked with this tag, FALSE otherwise.

at line 50
true hasAllTags()

Determines if a given query has all specified tags.

Each tag to check should be supplied as a separate argument.

Restore PHPDoc of variadic argument in Drupal 8.8, see https://www.drupal.org/project/drupal/issues/3029729

Return Value

true

if this query has been marked with all specified tags, FALSE otherwise.

at line 64
true hasAnyTag()

Determines if a given query has any specified tag.

Each tag to check should be supplied as a separate argument.

Restore PHPDoc of variadic argument in Drupal 8.8, see https://www.drupal.org/project/drupal/issues/3029729

Return Value

true

if this query has been marked with at least one of the specified tags, FALSE otherwise.

at line 82
$this addMetaData($key, $object)

Adds additional metadata to the query.

Often, a query may need to provide additional contextual data to alter hooks. Alter hooks may then use that information to decide if and how to take action.

Parameters

$key

The unique identifier for this piece of metadata. Must be a string that follows the same rules as any other PHP identifier.
$object

The additional data to add to the query. May be any valid PHP variable.

Return Value

$this

The called object.

at line 93
The getMetaData($key)

Retrieves a given piece of metadata.

Parameters

$key

The unique identifier for the piece of metadata to retrieve.

Return Value

The

previously attached metadata object, or NULL if one doesn't exist.