Unverified Commit 60f9ff70 authored by Sergei Morozov's avatar Sergei Morozov Committed by GitHub

Merge pull request #4126 from morozov/fix-link-annotations

Use relative names in inline {@link} annotations where possible
parents 422f23a7 b0bfa5e2
...@@ -8,7 +8,7 @@ use Doctrine\DBAL\Platforms\DB2Platform; ...@@ -8,7 +8,7 @@ use Doctrine\DBAL\Platforms\DB2Platform;
use Doctrine\DBAL\Schema\DB2SchemaManager; use Doctrine\DBAL\Schema\DB2SchemaManager;
/** /**
* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for IBM DB2 based drivers. * Abstract base implementation of the {@link Driver} interface for IBM DB2 based drivers.
*/ */
abstract class AbstractDB2Driver implements Driver abstract class AbstractDB2Driver implements Driver
{ {
......
...@@ -18,7 +18,7 @@ use function stripos; ...@@ -18,7 +18,7 @@ use function stripos;
use function version_compare; use function version_compare;
/** /**
* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for MySQL based drivers. * Abstract base implementation of the {@link Driver} interface for MySQL based drivers.
*/ */
abstract class AbstractMySQLDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver abstract class AbstractMySQLDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver
{ {
......
...@@ -10,7 +10,7 @@ use Doctrine\DBAL\Platforms\OraclePlatform; ...@@ -10,7 +10,7 @@ use Doctrine\DBAL\Platforms\OraclePlatform;
use Doctrine\DBAL\Schema\OracleSchemaManager; use Doctrine\DBAL\Schema\OracleSchemaManager;
/** /**
* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for Oracle based drivers. * Abstract base implementation of the {@link Driver} interface for Oracle based drivers.
*/ */
abstract class AbstractOracleDriver implements Driver, ExceptionConverterDriver abstract class AbstractOracleDriver implements Driver, ExceptionConverterDriver
{ {
......
...@@ -19,7 +19,7 @@ use function strpos; ...@@ -19,7 +19,7 @@ use function strpos;
use function version_compare; use function version_compare;
/** /**
* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for PostgreSQL based drivers. * Abstract base implementation of the {@link Driver} interface for PostgreSQL based drivers.
*/ */
abstract class AbstractPostgreSQLDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver abstract class AbstractPostgreSQLDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver
{ {
......
...@@ -17,7 +17,7 @@ use function preg_match; ...@@ -17,7 +17,7 @@ use function preg_match;
use function version_compare; use function version_compare;
/** /**
* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for SAP Sybase SQL Anywhere based drivers. * Abstract base implementation of the {@link Driver} interface for SAP Sybase SQL Anywhere based drivers.
*/ */
abstract class AbstractSQLAnywhereDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver abstract class AbstractSQLAnywhereDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver
{ {
......
...@@ -16,7 +16,7 @@ use function preg_match; ...@@ -16,7 +16,7 @@ use function preg_match;
use function version_compare; use function version_compare;
/** /**
* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for Microsoft SQL Server based drivers. * Abstract base implementation of the {@link Driver} interface for Microsoft SQL Server based drivers.
*/ */
abstract class AbstractSQLServerDriver implements Driver, VersionAwarePlatformDriver abstract class AbstractSQLServerDriver implements Driver, VersionAwarePlatformDriver
{ {
......
...@@ -10,7 +10,7 @@ use Doctrine\DBAL\Schema\SqliteSchemaManager; ...@@ -10,7 +10,7 @@ use Doctrine\DBAL\Schema\SqliteSchemaManager;
use function strpos; use function strpos;
/** /**
* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for SQLite based drivers. * Abstract base implementation of the {@link Driver} interface for SQLite based drivers.
*/ */
abstract class AbstractSQLiteDriver implements Driver, ExceptionConverterDriver abstract class AbstractSQLiteDriver implements Driver, ExceptionConverterDriver
{ {
......
...@@ -11,7 +11,7 @@ interface ExceptionConverterDriver ...@@ -11,7 +11,7 @@ interface ExceptionConverterDriver
* Converts a given DBAL driver exception into a standardized DBAL driver exception. * Converts a given DBAL driver exception into a standardized DBAL driver exception.
* *
* It evaluates the vendor specific error code and SQLSTATE and transforms * It evaluates the vendor specific error code and SQLSTATE and transforms
* it into a unified {@link Doctrine\DBAL\Exception\DriverException} subclass. * it into a unified {@link DriverException} subclass.
* *
* @param string $message The DBAL exception message to use. * @param string $message The DBAL exception message to use.
* @param DriverException $exception The DBAL driver exception to convert. * @param DriverException $exception The DBAL driver exception to convert.
......
...@@ -29,7 +29,7 @@ interface ResultStatement extends Traversable ...@@ -29,7 +29,7 @@ interface ResultStatement extends Traversable
/** /**
* Sets the fetch mode to use while iterating this statement. * Sets the fetch mode to use while iterating this statement.
* *
* @param int $fetchMode The fetch mode must be one of the {@link \Doctrine\DBAL\FetchMode} constants. * @param int $fetchMode The fetch mode must be one of the {@link FetchMode} constants.
* @param mixed $arg2 * @param mixed $arg2
* @param mixed $arg3 * @param mixed $arg3
* *
...@@ -41,8 +41,8 @@ interface ResultStatement extends Traversable ...@@ -41,8 +41,8 @@ interface ResultStatement extends Traversable
* Returns the next row of a result set. * Returns the next row of a result set.
* *
* @param int|null $fetchMode Controls how the next row will be returned to the caller. * @param int|null $fetchMode Controls how the next row will be returned to the caller.
* The value must be one of the {@link \Doctrine\DBAL\FetchMode} constants, * The value must be one of the {@link FetchMode} constants,
* defaulting to {@link \Doctrine\DBAL\FetchMode::MIXED}. * defaulting to {@link FetchMode::MIXED}.
* @param int $cursorOrientation For a ResultStatement object representing a scrollable cursor, * @param int $cursorOrientation For a ResultStatement object representing a scrollable cursor,
* this value determines which row will be returned to the caller. * this value determines which row will be returned to the caller.
* This value must be one of the \PDO::FETCH_ORI_* constants, * This value must be one of the \PDO::FETCH_ORI_* constants,
...@@ -68,19 +68,19 @@ interface ResultStatement extends Traversable ...@@ -68,19 +68,19 @@ interface ResultStatement extends Traversable
* Returns an array containing all of the result set rows. * Returns an array containing all of the result set rows.
* *
* @param int|null $fetchMode Controls how the next row will be returned to the caller. * @param int|null $fetchMode Controls how the next row will be returned to the caller.
* The value must be one of the {@link \Doctrine\DBAL\FetchMode} constants, * The value must be one of the {@link FetchMode} constants,
* defaulting to {@link \Doctrine\DBAL\FetchMode::MIXED}. * defaulting to {@link FetchMode::MIXED}.
* @param int|null $fetchArgument This argument has a different meaning depending on the value of the $fetchMode parameter: * @param int|null $fetchArgument This argument has a different meaning depending on the value of the $fetchMode parameter:
* * {@link \Doctrine\DBAL\FetchMode::COLUMN}: * * {@link FetchMode::COLUMN}:
* Returns the indicated 0-indexed column. * Returns the indicated 0-indexed column.
* * {@link \Doctrine\DBAL\FetchMode::CUSTOM_OBJECT}: * * {@link FetchMode::CUSTOM_OBJECT}:
* Returns instances of the specified class, mapping the columns of each row * Returns instances of the specified class, mapping the columns of each row
* to named properties in the class. * to named properties in the class.
* * \PDO::FETCH_FUNC: Returns the results of calling the specified function, using each row's * * {@link PDO::FETCH_FUNC}: Returns the results of calling the specified function, using each row's
* columns as parameters in the call. * columns as parameters in the call.
* @param mixed[]|null $ctorArgs Controls how the next row will be returned to the caller. * @param mixed[]|null $ctorArgs Controls how the next row will be returned to the caller.
* The value must be one of the {@link \Doctrine\DBAL\FetchMode} constants, * The value must be one of the {@link FetchMode} constants,
* defaulting to {@link \Doctrine\DBAL\FetchMode::MIXED}. * defaulting to {@link FetchMode::MIXED}.
* *
* @return mixed[] * @return mixed[]
*/ */
......
...@@ -23,7 +23,7 @@ interface Statement extends ResultStatement ...@@ -23,7 +23,7 @@ interface Statement extends ResultStatement
* this will be a parameter name of the form :name. For a prepared statement * this will be a parameter name of the form :name. For a prepared statement
* using question mark placeholders, this will be the 1-indexed position of the parameter. * using question mark placeholders, this will be the 1-indexed position of the parameter.
* @param mixed $value The value to bind to the parameter. * @param mixed $value The value to bind to the parameter.
* @param int $type Explicit data type for the parameter using the {@link \Doctrine\DBAL\ParameterType} * @param int $type Explicit data type for the parameter using the {@link ParameterType}
* constants. * constants.
* *
* @return bool TRUE on success or FALSE on failure. * @return bool TRUE on success or FALSE on failure.
...@@ -48,7 +48,7 @@ interface Statement extends ResultStatement ...@@ -48,7 +48,7 @@ interface Statement extends ResultStatement
* this will be a parameter name of the form :name. For a prepared statement using * this will be a parameter name of the form :name. For a prepared statement using
* question mark placeholders, this will be the 1-indexed position of the parameter. * question mark placeholders, this will be the 1-indexed position of the parameter.
* @param mixed $variable Name of the PHP variable to bind to the SQL statement parameter. * @param mixed $variable Name of the PHP variable to bind to the SQL statement parameter.
* @param int $type Explicit data type for the parameter using the {@link \Doctrine\DBAL\ParameterType} * @param int $type Explicit data type for the parameter using the {@link ParameterType}
* constants. To return an INOUT parameter from a stored procedure, use the bitwise * constants. To return an INOUT parameter from a stored procedure, use the bitwise
* OR operator to set the PDO::PARAM_INPUT_OUTPUT bits for the data_type parameter. * OR operator to set the PDO::PARAM_INPUT_OUTPUT bits for the data_type parameter.
* @param int|null $length You must specify maxlength when using an OUT bind * @param int|null $length You must specify maxlength when using an OUT bind
......
...@@ -3232,8 +3232,7 @@ abstract class AbstractPlatform ...@@ -3232,8 +3232,7 @@ abstract class AbstractPlatform
* Whether this platform can emulate schemas. * Whether this platform can emulate schemas.
* *
* Platforms that either support or emulate schemas don't automatically * Platforms that either support or emulate schemas don't automatically
* filter a schema for the namespaced elements in {@link * filter a schema for the namespaced elements in {@link AbstractManager::createSchema()}.
* AbstractManager#createSchema}.
* *
* @return bool * @return bool
*/ */
......
...@@ -642,9 +642,8 @@ SQL ...@@ -642,9 +642,8 @@ SQL
* Checks whether a given column diff is a logically unchanged binary type column. * Checks whether a given column diff is a logically unchanged binary type column.
* *
* Used to determine whether a column alteration for a binary type column can be skipped. * Used to determine whether a column alteration for a binary type column can be skipped.
* Doctrine's {@link \Doctrine\DBAL\Types\BinaryType} and {@link \Doctrine\DBAL\Types\BlobType} * Doctrine's {@link BinaryType} and {@link BlobType} are mapped to the same database column type on this platform
* are mapped to the same database column type on this platform as this platform * as this platform does not have a native VARBINARY/BINARY column type. Therefore the comparator
* does not have a native VARBINARY/BINARY column type. Therefore the {@link \Doctrine\DBAL\Schema\Comparator}
* might detect differences for binary type columns which do not have to be propagated * might detect differences for binary type columns which do not have to be propagated
* to database as there actually is no difference at database level. * to database as there actually is no difference at database level.
* *
......
...@@ -265,7 +265,7 @@ class QueryBuilder ...@@ -265,7 +265,7 @@ class QueryBuilder
* *
* @param string|int $key The parameter position or name. * @param string|int $key The parameter position or name.
* @param mixed $value The parameter value. * @param mixed $value The parameter value.
* @param string|int|null $type One of the {@link \Doctrine\DBAL\ParameterType} constants. * @param string|int|null $type One of the {@link ParameterType} constants.
* *
* @return $this This QueryBuilder instance. * @return $this This QueryBuilder instance.
*/ */
......
...@@ -186,7 +186,7 @@ class SQLParserUtils ...@@ -186,7 +186,7 @@ class SQLParserUtils
array_slice($types, 0, $needle), array_slice($types, 0, $needle),
$count ? $count ?
// array needles are at {@link \Doctrine\DBAL\ParameterType} constants // array needles are at {@link \Doctrine\DBAL\ParameterType} constants
// + {@link Doctrine\DBAL\Connection::ARRAY_PARAM_OFFSET} // + {@link \Doctrine\DBAL\Connection::ARRAY_PARAM_OFFSET}
array_fill(0, $count, $types[$needle] - Connection::ARRAY_PARAM_OFFSET) : array_fill(0, $count, $types[$needle] - Connection::ARRAY_PARAM_OFFSET) :
[], [],
array_slice($types, $needle + 1) array_slice($types, $needle + 1)
......
...@@ -62,7 +62,7 @@ interface ShardManager ...@@ -62,7 +62,7 @@ interface ShardManager
* Queries all shards in undefined order and return the results appended to * Queries all shards in undefined order and return the results appended to
* each other. Restore the previous distribution value after execution. * each other. Restore the previous distribution value after execution.
* *
* Using {@link \Doctrine\DBAL\Connection::fetchAll} to retrieve rows internally. * Using {@link Connection::fetchAll()} to retrieve rows internally.
* *
* @param string $sql * @param string $sql
* @param mixed[] $params * @param mixed[] $params
......
...@@ -277,7 +277,7 @@ abstract class Type ...@@ -277,7 +277,7 @@ abstract class Type
* Gets the (preferred) binding type for values of this type that * Gets the (preferred) binding type for values of this type that
* can be used when binding parameters to prepared statements. * can be used when binding parameters to prepared statements.
* *
* This method should return one of the {@link \Doctrine\DBAL\ParameterType} constants. * This method should return one of the {@link ParameterType} constants.
* *
* @return int * @return int
*/ */
......
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