Commit 76aecc5d authored by Dries's avatar Dries

Issue #2064261 by StephaneQ: Correct the @var, @throws and @see statements on dbtng.

parent 7dc21953
......@@ -207,7 +207,7 @@
* @return \Drupal\Core\Database\StatementInterface
* A prepared statement object, already executed.
*
* @see DatabaseConnection::defaultOptions()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_query($query, array $args = array(), array $options = array()) {
if (empty($options['target'])) {
......@@ -239,7 +239,7 @@ function db_query($query, array $args = array(), array $options = array()) {
* @return \Drupal\Core\Database\StatementInterface
* A prepared statement object, already executed.
*
* @see DatabaseConnection::defaultOptions()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_query_range($query, $from, $count, array $args = array(), array $options = array()) {
if (empty($options['target'])) {
......@@ -269,7 +269,7 @@ function db_query_range($query, $from, $count, array $args = array(), array $opt
* @return
* The name of the temporary table.
*
* @see DatabaseConnection::defaultOptions()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_query_temporary($query, array $args = array(), array $options = array()) {
if (empty($options['target'])) {
......
......@@ -666,7 +666,7 @@ public function getDriverClass($class) {
* it may be a driver-specific subclass of SelectQuery, depending on the
* driver.
*
* @see Drupal\Core\Database\Query\Select
* @see \Drupal\Core\Database\Query\Select
*/
public function select($table, $alias = NULL, array $options = array()) {
$class = $this->getDriverClass('Select');
......@@ -682,7 +682,7 @@ public function select($table, $alias = NULL, array $options = array()) {
* @return \Drupal\Core\Database\Query\Insert
* A new Insert query object.
*
* @see Drupal\Core\Database\Query\Insert
* @see \Drupal\Core\Database\Query\Insert
*/
public function insert($table, array $options = array()) {
$class = $this->getDriverClass('Insert');
......@@ -698,7 +698,7 @@ public function insert($table, array $options = array()) {
* @return \Drupal\Core\Database\Query\Merge
* A new Merge query object.
*
* @see Drupal\Core\Database\Query\Merge
* @see \Drupal\Core\Database\Query\Merge
*/
public function merge($table, array $options = array()) {
$class = $this->getDriverClass('Merge');
......@@ -715,7 +715,7 @@ public function merge($table, array $options = array()) {
* @return \Drupal\Core\Database\Query\Update
* A new Update query object.
*
* @see Drupal\Core\Database\Query\Update
* @see \Drupal\Core\Database\Query\Update
*/
public function update($table, array $options = array()) {
$class = $this->getDriverClass('Update');
......@@ -731,7 +731,7 @@ public function update($table, array $options = array()) {
* @return \Drupal\Core\Database\Query\Delete
* A new Delete query object.
*
* @see Drupal\Core\Database\Query\Delete
* @see \Drupal\Core\Database\Query\Delete
*/
public function delete($table, array $options = array()) {
$class = $this->getDriverClass('Delete');
......@@ -747,7 +747,7 @@ public function delete($table, array $options = array()) {
* @return \Drupal\Core\Database\Query\Truncate
* A new Truncate query object.
*
* @see Drupal\Core\Database\Query\Truncate
* @see \Drupal\Core\Database\Query\Truncate
*/
public function truncate($table, array $options = array()) {
$class = $this->getDriverClass('Truncate');
......@@ -882,7 +882,7 @@ public function transactionDepth() {
* @return \Drupal\Core\Database\Transaction
* A Transaction object.
*
* @see Drupal\Core\Database\Transaction
* @see \Drupal\Core\Database\Transaction
*/
public function startTransaction($name = '') {
$class = $this->getDriverClass('Transaction');
......@@ -898,9 +898,9 @@ public function startTransaction($name = '') {
* The name of the savepoint. The default, 'drupal_transaction', will roll
* the entire transaction back.
*
* @throws Drupal\Core\Database\TransactionNoActiveException
* @throws \Drupal\Core\Database\TransactionNoActiveException
*
* @see DatabaseTransaction::rollback()
* @see \Drupal\Core\Database\Transaction::rollback()
*/
public function rollback($savepoint_name = 'drupal_transaction') {
if (!$this->supportsTransactions()) {
......@@ -949,9 +949,9 @@ public function rollback($savepoint_name = 'drupal_transaction') {
*
* If no transaction is already active, we begin a new transaction.
*
* @throws Drupal\Core\Database\TransactionNameNonUniqueException
* @throws \Drupal\Core\Database\TransactionNameNonUniqueException
*
* @see Drupal\Core\Database\Transaction
* @see \Drupal\Core\Database\Transaction
*/
public function pushTransaction($name) {
if (!$this->supportsTransactions()) {
......@@ -981,10 +981,10 @@ public function pushTransaction($name) {
* @param $name
* The name of the savepoint
*
* @throws Drupal\Core\Database\TransactionNoActiveException
* @throws Drupal\Core\Database\TransactionCommitFailedException
* @throws \Drupal\Core\Database\TransactionNoActiveException
* @throws \Drupal\Core\Database\TransactionCommitFailedException
*
* @see DatabaseTransaction
* @see \Drupal\Core\Database\Transaction
*/
public function popTransaction($name) {
if (!$this->supportsTransactions()) {
......@@ -1157,7 +1157,7 @@ public function supportsTransactionalDDL() {
* @return
* The extra handling directives for the specified operator, or NULL.
*
* @see Drupal\Core\Database\Query\Condition::compile()
* @see \Drupal\Core\Database\Query\Condition::compile()
*/
abstract public function mapConditionOperator($operator);
......@@ -1169,9 +1169,9 @@ public function supportsTransactionalDDL() {
* A direct commit bypasses all of the safety checks we've built on top of
* PDO's transaction routines.
*
* @throws Drupal\Core\Database\TransactionExplicitCommitNotAllowedException
* @throws \Drupal\Core\Database\TransactionExplicitCommitNotAllowedException
*
* @see Drupal\Core\Database\Transaction
* @see \Drupal\Core\Database\Transaction
*/
public function commit() {
throw new TransactionExplicitCommitNotAllowedException();
......
......@@ -95,7 +95,7 @@ abstract class Database {
* methods than the few exposed through the Database class, so in some
* cases it may be desirable to access it directly.
*
* @see Drupal\Core\Database\Log
* @see \Drupal\Core\Database\Log
*/
final public static function startLog($logging_key, $key = 'default') {
if (empty(self::$logs[$key])) {
......@@ -130,7 +130,7 @@ abstract class Database {
* @return array
* The query log for the specified logging key and connection.
*
* @see Drupal\Core\Database\Log
* @see \Drupal\Core\Database\Log
*/
final public static function getLog($logging_key, $key = 'default') {
if (empty(self::$logs[$key])) {
......@@ -356,8 +356,8 @@ public static function addConnectionInfo($key, $target, $info) {
* @param $target
* The database target to open.
*
* @throws Drupal\Core\Database\ConnectionNotDefinedException
* @throws Drupal\Core\Database\DriverNotSpecifiedException
* @throws \Drupal\Core\Database\ConnectionNotDefinedException
* @throws \Drupal\Core\Database\DriverNotSpecifiedException
*/
final protected static function openConnection($key, $target) {
if (empty(self::$databaseInfo)) {
......
......@@ -157,7 +157,7 @@ public function databaseType() {
* @param string $database
* The name of the database to create.
*
* @throws DatabaseNotFoundException
* @throws \Drupal\Core\Database\DatabaseNotFoundException
*/
public function createDatabase($database) {
// Escape the database name.
......
......@@ -200,7 +200,7 @@ public function databaseType() {
* @param string $database
* The name of the database to create.
*
* @throws DatabaseNotFoundException
* @throws \Drupal\Core\Database\DatabaseNotFoundException
*/
public function createDatabase($database) {
// Escape the database name.
......
......@@ -277,7 +277,7 @@ public function databaseType() {
* @param string $database
* The name of the database to create.
*
* @throws DatabaseNotFoundException
* @throws \Drupal\Core\Database\DatabaseNotFoundException
*/
public function createDatabase($database) {
// Verify the database is writable.
......
......@@ -39,8 +39,8 @@ interface ConditionInterface {
* @return \Drupal\Core\Database\Query\ConditionInterface
* The called object.
*
* @see Drupal\Core\Database\Query\ConditionInterface::isNull()
* @see Drupal\Core\Database\Query\ConditionInterface::isNotNull()
* @see \Drupal\Core\Database\Query\ConditionInterface::isNull()
* @see \Drupal\Core\Database\Query\ConditionInterface::isNotNull()
*/
public function condition($field, $value = NULL, $operator = NULL);
......
......@@ -55,7 +55,7 @@ class Insert extends Query {
/**
* A SelectQuery object to fetch the rows that should be inserted.
*
* @var SelectQueryInterface
* @var \Drupal\Core\Database\Query\SelectInterface
*/
protected $fromQuery;
......@@ -266,8 +266,8 @@ public function __toString() {
* @return
* TRUE if the validation was successful, FALSE if not.
*
* @throws Drupal\Core\Database\Query\FieldsOverlapException
* @throws Drupal\Core\Database\Query\NoFieldsException
* @throws \Drupal\Core\Database\Query\FieldsOverlapException
* @throws \Drupal\Core\Database\Query\NoFieldsException
*/
public function preExecute() {
// Confirm that the user did not try to specify an identical
......
......@@ -43,7 +43,7 @@ class PagerSelectExtender extends SelectExtender {
/**
* The count query that will be used for this pager.
*
* @var SelectQueryInterface
* @var \Drupal\Core\Database\Query\SelectInterface
*/
protected $customCountQuery = FALSE;
......
......@@ -21,7 +21,7 @@ abstract class Query implements PlaceholderInterface {
/**
* The connection object on which to run this query.
*
* @var Drupal\Core\Database\Connection
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
......
......@@ -72,14 +72,14 @@ class Select extends Query implements SelectInterface {
/**
* The conditional object for the WHERE clause.
*
* @var Drupal\Core\Database\Query\Condition
* @var \Drupal\Core\Database\Query\Condition
*/
protected $where;
/**
* The conditional object for the HAVING clause.
*
* @var Drupal\Core\Database\Query\Condition
* @var \Drupal\Core\Database\Query\Condition
*/
protected $having;
......
......@@ -17,14 +17,14 @@ class SelectExtender implements SelectInterface {
/**
* The Select query object we are extending/decorating.
*
* @var Drupal\Core\Database\Query\SelectInterface
* @var \Drupal\Core\Database\Query\SelectInterface
*/
protected $query;
/**
* The connection object on which to run this query.
*
* @var DatabaseConnection
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
......
......@@ -41,7 +41,7 @@ class Update extends Query implements ConditionInterface {
*
* Condition handling is handled via composition.
*
* @var Drupal\Core\Database\Query\Condition
* @var \Drupal\Core\Database\Query\Condition
*/
protected $condition;
......
......@@ -388,9 +388,9 @@ public function fieldExists($table, $column) {
* @param $new_name
* The new name for the table.
*
* @throws Drupal\Core\Database\SchemaObjectDoesNotExistException
* @throws \Drupal\Core\Database\SchemaObjectDoesNotExistException
* If the specified table doesn't exist.
* @throws Drupal\Core\Database\SchemaObjectExistsException
* @throws \Drupal\Core\Database\SchemaObjectExistsException
* If a table with the specified new name already exists.
*/
abstract public function renameTable($table, $new_name);
......@@ -446,9 +446,9 @@ public function fieldExists($table, $column) {
* or index including it in this array. See db_change_field() for more
* explanation why.
*
* @throws Drupal\Core\Database\SchemaObjectDoesNotExistException
* @throws \Drupal\Core\Database\SchemaObjectDoesNotExistException
* If the specified table doesn't exist.
* @throws Drupal\Core\Database\SchemaObjectExistsException
* @throws \Drupal\Core\Database\SchemaObjectExistsException
* If the specified table already has a field by that name.
*/
abstract public function addField($table, $field, $spec, $keys_new = array());
......@@ -477,7 +477,7 @@ public function fieldExists($table, $column) {
* @param $default
* Default value to be set. NULL for 'default NULL'.
*
* @throws Drupal\Core\Database\SchemaObjectDoesNotExistException
* @throws \Drupal\Core\Database\SchemaObjectDoesNotExistException
* If the specified table or field doesn't exist.
*/
abstract public function fieldSetDefault($table, $field, $default);
......@@ -490,7 +490,7 @@ public function fieldExists($table, $column) {
* @param $field
* The field to be altered.
*
* @throws Drupal\Core\Database\SchemaObjectDoesNotExistException
* @throws \Drupal\Core\Database\SchemaObjectDoesNotExistException
* If the specified table or field doesn't exist.
*/
abstract public function fieldSetNoDefault($table, $field);
......@@ -516,9 +516,9 @@ public function fieldExists($table, $column) {
* @param $fields
* Fields for the primary key.
*
* @throws Drupal\Core\Database\SchemaObjectDoesNotExistException
* @throws \Drupal\Core\Database\SchemaObjectDoesNotExistException
* If the specified table doesn't exist.
* @throws Drupal\Core\Database\SchemaObjectExistsException
* @throws \Drupal\Core\Database\SchemaObjectExistsException
* If the specified table already has a primary key.
*/
abstract public function addPrimaryKey($table, $fields);
......@@ -545,9 +545,9 @@ public function fieldExists($table, $column) {
* @param $fields
* An array of field names.
*
* @throws Drupal\Core\Database\SchemaObjectDoesNotExistException
* @throws \Drupal\Core\Database\SchemaObjectDoesNotExistException
* If the specified table doesn't exist.
* @throws Drupal\Core\Database\SchemaObjectExistsException
* @throws \Drupal\Core\Database\SchemaObjectExistsException
* If the specified table already has a key by that name.
*/
abstract public function addUniqueKey($table, $name, $fields);
......@@ -576,9 +576,9 @@ public function fieldExists($table, $column) {
* @param $fields
* An array of field names.
*
* @throws Drupal\Core\Database\SchemaObjectDoesNotExistException
* @throws \Drupal\Core\Database\SchemaObjectDoesNotExistException
* If the specified table doesn't exist.
* @throws Drupal\Core\Database\SchemaObjectExistsException
* @throws \Drupal\Core\Database\SchemaObjectExistsException
* If the specified table already has an index by that name.
*/
abstract public function addIndex($table, $name, $fields);
......@@ -657,9 +657,9 @@ public function fieldExists($table, $column) {
* table along with changing the field. The format is the same as a
* table specification but without the 'fields' element.
*
* @throws DatabaseSchemaObjectDoesNotExistException
* @throws \Drupal\Core\Database\SchemaObjectDoesNotExistException
* If the specified table or source field doesn't exist.
* @throws DatabaseSchemaObjectExistsException
* @throws \Drupal\Core\Database\SchemaObjectExistsException
* If the specified destination field already exists.
*/
abstract public function changeField($table, $field, $field_new, $spec, $keys_new = array());
......@@ -672,7 +672,7 @@ public function fieldExists($table, $column) {
* @param $table
* A Schema API table definition array.
*
* @throws Drupal\Core\Database\SchemaObjectExistsException
* @throws \Drupal\Core\Database\SchemaObjectExistsException
* If the specified table already exists.
*/
public function createTable($name, $table) {
......
......@@ -28,7 +28,7 @@ class Statement extends PDOStatement implements StatementInterface {
*
* The name $dbh is inherited from PDOStatement.
*
* @var DatabaseConnection
* @var \Drupal\Core\Database\Connection
*/
public $dbh;
......
......@@ -46,7 +46,7 @@ class StatementPrefetch implements Iterator, StatementInterface {
/**
* Reference to the Drupal database connection object for this statement.
*
* @var Drupal\Core\Database\Connection
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
......
......@@ -31,7 +31,7 @@ class Transaction {
/**
* The connection object for this transaction.
*
* @var Drupal\Core\Database\Connection
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment